| Anchor | ||||
|---|---|---|---|---|
|
| Table of Contents | ||
|---|---|---|
|
...
| パラメーター | 型 | 説明 | 追加情報 | |
| selector | String | リスナーを作成するオブジェクトのCSS セレクターです。すべてのローダーをインターセプトする場合は、セレクター「html *」を使用します。 | セレクターが定義されていない場合はエラーが発生し、イベントリスナーは作成されません。イベントリスナーが作成されないエラーを回避するためには、selectorかelementのどちらかが定義されている必要があります。この2つのうち、selcorを定義するのが望ましいです。 | |
| element | HTML Element | ローダーが追加されたことを確認するためのHTML elementです。これはloaderに追加されたelementが、ここで定義されたelementと同じである場合のみ、イベントをトリガーします。 | オプションで、selectorを定義する代わりになります。 | |
| onAdd | 関数 | Yellowfinが、セレクターに一致する要素にローダーを追加する直前に呼び出される関数です。LoaderEventは、このコールバック関数に渡されます。 | onAdd、またはonRemoveのいずれかを定義する必要があります。必要に応じて、両方を定義することも可能です。どちらも定義されていない場合はエラーが発生し、イベントリスナーは作成されません。 | |
| onRemove | 関数 | Yellowfin コードが、セレクターに一致する要素からローダーを削除する直前のコールバック関数です。LoaderEventは、このコールバック関数に渡されます。 | onAdd、またはonRemoveのいずれかを定義する必要があります。必要に応じて、両方を定義することも可能です。どちらも定義されていない場合はエラーが発生し、イベントリスナーは作成されません。 |
...
ローダーイベントを削除します。渡されるlistenObjectは、listen関数に渡されたオブジェクトとまったく同じでなくてはならず、これが異なる場合、リスナーは削除されません。
interceptChildLoadersForElement(element, listenObject)
この関数が呼び出されると、Yellowfinは子ローダーをもつすべてのElementを遮り、それらのローダーを子ではなく渡されたElementに適用します。
interceptChildLoadersForElementのlistenObjectパラメータは、loaderEvents.listenのlistenObjectパラメータと同様に動作します。onAdd関数は、渡された要素に初めてローダーが追加されたときに呼び出され、onRemove関数は、渡された要素からローダーが削除されたときに呼び出されます。
以下のサンプルコードでは、ページ内の任意の場所に追加されたローダーを探し、代わりにbodyタグに追加しています。
| Code Block | ||
|---|---|---|
| ||
yellowfin.loaderEvents.interceptChildLoadersForElement(document.querySelector('body'), {
onAdd: function(e) { console.log('loader added to body') },
onRemove: function(e) { console.log('loader removed from body') }
}); |
stoplisteningToElementIntercept (listenObject)
interceptChildLoadersForElement()リスナーは、stopLingentToElementIntercept()関数を使って削除することができます。リスナーを止めたいelementのみを渡します。
| Code Block | ||
|---|---|---|
| ||
LoaderEvents.stopListeningToElementIntercept(document.querySelector('body')) |
LoaderEvent
onAdd、またはonRemove関数が呼び出される度に、LoaderEvent オブジェクトが作成されます。これには、ローダーが追加される要素と、イベントの処理方法を操作できるいくつかの関数が含まれます。オブジェクトが作成されます。これには、ローダーが追加される要素と、イベントの処理方法を操作できるいくつかの関数が含まれます。同じElementでinterceptChildLoadersForElementが複数回呼び出された場合、最初のアプリケーションのみが使われます。
LoaderEvent.element
これはローダーが追加、または削除される要素です。
...