Skip to main content

Interface: UseInputOptions#

Properties#

defaultSelected#

Optional defaultSelected: Date

The default selected day.


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.


fromDate#

Optional fromDate: Date

The earliest day to start the month navigation.


fromMonth#

Optional fromMonth: Date

The earliest month to start the month navigation.


fromYear#

Optional fromYear: number

The earliest year to start the month navigation.


locale#

Optional locale: Locale

The date-fns locale object to localize the user interface. Defaults to en-US.

import es from 'date-fns/locale/es';

See also date-fns Internationalization guide.


required#

Optional required: boolean

Make the selection required.


toDate#

Optional toDate: Date

The latest day to end the month navigation.


toMonth#

Optional toMonth: Date

The latest month to end the month navigation.


toYear#

Optional toYear: number

The latest year to end the month navigation.


today#

Optional today: Date

The date to use as "today".