Foundation-off-canvas-javascript-reference
Foundation-キャンバス外のJavaScriptリファレンス
Foundationは、以下に示すように、オフキャンバス用のJavaScriptコンポーネントを提供します。
初期化中
_foundation.offcanvas.js_および_foundation.core.js_プラグインを使用して、JavaScriptでペインを初期化できます。 _foundation.core.js_プラグインには、次のライブラリが必要です-
- foundation.util.triggers.js
- foundation.util.motion.js
Foundation.OffCanvas
以下に定義されているように、それはオフキャンバスラッパーのインスタンスを指定します-
var my_element = new Foundation.OffCanvas(element);
オフキャンバスには、表にリストされている次のイベントが含まれます-
Sr.No. | Name & Description | Type |
---|---|---|
1 |
element jQueryオブジェクトを初期化します。 |
Object |
2 |
options デフォルトのプラグイン設定を上書きします。 |
Object |
プラグインオプション
次のプラグインオプションを使用して、キャンバス外のインスタンスをカスタマイズできます。
Sr.No. | Name & Description | Example |
---|---|---|
1 |
closeOnClick ユーザーがメニューの外側をクリックすると、メニューが閉じます。 |
true |
2 |
transitionTime トランジションの開閉にかかる時間をミリ秒単位で指定します。 |
500 |
3 |
position オフキャンバスが開くべき方向を定義します。 |
left |
4 |
forceTop ページが開かれるとすぐにページを上部にスクロールさせます。 |
|
5 |
isRevealed 残りのブレークポイントに到達するまで、キャンバス外を開きます。 |
false |
6 |
revealOn オフキャンバスを表示するブレークポイントを定義します。 |
reveal-for-large |
7 |
autoFocus 開いたときにキャンバス外に焦点を合わせます。 |
true |
8 |
revealClass このクラスは、オフキャンバスを強制的に開いたままにするために使用されます。 |
reveal-for-large |
イベント
オフキャンバスは、表に記載されている次のイベントを提供します-
Sr.No. | Name & Description |
---|---|
1 |
opened.zf.off-canvas キャンバス外メニューを開くと、イベントがトリガーされます。 |
2 |
closed.zf.off-canvas キャンバス外メニューを開くと、イベントがトリガーされます。 |
関数
オフキャンバスは、以下に定義されているように、次の機能を提供します-
。明らかに
残りのブレークポイントに到達するまで、キャンバス外を開きます。 表に指定されている次の機能があります-
Sr.No. | Name & Description | Type |
---|---|---|
1 |
isRevealed この関数がtrueに設定されている場合、要素が表示されます。 |
Boolean |
。開いた
キャンバス外メニューが開きます。 表に指定されている次の機能があります-
Sr.No. | Name & Description | Type |
---|---|---|
1 |
event リスナーからイベントオブジェクトを渡します。 |
Object |
2 |
trigger 要素をトリガーして、キャンバス外を開きます。 |
jQuery |
。閉じる
キャンバス外メニューを閉じます。
。トグル
キャンバス外メニューを切り替えます。 表に指定されている次の機能があります-
Sr.No. | Name & Description | Type |
---|---|---|
1 |
event リスナーからイベントオブジェクトを渡します。 |
Object |
2 |
trigger 要素をトリガーして、キャンバス外を開きます。 |
jQuery |
。破壊する
キャンバス外のプラグインを破壊します。