View Source Improve this doc

ons-switch

スイッチを表示するコンポーネントです。

使い方 # 

<ons-switch checked></ons-switch>

関連情報 #

属性 #

名前 型 / デフォルト値 概要
var String JavaScriptから参照するための変数名を指定します。 Optional
modifier String スイッチの表現を指定します。 Optional
disabled スイッチを無効の状態にする場合に指定します。 Optional
checked スイッチがONの状態にするときに指定します。 Optional

メソッド概要 #

シグネチャ 概要
isChecked() スイッチがONの場合にtrueを返します。
setChecked(checked) スイッチの値を指定します。isCheckedにはtrueもしくはfalseを指定します。
getCheckboxElement() スイッチが内包する、input[type=checkbox]の要素を取得します。
on(eventName, listener) イベントリスナーを追加します。
once(eventName, listener) 一度だけ呼び出されるイベントリスナーを追加します。
off(eventName, [listener]) イベントリスナーを削除します。もしイベントリスナーを指定しなかった場合には、そのイベントに紐づく全てのイベントリスナーが削除されます。

イベント概要 #

名前 概要
change ON/OFFが変わった時に発火します。

メソッド

isChecked(): Boolean #

スイッチがONの場合にtrueを返します。

返り値: ONになっている場合にはtrueになります。

setChecked(checked) #

スイッチの値を指定します。isCheckedにはtrueもしくはfalseを指定します。

パラメーター
名前 型 概要
checked Boolean ONにしたい場合にはtrueを指定します。

getCheckboxElement(): HTMLElement #

スイッチが内包する、input[type=checkbox]の要素を取得します。

返り値: コンポーネント内部のcheckbox要素になります。

on(eventName, listener) #

イベントリスナーを追加します。

パラメーター
名前 型 概要
eventName String イベント名を指定します。
listener Function このイベントが発火された際に呼び出される関数オブジェクトを指定します。

once(eventName, listener) #

一度だけ呼び出されるイベントリスナーを追加します。

パラメーター
名前 型 概要
eventName String イベント名を指定します。
listener Function イベントが発火した際に呼び出される関数オブジェクトを指定します。

off(eventName, [listener]) #

イベントリスナーを削除します。もしイベントリスナーを指定しなかった場合には、そのイベントに紐づく全てのイベントリスナーが削除されます。

パラメーター
名前 型 概要
eventName String イベント名を指定します。
listener Function 削除するイベントリスナーを指定します。

イベント

change #

ON/OFFが変わった時に発火します。

パラメーター
名前 型 概要
event Object イベントオブジェクト。
event.switch Object イベントが発火したSwitchオブジェクトを返します。
event.value Boolean 現在の値を返します。
event.isInteractive Boolean タップやクリックなどのユーザの操作によって変わった場合にはtrueを返します。

議論 #