Controller
概要
Controllerコンポーネントはコントロールパターンをインデックスに変換し、Moveコンポーネントに伝えます。また、インデックス関係の様々なメソッドを提供します。
メソッド
go()
go( control: number | string, allowSameIndex?: boolean, callback?: AnyFunction ): void
以下のコントロールパターンにより、スライダーを動かします。Splide#go()
はこのメソッドのエイリアスです。
i |
---|
'+${i}' |
'-${i}' |
'>' |
'<' |
'>${i}' |
引数
control |
---|
allowSameIndex |
callback |
scroll()
scroll( destination: number, useIndex?: boolean, snap?: boolean, duration?: number, callback?: AnyFunction ): void
スライダーを特定の位置やインデックスにスクロールさせます。このとき、現在のインデックスと一つ前のインデックスを更新します。この関数は、CSSのトランジションではなく、Scrollコンポーネントを利用してスライダーを動かします。
引数
destination |
---|
useIndex |
snap |
duration |
callback |
getNext()
getNext( destination?: boolean ): number
次の行き先となるスライドのインデックスを返します。このメソッドはデフォルトで、クローンのインデックスを実際のスライドのインデックスに変換します。たとえば、目的となるインデックスが-1
(クローン)の場合であってもlength - 1
として計算した実際のスライドのインデックスを返します。destination
引数をtrue
に設定すると、この変換を行わず、そのままの値を返すようになります。
ただし、行き先がなかった場合、このメソッドは常に-1
を返します。
引数
destination |
---|
getPrev()
getPrev( destination?: boolean ): number
戻り先となるスライドのインデックスを返します。このメソッドはデフォルトで、クローンのインデックスを実際のスライドのインデックスに変換します。たとえば、目的となるインデックスが-1
(クローン)の場合であってもlength - 1
として計算した実際のスライドのインデックスを返します。destination
引数をtrue
に設定すると、この変換を行わず、そのままの値を返すようになります。
ただし、戻り先がなかった場合、このメソッドは常に-1
を返します。
引数
destination |
---|
getEnd()
getEnd(): number
終わりのインデックスを返します。これは、「スライドの枚数 - 1」とは必ずしも一致しません。たとえば、全体数が10でperPage
が3
の場合、スライダーはインデックス7までしか到達できませんので、この関数は7
を返します。
setIndex()
setIndex( index: number ): void
現在のインデックスを更新します。このメソッドは、単に内部的な変数を更新するのみで、スライダーは移動しません。
getIndex()
getPrev( prev?: boolean ): number
現在のインデックスを返します。Splide#index
はこの関数のエイリアスです。なお、prev
をtrue
にすると、一つ前の古いインデックスを返します。
引数
prev |
---|
toIndex()
toIndex( page: number ): number
与えられたページインデックスをスライドインデックスに変換します。perPage
が1より大きい場合にのみ意味のある関数です。
引数
page |
---|
toPage()
toPage( index: number ): number
与えられたスライドインデックスをページインデックスに変換します。perPage
が1より大きい場合にのみ意味のある関数です。
引数
page |
---|