Controller

v3用のドキュメントを参照しています

概要

Controllerコンポーネントはコントロールパターンをインデックスに変換し、Moveコンポーネントに伝えます。また、インデックス関係の様々なメソッドを提供します。

メソッド

go()

go( control: number | string, allowSameIndex?: boolean, callback?: AnyFunction ): void

以下のコントロールパターンにより、スライダーを動かします。Splide#go()はこのメソッドのエイリアスです。

i

スライドiに移動する

'+${i}'

スライドインデックスをi増加させる

'-${i}'

スライドインデックスをi減少させる

'>'

次のページに移動する

'<'

前のページに移動する

'>${i}'

ページiに移動する

引数

control

上記コントロールパターンのいずれか

allowSameIndex

省略可。現在のインデックスと同一のインデックスを受け付けるかどうか

callback

省略可。移動が終わった直後に呼ばれるコールバック関数


scroll()

scroll( destination: number, useIndex?: boolean, snap?: boolean, duration?: number, callback?: AnyFunction ): void

スライダーを特定の位置やインデックスにスクロールさせます。このとき、現在のインデックスと一つ前のインデックスを更新します。この関数は、CSSのトランジションではなく、Scrollコンポーネントを利用してスライダーを動かします。

引数

destination

目的地となるポジションまたはインデックス。インデックスを使用する際は、useIndextrueにする必要がある

useIndex

省略可。destinationにインデックスを使うかどうかを指定する

snap

省略可。目的地を、最も近いスライドにスナップするかどうかを決定する

duration

省略可。スクロールにかける時間を設定する

callback

省略可。スクロールが終わった直後に呼ばれるコールバック関数


getNext()

getNext( destination?: boolean ): number

次の行き先となるスライドのインデックスを返します。このメソッドはデフォルトで、クローンのインデックスを実際のスライドのインデックスに変換します。たとえば、目的となるインデックスが-1(クローン)の場合であってもlength - 1として計算した実際のスライドのインデックスを返します。destination引数をtrueに設定すると、この変換をせずそのままの値を返すようになります。

ただし、行き先がなかった場合、このメソッドは常に-1を返します。

引数

destination

省略可。目的地のインデックスをそのまま返すかどうかを決定する

返値

次のスライドのインデックス。これ以上行き先がなかった場合は-1


getPrev()

getPrev( destination?: boolean ): number

戻り先となるスライドのインデックスを返します。このメソッドはデフォルトで、クローンのインデックスを実際のスライドのインデックスに変換します。たとえば、目的となるインデックスが-1(クローン)の場合であってもlength - 1として計算した実際のスライドのインデックスを返します。destination引数をtrueに設定すると、この変換をせずそのままの値を返すようになります。

ただし、戻り先がなかった場合、このメソッドは常に-1を返します。

引数

destination

省略可。目的地のインデックスをそのまま返すかどうかを決定する

返値

戻り先のスライドのインデックス。これ以上戻る場所がなかった場合は-1


getEnd()

getEnd(): number

終わりのインデックスを返します。これは、「スライドの枚数 - 1」とは必ずしも一致しません。たとえば、全体数が10でperPage3の場合、スライダーはインデックス7までしか到達できませんので、この関数は7を返します。

返値

終わりのインデックス


setIndex()

setIndex( index: number ): void

現在のインデックスを更新します。このメソッドは、単に内部的な変数を更新するのみで、スライダーは移動しません。

返値

新しくセットするインデックス


getIndex()

getPrev( prev?: boolean ): number

現在のインデックスを返します。Splide#indexはこの関数のエイリアスです。なお、prevtrueにすると、一つ前の古いインデックスを返します。

引数

prev

省略可。一つ前の古いインデックスを取得するかどうかを決定


toIndex()

toIndex( page: number ): number

与えられたページインデックスをスライドインデックスに変換します。perPageが1より大きい場合にのみ意味のある関数です。

引数

page

変換するページインデックス

返値

与えられたページに対応するスライドインデックス


toPage()

toPage( index: number ): number

与えられたスライドインデックスをページインデックスに変換します。perPageが1より大きい場合にのみ意味のある関数です。

引数

page

変換するスライドインデックス

返値

与えられたスライドに対応するページインデックス