Skip to main content

useCsInputNumberRangeItem

useCsInputNumberRangeItem は、数値範囲入力ボックスに対応する Item を初期化するためのフックです。

シグネチャ​

useCsInputNumberRangeItem(label, state, rule, readonly?, lowerPlaceholder?, upperPlaceholder?): CsInputNumberRangeItem

引数​

引数名必須型説明
label〇string入力項目のラベルを指定します。
state〇StateResult<number[]>*¹入力項目の状態変数を指定します。useRangeInit を使用して初期化した状態変数を指定します。
rule〇NumberValidationRule*²入力項目のバリデーションルールを指定します。numberRuleを使用して初期化したルールを指定します。
readonlyRW.Editable | RW.Readonly入力項目が読み取り専用かどうかを指定します。RW.Editable は読み取り・書き込み可能、RW.Readonlyは読み取り専用を表す値です。デフォルトは RW.Editable です。 　
lowerPlaceholderstring下限値のプレースホルダーを指定します。
upperPlaceholderstring上限値のプレースホルダーを指定します。

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

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

返り値​

引数で定義した初期値やバリデーションルールなど、数値範囲入力項目に関する情報が集約された CsInputNumberRangeItem クラスのインスタンスを返します。

使用例​

useCsView({
  budgetRange: useCsInputNumberRangeItem(
    "予算範囲",
    useRangeInit<number>(),
    numberRule(false, 1, 100000),
    RW.Editable,
    "最低予算価格を入力してください",
    "最高予算価格を入力してください"
  ),
});