Skip to main content

useCsSelectBoxItem

useCsSelectBoxItem は、セレクトボックスに対応する Item を初期化するためのフックです。

シグネチャ​

useCsSelectBoxItem(label, state, rule, selOpt?, readonly?, placeholder?): CsSelectBoxItem

引数​

引数名必須型説明
label〇string入力項目のラベルを指定します。
state〇StateResult<string>*¹入力項目の状態変数を指定します。useInit を使用して初期化した状態変数を指定します。
rule〇StringValidationRule*²入力項目のバリデーションルールを指定します。stringRuleを使用して初期化したルールを指定します。
selOptSelectOptionsセレクトボックスの選択肢を指定します。selectOptions を使用して初期値を指定します。
readonlyRW.Editable | RW.Readonly入力項目が読み取り専用かどうかを指定します。RW.Editable は読み取り・書き込み可能、RW.Readonlyは読み取り専用を表す値です。デフォルトは RW.Editable です。
placeholderstringプレースホルダーを指定します。

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

*2：StringValidationRuleはstring型のバリデーション定義情報（必須項目かどうか、最小・最大文字数、カスタムルール名など）を保持する型定義です。

返り値​

引数で定義した初期値やバリデーションルール、選択肢など、セレクトボックス項目に関する情報が集約された CsSelectBoxItem クラスのインスタンスを返します。

使用例​

useCsView({
  country: useCsSelectBoxItem(
    "国籍",
    useInit(""),
    stringRule(true),
    selectOptionStrings(["日本", "アメリカ", "イギリス", "中国", "その他"]),
    RW.Editable,
    "国籍を選択してください"
  ),
});