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
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 invalid: Boolean

Set to true when the field is invalid.

Link copied to clipboard
abstract var items: Array<SelectItemData>

An array containing items that will be rendered as the options of the select.

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 name: String

The name of this element.

Link copied to clipboard

Defines whether the overlay should overlap the target element in the y-axis, or be positioned right above/below it.

Link copied to clipboard
abstract var opened: Boolean

Set when the select is open

Link copied to clipboard
abstract var placeholder: String

A hint to the user of what can be entered in the control. The placeholder will be displayed in the case that there is no item selected, or the selected item has an empty string label, or the selected item has no label and it's DOM content is empty.

Link copied to clipboard
abstract var readonly: Boolean

When present, it specifies that the element is read-only.

Link copied to clipboard
abstract var renderer: SelectRenderer?

Custom function for rendering the content of the <vaadin-select>. Receives two arguments:

Link copied to clipboard
abstract var required: Boolean

Specifies that the user must fill in a value.

Link copied to clipboard
abstract var value: String

The value property of the selected item, or an empty string if no item is selected. On change or initialization, the component finds the item which matches the value and displays it. If no value is provided to the component, it selects the first item without value or empty value. Hint: If you do not want to select any item by default, you can either set all the values of inner vaadin-items, or set the vaadin-select value to an inexistent value in the items list.

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 requestContentUpdate()

Requests an update for the content of the select. While performing the update, it invokes the renderer passed in the renderer property.

Link copied to clipboard
abstract fun validate(): Boolean

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