Turbo ドライブ

Turbo.visit

Turbo.visit(location)
Turbo.visit(location, { action: action })
Turbo.visit(location, { frame: frame })

指定された location(URLまたはパスを含む文字列)に対して、指定された action"advance" または "replace" のいずれかの文字列)でアプリケーション・アクセスを行います。

location がクロスオリジンなURL、または指定されたルートの範囲外にある場合(ルートロケーションの設定を参照)、Turbo は、window.location を利用し画面全体の再読み込みを行います。

action が指定されていない場合、Turbo ドライブは、"advance"が指定されたとみなします。

画面遷移が実行される前に、Turboドライブは document に対して turbo:before-visit イベントを発火します。アプリケーション側では、このイベントを検知し、event.preventDefault() を利用して画面遷移をキャンセルできます。(アクセスを開始前にキャンセルするを参照)。」

frame が指定されている場合、指定された値と一致する [id] 属性を持つ <turbo-frame> 要素を、指定された location へナビゲートします。<turbo-frame> 要素が見つからない場合は、画面全体でのアプリケーション・アクセスを行います。

原文

Drive

Turbo.visit

Performs an Application Visit to the given location (a string containing a URL or path) with the specified action (a string, either "advance" or "replace").

If location is a cross-origin URL, or falls outside of the specified root (see Setting a Root Location), Turbo performs a full page load by setting window.location.

If action is unspecified, Turbo Drive assumes a value of "advance".

Before performing the visit, Turbo Drive fires a turbo:before-visit event on document. Your application can listen for this event and cancel the visit with event.preventDefault() (see Canceling Visits Before They Start).

If frame is specified, find a <turbo-frame> element with an [id] attribute that matches the provided value, and navigate it to the provided location. If the <turbo-frame> cannot be found, perform a page-level Application Visit.

Turbo.cache.clear

Turbo.cache.clear()

Turbo ドライブによってキャッシュされたページ情報を全て削除します。サーバー上の状態が変更され、キャッシュされたページに影響を与える可能性がある場合は、この Turbo.cache.clear() を呼んでください。

注記: この機能は以前 Turbo.clearCache() として公開されていましたが、トップレベルで非推奨となり、代わりに新しい Turbo.cache.clear() の利用が推奨されています。

原文

Turbo.cache.clear

Removes all entries from the Turbo Drive page cache. Call this when state has changed on the server that may affect cached pages.

Note: This function was previously exposed as Turbo.clearCache(). The top-level function was deprecated in favor of the new Turbo.cache.clear() function.

Turbo.setProgressBarDelay

Turbo.setProgressBarDelay(delayInMilliseconds)

ナビゲーション中にプログレスバーが表示されるまでの遅延をミリ秒単位で設定できます。デフォルトでは、プログレスバーは500ミリ秒後に表示されます。

iOS または Android アダプターと併用した場合、このメソッドは動作しないので注意しましょう。

原文

Turbo.setProgressBarDelay

Sets the delay after which the progress bar will appear during navigation, in milliseconds. The progress bar appears after 500ms by default.

Note that this method has no effect when used with the iOS or Android adapters.

Turbo.setConfirmMethod

Turbo.setConfirmMethod(confirmMethod)

data-turbo-confirm を指定したリンクによって呼び出されるメソッドを設定できます。デフォルトは、ブラウザの組み込みの confirm が設定されています。ここで設定したメソッドは、画面遷移可能な場合には true を返す必要があります。

原文

Turbo.setConfirmMethod

Sets the method that is called by links decorated with data-turbo-confirm. The default is the browser’s built in confirm. The method should return true if the visit can proceed.

Turbo.session.drive

Turbo.session.drive = false

デフォルトで Turbo ドライブをオフに設定できます。また、Turbo ドライブを部分的に利用したい場合は、data-turbo="true" を設定することで、リンクやフォームごとに Turbo ドライブをオプトインできます。

原文

Turbo.session.drive

Turns Turbo Drive off by default. You must now opt-in to Turbo Drive on a per-link and per-form basis using data-turbo="true".