Controller

概要

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

メソッド

go()

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

i	スライドiに移動する
'+${i}'	スライドインデックスをi増加させる
'-${i}'	スライドインデックスをi減少させる
'>'	次のページに移動する
'<'	前のページに移動する
'>${i}'	ページiに移動する

引数

control	上記コントロールパターンのいずれか
allowSameIndex	省略可。現在のインデックスと同一のインデックスを受け付けるかどうか
callback	省略可。移動が終わった直後に呼ばれるコールバック関数

---

scroll()

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

引数

destination	目的地となるポジションまたはインデックス。インデックスを使用する際は、useIndexをtrueにする必要がある
duration	省略可。スクロールにかける時間を設定する
snap	省略可。目的地を、最も近いスライドにスナップするかどうかを決定する
callback	省略可。スクロールが終わった直後に呼ばれるコールバック関数

---

getNext()

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

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

引数

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

返値

---

getPrev()

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

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

引数

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

返値

---

getEnd()

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

返値

---

setIndex()

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

返値

---

getIndex()

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

引数

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

---

toIndex()

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

引数

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

返値

---

toPage()

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

引数

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

返値

---

isBusy()

スライダーが現在移動可能かどうかを確認します。

返値