TimePicker
Overview
TimePicker は入力エリアと時間選択用のリストを表示します。
Specification
Property
使用できるプロパティの一覧です。プロパティを指定して値を更新することができます。
Name | Type | Default | Description | Remark |
---|---|---|---|---|
className | string | "" | コンポーネントの class 名 | |
error | string | "" | エラーに表示するテキスト | 未指定、あるいは空文字の場合、error は表示されない |
id | string | "" | コンポーネントの id 名 | |
label | string | "" | コンポーネントの説明ラベル | 未指定、あるいは空文字の場合、label は表示されない |
language | string | "auto" | 言語設定 | 指定できるオプション: "auto", "en", "ja", "zh" "auto" を指定した場合、HTML の lang 設定に従う(lang 設定が "en"/"zh"/"ja" 以外の場合は、言語設定が "en" になる) |
max | string | "" | 時刻リストの終了時間設定 | フォ ーマットは HH:MM 時刻リストは、max に指定した時刻まで表示されて、それ以降は表示されない 以下の時間も指定できる(内部的に HH:MM に変換される): 不正なフォーマットや値や min 時刻が max 時刻よりも大きい値の場合、エラーを出力する |
min | string | "" | 時刻リストの開始時間設定 | フォーマットは HH:MM 時刻リストは、min に指定した時刻から表示されて、それ以前は表示されない 以下の時間も指定できる(内部的に HH:MM に変換される): 不正なフォーマットや値や min 時刻が max 時刻よりも大きい値の場合、エラーを出力する |
value | string | "" | 表示するテキスト | フォーマットは HH:MM 以下の時間も指定できる(内部的に HH:MM に変換される): 不正なフォーマットや値や min/max プロパティで指定した有効な時刻の範囲を超える値を指定した場合、エラーを出力する |
disabled | boolean | false | コンポーネントの選択可/不可設定 | |
hour12 | boolean | false | 時刻表記の設定 (12時間表記/24時間表記) デフォルトは 24時間表記 | 指定できるオプション: true: 12時間表記 false: 24時間表記 |
requiredIcon | boolean | false | コンポーネントの必須アイコン表示/非表示設定 | |
visible | boolean | true | コンポーネントの表示/非表示設定 | |
timeStep | number | 30 | 時刻リスト内の時刻間隔の設定 | 単位は分(正の整数) 小数点以下を指定した場合は、最も近い整数に丸められる 数値以外の値や max と min プロパティの時刻差異よりも大きな値を指定した場合、エラーを出力する |
Event
指定できるイベントの一覧です。
Name | Type | Description | Remark |
---|---|---|---|
change | function | 値が変更された時のイベントハンドラ | 引数には Event の event オブジェクトをとる event.detail で以下の値を受け取ることができる event.detail.oldValue : 変更前の value の値 event.detail.value : 変更後の value の値 |
Constructor
TimePicker(options)
使用できるコンストラクタの一覧です。
Parameter
Name | Type | Default | Description | Remark |
---|---|---|---|---|
options | object | {} | コンポーネントのプロパティを含むオブジェクト |
Sample Code
ヒント
導入と実装方法 をご確認ください。
全てのパラメータを指定した場合のサンプルコードです。
const Kuc = Kucs['1.x.x'];
const space = kintone.app.record.getSpaceElement('space');
const timePicker = new Kuc.TimePicker({
label: 'Time',
requiredIcon: true,
hour12: false,
value: '11:30',
error: 'Error occurred!',
className: 'options-class',
id: 'options-id',
visible: true,
disabled: false,
language: 'en',
timeStep: 30,
max: '23:59',
min: '00:00'
});
space.appendChild(timePicker);
timePicker.addEventListener('change', event => {
console.log(event);
});