DateTimePickerElement
<vaadin-date-time-picker> is a Web Component providing a date time selection field.
<vaadin-date-time-picker value="2019-09-16T15:00"></vaadin-date-time-picker>dateTimePicker.value = '2019-09-16T15:00';When the selected value is changed, a value-changed event is triggered.
Styling
The following shadow DOM parts are available for styling:
| Part name | Description |
|---|---|
label | The slotted label element wrapper |
input-fields | The date and time pickers wrapper |
helper-text | The slotted helper text element wrapper |
error-message | The slotted error message element wrapper |
required-indicator | The required state indicator element |
The following state attributes are available for styling:
| Attribute | Description |
|---|---|
disabled | Set when the element is disabled |
focused | Set when the element is focused |
focus-ring | Set when the element is keyboard focused |
readonly | Set when the element is readonly |
invalid | Set when the element is invalid |
has-label | Set when the element has a label |
has-value | Set when the element has a value |
has-helper | Set when the element has helper text |
has-error-message | Set when the element has an error message |
has-tooltip | Set when the element has a slotted tooltip |
The following custom CSS properties are available for styling:
| Custom CSS property |
|---|
--vaadin-date-time-picker-gap |
--vaadin-input-field-error-color |
--vaadin-input-field-error-font-size |
--vaadin-input-field-error-font-weight |
--vaadin-input-field-error-line-height |
--vaadin-input-field-label-color |
--vaadin-input-field-label-font-size |
--vaadin-input-field-label-font-weight |
--vaadin-input-field-label-line-height |
--vaadin-input-field-helper-color |
--vaadin-input-field-helper-font-size |
--vaadin-input-field-helper-font-weight |
--vaadin-input-field-helper-line-height |
--vaadin-input-field-required-indicator-color |
--vaadin-input-field-required-indicator |
Internal components
The following components are created by <vaadin-date-time-picker> and placed in light DOM:
#/elements/vaadin-date-picker.
#/elements/vaadin-time-picker.
See Styling Components documentation.
Change events
Depending on the nature of the value change that the user attempts to commit e.g. by pressing Enter, the component can fire either a change event or an unparsable-change event:
| Value change | Event |
|---|---|
| empty => parsable | change |
| empty => unparsable | unparsable-change |
| parsable => empty | change |
| parsable => parsable | change |
| parsable => unparsable | change |
| unparsable => empty | unparsable-change |
| unparsable => parsable | change |
| unparsable => unparsable | unparsable-change |
| incomplete => empty | unparsable-change |
| incomplete => parsable | change |
| incomplete => unparsable | unparsable-change |
| empty => incomplete | unparsable-change |
| parsable => incomplete | change |
| unparsable => incomplete | unparsable-change |
Properties
A space-separated list of IDs referencing the elements that describe the component for screen reader users. The referenced elements are announced in addition to the helper text and the error message.
String used to label the component for screen reader users.
A space-separated list of IDs referencing the elements that label the component for screen reader users.
Set to true to prevent the overlays from opening automatically.
A function that provides metadata for the dates the calendar is about to render: whether they are disabled, and CSS part names for styling from outside using the ::part() selector. The provider is called for a range of dates at a time, and again as the calendar renders further dates.
A placeholder string for the date field.
The time part to set automatically when the user commits a date while the time picker is empty.
Error to show when the field is invalid.
String used for the helper text.
Date which should be visible in the date picker overlay when there is no value selected.
Set to true to enable manual validation mode. This mode disables automatic constraint validation, allowing you to control the validation process yourself. You can still trigger constraint validation manually with the validate() method or use checkValidity() to assess the component's validity without affecting the invalid state. In manual validation mode, you can also manipulate the invalid property directly through your application logic without conflicts with the component's internal validation.
Set true to display ISO-8601 week numbers in the calendar. Notice that displaying week numbers is only supported when i18n.firstDayOfWeek is 1 (Monday).
A placeholder string for the time field.
Functions
Returns true if the field value satisfies all constraints (if any).
Clears the dateMetadataProvider cache and reloads the date metadata.