DateTimePickerMixin

A mixin providing common date-time-picker functionality.

Inheritors

Properties

Link copied to clipboard

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.

Link copied to clipboard
abstract var accessibleName: String

String used to label the component for screen reader users.

Link copied to clipboard

A space-separated list of IDs referencing the elements that label the component for screen reader users.

Link copied to clipboard

Set to true to prevent the overlays from opening automatically.

Link copied to clipboard

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.

Link copied to clipboard
abstract var datePlaceholder: String

A placeholder string for the date field.

Link copied to clipboard
abstract var defaultTime: String

The time part to set automatically when the user commits a date while the time picker is empty.

Link copied to clipboard
abstract var disabled: Boolean

If true, the user cannot interact with this element.

Link copied to clipboard
abstract var errorMessage: String

Error to show when the field is invalid.

Link copied to clipboard
abstract var helperText: String

String used for the helper text.

Link copied to clipboard
abstract var i18n: JsAny

The object used to localize this component. To change the default localization, replace this with an object that provides all properties, or just the individual properties you want to change.

Link copied to clipboard
abstract var initialPosition: String

Date which should be visible in the date picker overlay when there is no value selected.

Link copied to clipboard
abstract var invalid: Boolean

Set to true when the field is invalid.

Link copied to clipboard
abstract var label: String

The label text for the input node. When no light dom defined via slot=label, this value will be used.

Link copied to clipboard

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.

Link copied to clipboard
abstract var max: String

The latest value (date and time) that can be selected. All later values will be disabled.

Link copied to clipboard
abstract var min: String

The earliest allowed value (date and time) that can be selected. All earlier values will be disabled.

Link copied to clipboard
abstract var name: String

The name of the control, which is submitted with the form data.

Link copied to clipboard
abstract var readonly: Boolean

Set to true to make this element read-only.

Link copied to clipboard
abstract var required: Boolean

Specifies that the user must fill in a value.

Link copied to clipboard
abstract var showWeekNumbers: Boolean

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).

Link copied to clipboard
abstract var step: Double

Defines the time interval (in seconds) between the items displayed in the time selection box. The default is 1 hour (i.e. 3600).

Link copied to clipboard
abstract var timePlaceholder: String

A placeholder string for the time field.

Link copied to clipboard
abstract var value: String

The value for this element.

Functions

Link copied to clipboard
abstract fun checkValidity(): Boolean

Returns true if the field value satisfies all constraints (if any).

Link copied to clipboard
abstract fun clearCache()

Clears the dateMetadataProvider cache and reloads the date metadata.

Link copied to clipboard
abstract fun validate(): Boolean

Validates the field and sets the invalid property based on the result.