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

When true, the user can input a value that is not present in the items list.

Link copied to clipboard

A pattern matched against individual characters the user inputs.

Link copied to clipboard

Set to true to auto expand horizontally, causing input field to grow until max width is reached.

Link copied to clipboard

Set to true to not collapse selected items chips into the overflow chip and instead always expand vertically, causing input field to wrap into multiple lines when width is limited.

Link copied to clipboard

Set true to prevent the overlay from opening automatically.

Link copied to clipboard
abstract var autoselect: Boolean

If true, the input text gets fully selected when the field is focused using click or touch / tap.

Link copied to clipboard

Set to true to display the clear icon which clears the input. This also enables clearing the input when pressing Esc key.

Link copied to clipboard
abstract var collapseChips: Boolean

Set to true to collapse all selected items chips into the overflow chip when they don't all fit, instead of showing as many as possible. Has no effect when autoExpandVertically is true.

Link copied to clipboard

Function that provides items lazily. Receives arguments params, callback

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

Filtering string the user has typed into the input field.

Link copied to clipboard
abstract var filteredItems: Array<JsAny>?

A subset of items, filtered based on the user input. Filtered items can be assigned directly to omit the internal filtering functionality. The items can be of either String or Object type.

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

Set to true when the field is invalid.

Link copied to clipboard

A function used to generate CSS class names for dropdown items and selected chips based on the item. The return value should be the generated class name as a string, or multiple class names separated by whitespace characters.

Link copied to clipboard
abstract var itemIdPath: String

Path for the id of the item. If items is an array of objects, the itemIdPath is used to compare and identify the same item in the selection and in filteredItems (items given by the dataProvider callback).

Link copied to clipboard
abstract var itemLabelGenerator: (JsAny?) -> String?

A function that is used to generate the label for dropdown items based on the item. Receives one argument:

Link copied to clipboard
abstract var itemLabelPath: String

Path for label of the item. If items is an array of objects, the itemLabelPath is used to fetch the displayed string label for each item.

Link copied to clipboard
abstract var items: Array<JsAny>?

A full set of items to filter the visible options from. The items can be of either String or Object type.

Link copied to clipboard
abstract var itemValuePath: String

Path for the value of the item. If items is an array of objects, the itemValuePath: is used to fetch the string value for the selected item.

Link copied to clipboard
abstract var keepFilter: Boolean

When true, filter string isn't cleared after selecting an item.

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
abstract var loading: Boolean

True when loading items from the data provider, false otherwise.

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

Link copied to clipboard
abstract var opened: Boolean

True if the dropdown is open, false otherwise.

Link copied to clipboard
abstract var pageSize: Double

Number of items fetched at a time from the dataprovider.

Link copied to clipboard
abstract var partialMatchMode: String

Controls which item is automatically set to be selected, for example on Enter, when the typed filter only partially matches its label. The item that will be selected is highlighted in the dropdown while typing:

Link copied to clipboard
abstract var placeholder: String

A hint to the user of what can be entered in the field.

Link copied to clipboard
abstract var readonly: Boolean

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

Link copied to clipboard

Custom function for rendering the content of every item. Receives three arguments:

Link copied to clipboard
abstract var required: Boolean

Specifies that the user must fill in a value.

Link copied to clipboard
abstract var selectedItems: Array<JsAny?>

The list of selected items. Note: modifying the selected items creates a new array each time.

Link copied to clipboard

Set to true to group selected items at the top of the overlay.

Link copied to clipboard
abstract var size: Double

Total number of items.

Link copied to clipboard
abstract var value: String

The value of the field.

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

Clear the value of the field.

Link copied to clipboard
abstract fun clearCache()

Clears the cached pages and reloads data from dataprovider when needed.

Link copied to clipboard
abstract fun close()

Closes the dropdown list.

Link copied to clipboard
abstract fun open()

Opens the dropdown list.

Link copied to clipboard
abstract fun requestContentUpdate()

Requests an update for the content of items. While performing the update, it invokes the renderer (passed in the renderer property) once an item.

Link copied to clipboard
abstract fun validate(): Boolean

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