Skip to content

VTimePicker

Props

NameTypeDescription
clockEnum:
12h
24h
Forces a 12h or 24h clock to be used.
disabledbooleanSets the element's disabled state. A disabled element will not be included during form submission.
error-textstringProvides a custom error message. Any current error state will be overridden.
helper-textstringProvides additional information to help the user enter the correct information. To add HTML to the helper text, use the helper-text slot instead.
initial-valuestringThe default value of the element. This value sets the value property only when the value property has not been explicitly set.
labelstringThe label for the form element.
maxstringSets the maximum time the user can set
minstringSets the minimum time the user can set
minutes-stepnumberDistance between presented minute options.
namestringThe name of the element. This element's value will be surfaced during form submission under the provided name.
readonlybooleanWhether the date-picker is readonly.
requiredbooleanRequire the field to be completed prior to form submission.
scaleEnum:
condensed
normal
Sets the display size of the picker field input element.
seconds-stepnumberDistance between presented seconds options. If null, seconds are not presented.
valuestringThe current value of the element.

Events

NameEvent TypeDescription
changeCustomEvent<undefined>Emitted when the time is changed by the user.
inputCustomEvent<undefined>Emitted when the time is changed by the user.

Slots

NameDescription
contextual-helpSlot for the contextual-help component, displayed next to the label.
helper-textDescribes how to use the time-picker. Alternative to the helper-text attribute.

Methods

NameTypeDescription
checkValidity() => booleanReturn the current validity of the element.
reportValidity() => booleanReturn the current validity of the element. If false, fires an invalid event at the element.