Skip to main content

Interface: UseInputOptions

Hierarchy​

  • Pick<DayPickerBase, "locale" | "fromDate" | "toDate" | "fromMonth" | "toMonth" | "fromYear" | "toYear" | "today">

    ↳ UseInputOptions

Properties​

defaultSelected​

β€’ Optional defaultSelected: Date

The initially selected date

Defined in​

hooks/useInput/useInput.ts:50


format​

β€’ Optional format: string

The format string for formatting the input field. See https://date-fns.org/docs/format for a list of format strings. Default to PP.

Defined in​

hooks/useInput/useInput.ts:52


fromDate​

β€’ Optional fromDate: Date

The earliest day to start the month navigation.

Inherited from​

Pick.fromDate

Defined in​

types/DayPickerBase.ts:95


fromMonth​

β€’ Optional fromMonth: Date

The earliest month to start the month navigation.

Inherited from​

Pick.fromMonth

Defined in​

types/DayPickerBase.ts:103


fromYear​

β€’ Optional fromYear: number

The earliest year to start the month navigation.

Inherited from​

Pick.fromYear

Defined in​

types/DayPickerBase.ts:111


locale​

β€’ Optional locale: Locale

The date-fns locale object used to localize dates. Defaults to* en-US.

Inherited from​

Pick.locale

Defined in​

types/DayPickerBase.ts:199


required​

β€’ Optional required: boolean

Make the selection required.

Defined in​

hooks/useInput/useInput.ts:54


toDate​

β€’ Optional toDate: Date

The latest day to end the month navigation.

Inherited from​

Pick.toDate

Defined in​

types/DayPickerBase.ts:99


toMonth​

β€’ Optional toMonth: Date

The latest month to end the month navigation.

Inherited from​

Pick.toMonth

Defined in​

types/DayPickerBase.ts:107


toYear​

β€’ Optional toYear: number

The latest year to end the month navigation.

Inherited from​

Pick.toYear

Defined in​

types/DayPickerBase.ts:115


today​

β€’ Optional today: Date

The today’s date. Default is the current date. This Date will get the today modifier to style the day.

Inherited from​

Pick.today

Defined in​

types/DayPickerBase.ts:192