Skip to main content

Date-Time Picker API

Properties
NameTypeDefaultDescription
valuestring | { start: string, end: string }Initial value. Use an ISO date string for single dates, or an object with start/end for ranges. Time zones are not handled.
type"date" | "datetime" | "daterange" | "datetimerange""date"Mode of the picker.
errorbooleanfalseShows the error state. Not set automatically for invalid input.
disabledbooleanfalseDisables the picker so it cannot be opened.
inlinebooleanfalseRenders the component as inline-block.
min-datestringMinimum selectable date in ISO format.
max-datestringMaximum selectable date in ISO format.
clear-hiddenbooleanfalseHides the clear button.
today-hiddenbooleanfalseHides the 'Today' shortcut button below the calendar.
manual-applybooleanfalseAdds confirm and cancel buttons to the panel footer.
start-disabledbooleanfalseDisables only the start date picker in a range.
end-disabledbooleanfalseDisables only the end date picker in a range.
presets-disabledbooleanfalseDisables all preset buttons.
placeholderstringPlaceholder text shown when no date is selected.
isReadyreadonly booleanIndicates whether the component is ready to open.
JavaScript API
NameKindDescription
open()actionOpens the calendar popup.
Events
EventDescriptionReturns
changeFires on date selection. Value is a string (yyyy-mm-dd or yyyy-mm-dd hh:mm) for single types, or { start, end } for range types.{ detail: { value } }
errorFires on invalid date input. Value holds the last valid value; inputValue holds what the user typed. Empty input sends empty string; invalid input sends 'Invalid Date'.{ detail: { value, inputValue } }
closeFires when the picker closes.{ type: 'close' }
openFires when the picker opens.{ type: 'open' }
readyFires when the component is ready to open.