Skip to content
On this page

VDateRangePicker

Props

NameTypeDescription
labelstringThe label for the form element.
error-textstringThe error text for the form element.
aria-currentEnum:
page
step
location
date
time
true
false
Indicates the element that represents the current item within a container or set of related elements.
disabledbooleanSets the element's disabled state. A disabled element will not be included during form submission.
namestringThe name of the element. This element's value will be surfaced during form submission under the provided name.
requiredbooleanRequire the field to be completed prior to form submission.
maxstringThe latest accepted date of the date-picker.
initial-startstringThe initial start value. This value sets the start property only when the start property has not been explicitly set.
initial-endstringThe initial end value. This value sets the end property only when the end property has not been explicitly set.
startstringThe current start value of the element. This property serves as a mechanism to set the start property through both property assignment and the .setAttribute() method. This is useful for setting the field's value in UI libraries that bind data through the .setAttribute() API and don't support IDL attribute binding.
endstringThe current end value of the element. This property serves as a mechanism to set the end property through both property assignment and the .setAttribute() method. This is useful for setting the field's value in UI libraries that bind data through the .setAttribute() API and don't support IDL attribute binding.
minstringThe earliest accepted date of the date-picker.
initial-valuestringThe initial value of the date-picker.
valuestringThe current value of the date-picker.
readonlybooleanWhether the date-picker is readonly.

Events

NameEvent TypeDescription
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.
blurFocusEventFires when the element loses focus.
keydownKeyboardEventFires when a key is pressed.
keyupKeyboardEventFires when a key is released.
input:startCustomEvent<undefined>Event emitted when the start value changes
input:endCustomEvent<undefined>Event emitted when the end value changes
inputCustomEvent<undefined>Emitted when either the start or end value changes
changeCustomEvent<undefined>Emitted when either the start or end value changes
clear-clickCustomEvent<undefined>Event emitted when the clear button is clicked.

Slots

NameDescription
helper-textDescribes how to use the date-range-picker. Alternative to the helper-text attribute.