Vue Time Picker Component API

Sets the accessible label (aria-label) of the button that clears the value.

The aria-label of the day section.

The aria-label of the hour section.

The aria-label of the meridiem section.

The aria-label of the minute section.

The aria-label of the month section.

Sets the accessible label (aria-label) of the button that opens the time selection.

Sets the accessible label (aria-label) of the time selection panel, which opens as a role="dialog".

The aria-label of the quarter section.

The aria-label of the second section.

Sets the accessible label of the hours column.

Sets the accessible label of the AM/PM column.

Sets the accessible label of the minutes column.

Sets the accessible label of the seconds column.

The aria-label of the week section.

The aria-label of the year section.

Renders the button that clears the value.

The element the time selection is rendered into instead of document.body. Implies portal. Inside a modal dialog it goes into the dialog instead, because the rest of the page is inert.

Replaces the DD the day section shows while it is empty.

Toggles the disabled state.

Provide valuable, actionable feedback to your users with HTML5 form validation feedback.

Provide valuable, actionable invalid feedback when using standard HTML form validation which applied invalid prop.

Provide valuable, actionable valid feedback when using standard HTML form validation which applied valid prop.

Renders a floating label inside the field — the component wraps its input in .form-floating and the text also becomes the field's accessible name.

Keeps the floating label floated and the placeholder visible while the field is empty.

The mask layout of the field. A string is parsed as dayjs/moment or date-fns/luxon format tokens, a function receives the locale and returns the section layout, and undefined derives the layout from the locale. The mask's hour cycle also drives the columns.

Replaces the HH (hh on a 12-hour clock) the hour section shows while it is empty.

Narrows the hours to a list, or to the ones a predicate accepts. Hours are 0 to 23 in every locale; on a 12-hour clock an hour that only one day period allows sets that period when picked.

Mark the control invalid.

Use validationState="invalid" instead — invalid is ignored when validationState is set.

Add a caption for a component.

Sets the default locale for the component. If not set, it is inherited from the browser.

The latest time the user can pick: a time string such as '17:00', or a Date of which only the time of day counts. The panel disables the times after it, a time picked in the panel moves back to it, and the field rejects a later time.

Replaces the AM the meridiem section shows while it is empty.

The earliest time the user can pick: a time string such as '09:30', or a Date of which only the time of day counts. The panel disables the times before it, a time picked in the panel moves up to it, and the field rejects an earlier time.

Replaces the mm the minute section shows while it is empty.

Renders the minutes column, optionally narrowed the way hours is.

Replaces the MM the month section shows while it is empty.

Name of the value input the value is submitted under. Without it the field is not submitted with the form.

The button that opens the panel. Set to false to render no button; replace the artwork through the pickerIcon slot.

Renders the time selection through a portal: into the open <dialog> the field sits in, otherwise into document.body.

Replaces the Q the quarter section shows while it is empty.

Toggle the readonly state for the component.

When present, it specifies that the field must be filled out before submitting the form.

Replaces the ss the second section shows while it is empty.

Renders the seconds column, optionally narrowed the way hours is.

Control the open state via v-model:show. When set, the time selection renders what show says and dismiss gestures only emit update:show.

Sizes the control, the way .form-control-sm and .form-control-lg size a form control.

Add helper text to the component.

The time — a Date or a time string like '14:30'. Passed one-way it seeds the field, which keeps managing itself; bound with v-model:time it follows your state.

Display validation feedback in a styled tooltip.

Mark the control valid.

Use validationState="valid" instead — valid is ignored when validationState is set.

The validation state, rendered as the is-{state} class; 'invalid' also sets aria-invalid on every section of the field and blocks the submit. Any custom state declared in the $form-validation-states Sass map is accepted. The user's next change of the time emits update:validationState with undefined.

Controls the visibility of the time selection.

Use show / v-model:show instead — visible is ignored when show is set.

Replaces the WW the week section shows while it is empty.

Replaces the YYYY the year section shows while it is empty.

Callback fired when the validation state changes; receives 'incomplete', 'minDate', 'maxDate', 'disabledDate', or null when the value is valid or the field is empty. When one change moves both the value and the validation state, it fires after time-change, so a value set from it replaces the one just reported.

Callback fired when the time selection is hidden.

Callback fired when the time selection is shown.

Callback fired once when the value changes, whether from the field, the panel or the context methods; receives the Date the field holds, anchored to 1970-01-01 and cut to the units the field shows, or null while the field is empty or incomplete, and the formatted value.

• time Date | null — date object
• formattedTime string — formatted time

Emit the requested open state to support the v-model:show binding.

Emit the new time to support the v-model:time binding.

• time Date | null — date object

Event occurs with undefined when the user changes the time, or the form is reset, while validationState (or the deprecated invalid/valid) is set. A given state is a verdict on the value it was given for; bind it with v-model:validation-state to drop it and let the browser's own validation show again.