Skip to main content

useCsCheckBoxItem

useCsCheckBoxItem は、チェックボックスに対応する Item を初期化するためのフックです。

シグネチャ​

useCsCheckBoxItem(label, state, checkBoxText, readonly?): CsCheckBoxItem

引数​

引数名必須型説明
label〇string入力項目のラベルを指定します。
state〇StateResult<boolean>*¹入力項目の状態変数を指定します。useInit を使用して初期化した状態変数を指定します。
checkBoxText〇stringチェックボックスのテキストを指定します。
readonlyRW.Editable | RW.Readonly入力項目が読み取り専用かどうかを指定します。RW.Editable は読み取り・書き込み可能、RW.Readonlyは読み取り専用を表す値です。デフォルトは RW.Editable です。 　

*1：StateResultは useState の戻り値を管理する型定義です。詳しくはuseInitを参照してください。

返り値​

引数で定義した初期値やチェックボックスのテキストなど、チェックボックス入力項目に関する情報が集約された CsCheckBoxItem クラスのインスタンスを返します。

使用例​

useCsView({
  newsOk: useCsCheckBoxItem("お知らせを受け取る", useInit(), "受け取る"),
});