メインコンテンツまでスキップ
バージョン: 1.24.0

Switch

Overview

Switch は2つの状態の間を切り替えることができます。


Specification

Property

使用できるプロパティの一覧です。プロパティを指定して値を更新することができます。

NameTypeDefaultDescriptionRemark
checkedTextstring""コンポーネントが「チェック」された状態のときに表示されるテキスト
classNamestring""コンポーネントの class 名
idstring""コンポーネントの id 名
labelstring""コンポーネントの説明ラベル未指定、あるいは空文字の場合、label は表示されない
labelPlacementstring"left"ラベルの表示位置指定できるオプション: top, left, right, bottom
unCheckedTextstring""コンポーネントが「チェック」されていない状態のときに表示されるテキスト
checkedbooleanfalseコンポーネントのチェックあり/チェックなし
disabledbooleanfalseコンポーネントの編集可/不可設定
visiblebooleantrueコンポーネントの表示/非表示設定

Event

指定できるイベントの一覧です。

NameTypeDescriptionRemark
changefunctionチェック状態が変更された時のイベントハンドラ引数には Event の event オブジェクトをとる

event.detail で以下の値を受け取ることができる
event.detail.checked : 変更後の checked の値

Constructor

Switch(options)
使用できるコンストラクタの一覧です。

Parameter

NameTypeDefaultDescriptionRemark
optionsobject{}コンポーネントのプロパティを含むオブジェクト

Sample Code

ヒント

導入と実装方法 をご確認ください。

全てのパラメータを指定した場合のサンプルコードです。

const Kuc = Kucs['1.x.x'];

const space = kintone.app.record.getSpaceElement('space');

const kucSwitch = new Kuc.Switch({
label: 'Switch',
labelPlacement: 'left',
checkedText: 'ON',
unCheckedText: 'OFF',
checked: false,
className: 'options-class',
id: 'options-id',
visible: true,
disabled: false
});
space.appendChild(kucSwitch);

kucSwitch.addEventListener('change', event => {
console.log(event);
});