ComboBoxItemsMixin

Properties

Link copied to clipboard

Set true to prevent the overlay from opening automatically.

Link copied to clipboard
abstract var disabled: Boolean

If true, the user cannot interact with this element.

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

True if the dropdown is open, false otherwise.

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

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

Link copied to clipboard
abstract var value: String

The value of the field.

Functions

Link copied to clipboard
abstract fun clear()

Clear the value of the field.

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.