negl 機能一覧 / Exports / TransitionState
Interface: TransitionState
ページトランジション関連のフックに登録したコールバック関数に渡るオブジェクトのインターフェイスです。 現在ページ、次のページ、ページトランジションの種類、ページトランジションの契機等の情報を保持します。
対象のフック
T_NEXT_DOM_BEFORE
T_BOTH_DOM_EXIST
T_BOTH_OB_EXIST
T_END
T_ERROR
Table of contents
Properties
Properties
current
• current: Object
現在のページの状態を保持します。
Type declaration
| Name | Type | Description |
|---|---|---|
el | null | HTMLElement | 現在のページのconfig.$.pageContainerで取得した DOM 要素を保持します。 |
os | null | Ob[] | 現在のページの Obオブジェクトの配列を保持します。 |
page | null | Page | 現在のページのdata-pageに紐づくPageモジュールを保持します。 |
pageType | null | string | 現在のページのdata-page属性の値を保持します。 |
store | Map<string, any> | URL に紐づくデータ保存用マップ。URL に対応する Map オブジェクトが取得されます。 トランジション内で使用する値の保持・取得を行いたい場合に使用してください。 値を保持する場合： current.store.set(key, value)値を取得する場合： current.store.get(key) |
url | string | 現在のページの URL のパスを保持します。 |
event
• event: object | Event
画面クリックに対応する Event オブジェクトが渡ります。
next
• next: Object
次のページの状態を保持します。 negl はページ遷移を検知すると次のページの HTML をフェッチで取得します。 その為、取得完了までは次のページの情報にはアクセス出来ないため、大部分の情報は T_NEXT_DOM_BEFORE フック以降のタイミングでアクセス可能となります。
Type declaration
| Name | Type | Description |
|---|---|---|
doc | null | Document | 次のページのDocumentオブジェクトを保持します。使用可能タイミング：T_NEXT_DOM_BEFORE 以降のフック |
el | null | HTMLElement | 次のページのconfig.$.pageContainerで取得した DOM 要素を保持します。使用可能タイミング：T_NEXT_DOM_BEFORE 以降のフック |
head | null | HTMLHeadElement | 次のページの<head>の DOM 要素を保持します。使用可能タイミング：T_NEXT_DOM_BEFORE 以降のフック |
os | Ob[] | 次のページのObオブジェクトの配列を保持します。 使用可能タイミング：T_BOTH_OB_EXIST 以降のフック |
page | null | Page | 次のページのdata-pageから取得したPageモジュールを保持します。使用可能タイミング：T_NEXT_DOM_BEFORE 以降のフック |
pageType | null | string | 次のページのdata-page属性の値を保持します。使用可能タイミング：T_NEXT_DOM_BEFORE 以降のフック |
store | Map<string, any> | URL に紐づくデータ保存用マップ。URL に対応する Map オブジェクトが取得されます。 トランジション内で使用する値の保持・取得を行いたい場合に使用してください。 値を保持する場合： next.store.set(key, value)値を取得する場合： next.store.get(key)使用可能タイミング：T_BEGIN 以降のフック |
url | string | 次のページの URL のパスを保持します。 使用可能タイミング：T_BEGIN 以降のフック |
transitionType
• transitionType: string
data-transition、または config.transition.defaultType に設定された値が渡ります。
triggerMesh
• triggerMesh: Object3D<Event>
メッシュ遷移での画面遷移の際には画面遷移の契機となったメッシュが渡ります。
triggerType
• triggerType: string
画面遷移を発生させたトリガータイプが文字列で渡ります。
link リンクのクリック
mesh メッシュクリック
popstate ブラウザバック、ブラウザフォワード