Skip to main content

useCsInputDateRangeItem

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

シグネチャ​

useCsInputDateRangeItem(label, state, rule, readonly?, lowerPlaceholder?, upperPlaceholder?): CsInputDateRangeItem

引数​

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

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

*2：StringArrayValidationRuleはstring[]型のバリデーション定義情報（必須項目かどうか、カスタムルール名など）を保持する型定義です。

返り値​

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

使用例​

useCsView({
  subscriptionPeriod: useCsInputDateRangeItem(
    "購読期間",
    useRangeInit("2020-01-01", "2020-12-31"),
    stringArrayRule(true),
    RW.Editable,
    "開始日を入力してください",
    "終了日を入力してください"
  ),
});