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
src/hooks/useInput/useInput.ts:53
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 Value
PP
Defined in
src/hooks/useInput/useInput.ts:60
fromDate
• Optional
fromDate: Date
The earliest day to start the month navigation.
Inherited from
Pick.fromDate
Defined in
src/types/DayPickerBase.ts:114
fromMonth
• Optional
fromMonth: Date
The earliest month to start the month navigation.
Inherited from
Pick.fromMonth
Defined in
src/types/DayPickerBase.ts:122
fromYear
• Optional
fromYear: number
The earliest year to start the month navigation.
Inherited from
Pick.fromYear
Defined in
src/types/DayPickerBase.ts:130
locale
• Optional
locale: Locale
The date-fns locale object used to localize dates.
Default Value
en-US
Inherited from
Pick.locale
Defined in
src/types/DayPickerBase.ts:274
required
• Optional
required: boolean
Make the selection required.
Defined in
src/hooks/useInput/useInput.ts:62
toDate
• Optional
toDate: Date
The latest day to end the month navigation.
Inherited from
Pick.toDate
Defined in
src/types/DayPickerBase.ts:118
toMonth
• Optional
toMonth: Date
The latest month to end the month navigation.
Inherited from
Pick.toMonth
Defined in
src/types/DayPickerBase.ts:126
toYear
• Optional
toYear: number
The latest year to end the month navigation.
Inherited from
Pick.toYear
Defined in
src/types/DayPickerBase.ts:134
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