defaultValue DateValue — Name defaultValue Description The default value for the calendar
Type CalendarDate | CalendarDateTime | ZonedDateTime Default — defaultPlaceholder DateValue — Name defaultPlaceholder Description The default placeholder date
Type CalendarDate | CalendarDateTime | ZonedDateTime Default — placeholder DateValue — Name placeholder Description The placeholder date, which is used to determine what month to display when no date is selected. This updates as the user navigates the calendar and can be used to programmatically control the calendar view
Type CalendarDate | CalendarDateTime | ZonedDateTime Default — modelValue DateValue | null — Name modelValue Description The controlled value of the field. Can be bound as v - model
Type null | CalendarDate | CalendarDateTime | ZonedDateTime Default — hourCycle HourCycle — Name hourCycle Description The hour cycle used for formatting times. Defaults to the local preference
Type 12 | 24 Default — step DateStep — Name step Description The stepping interval for the time fields. Defaults to 1
Type DateStep Default — stepSnapping boolean false Name stepSnapping Description Whether to enforce snapping the time value to the nearest step increment after input. Defaults to false
Type boolean Default false granularity Granularity — Name granularity Description The granularity to use for formatting times. Defaults to day if a CalendarDate is provided, otherwise defaults to minute. The field will render segments for each part of the date up to and including the specified granularity
Type ' day ' | ' hour ' | ' minute ' | ' second ' Default — hideTimeZone boolean false Name hideTimeZone Description Whether or not to hide the time zone segment of the field
Type boolean Default false maxValue DateValue — Name maxValue Description The maximum date that can be selected
Type CalendarDate | CalendarDateTime | ZonedDateTime Default — minValue DateValue — Name minValue Description The minimum date that can be selected
Type CalendarDate | CalendarDateTime | ZonedDateTime Default — locale string — Name locale Description The locale to use for formatting dates
Type string Default — disabled boolean false Name disabled Description Whether or not the date field is disabled
Type boolean Default false readonly boolean false Name readonly Description Whether or not the date field is readonly
Type boolean Default false isDateUnavailable Matcher — Name isDateUnavailable Description A function that returns whether or not a date is unavailable
Type ( date : DateValue ) : boolean Default — id string — Name id Description Type string Default — dir Direction — Name dir Description The reading direction of the date field when applicable.
If omitted, inherits globally from ConfigProvider
Type ' ltr ' | ' rtl ' Default — asChild boolean false Name asChild Description Change the default rendered element for the one passed as a child, merging their props and behavior.
Read our Composition guide for more details.
Type boolean Default false as AsTag | Component — Name as Description The element or component this component should render as. Can be overwritten by asChild
Type ComponentOptions < any , any , any , ComputedOptions , MethodOptions , any , any , any , string , {}, {}, string , {}, {}, {}, string , ComponentProvideOptions > | ( props : any , ctx : Omit < { attrs : Attrs ; slots : Readonly < InternalSlots > ; emit : ( event : string , ... args : any [] ) => void ; expose : < Exposed extends Record < string , any > = Record < string , any >> ( exposed ?: Exposed | undefined ) => void ; }, ' expose ' > ) : any | ComponentPublicInstanceConstructor < any , any , any , any , ComputedOptions , MethodOptions > | ' a ' | ' button ' | ' div ' | ' form ' | ' h2 ' | ' h3 ' | ' img ' | ' input ' | ' label ' | ' li ' | ' nav ' | ' ol ' | ' p ' | ' span ' | ' svg ' | ' ul ' | ' template ' | {} & string Default — name string — Name name Description The name of the field. Submitted with its owning form as part of a name/value pair.
Type string Default — required boolean false Name required Description When true
Type boolean Default false class ClassValue — Name class Description Classes added to the part's own element, after its recipe classes.
Type null | string | false | Record < string , any > | ClassValue[] Default —