| Prop | Default | Type |
|---|---|---|
as | 'div' | AsTag | ComponentThe element or component this component should render as. Can be overwritten by |
asChild | booleanChange the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details. | |
defaultPlaceholder | TimeValueThe default placeholder date | |
defaultValue | TimeValueThe default value for the calendar | |
dir | 'ltr' | 'rtl'The reading direction of the time field when applicable. | |
disabled | false | booleanWhether or not the time field is disabled |
granularity | 'hour' | 'minute' | 'second'The granularity to use for formatting times. Defaults to minute if a Time is provided, otherwise defaults to minute. The field will render segments for each part of the date up to and including the specified granularity | |
hideTimeZone | booleanWhether or not to hide the time zone segment of the field | |
hourCycle | 12 | 24The hour cycle used for formatting times. Defaults to the local preference | |
id | stringId of the element | |
locale | stringThe locale to use for formatting dates | |
maxValue | TimeValueThe maximum date that can be selected | |
minValue | TimeValueThe minimum date that can be selected | |
modelValue | TimeValue | nullThe controlled checked state of the field. Can be bound as | |
name | stringThe name of the field. Submitted with its owning form as part of a name/value pair. | |
placeholder | TimeValueThe placeholder date, which is used to determine what time to display when no time is selected. This updates as the user navigates the field | |
readonly | false | booleanWhether or not the time field is readonly |
required | booleanWhen | |
step | DateStepThe stepping interval for the time fields. Defaults to |
| Emit | Payload |
|---|---|
update:modelValue | [date: TimeValue]Event handler called whenever the model value changes |
update:placeholder | [date: TimeValue]Event handler called whenever the placeholder value changes |
| Slots (default) | Payload |
|---|---|
modelValue | TimeValue | undefinedThe current time of the field |
segments | { part: SegmentPart; value: string; }[]The time field segment contents |
isInvalid | booleanValue if the input is invalid |
| Methods | Type |
|---|---|
setFocusedElement | (el: HTMLElement) => voidHelper to set the focused element inside the DateField |
