Skip to content

VDateTimePicker

Single date picker component.

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.
maxstringThe latest accepted date-time.
max-datestringThe latest accepted time date of the date-time.
max-timestringThe latest accepted time part of the date-time.
minstringThe earliest accepted date-time.
min-datestringThe earliest accepted date part of the date-time.
min-timestringThe earliest accepted time part of the date-time.
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.
seconds-stepnumberDistance between presented seconds options. If null, seconds are not presented.
valuestringThe current value of the element.

Events

NameEvent TypeDescription
blurFocusEventFires when the element loses focus.
changeCustomEvent<undefined>Emitted when the date is changed by the user.
clickMouseEventFires when a pointing device button (such as a mouse's primary mouse button) is both pressed and released while the pointer is located inside the element.
focusFocusEventFires when the element receives focus.
inputCustomEvent<undefined>Emitted when the date is changed by the user.
keydownKeyboardEventFires when a key is pressed.
keyupKeyboardEventFires when a key is released.

Slots

NameDescription
helper-textDescribes how to use the date-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.