MultiSelectComboBoxElement

<vaadin-multi-select-combo-box> is a web component that wraps <vaadin-combo-box> and extends its functionality to allow selecting multiple items, in addition to basic features.

<vaadin-multi-select-combo-box id="comboBox"></vaadin-multi-select-combo-box>
const comboBox = document.querySelector('#comboBox');
comboBox.items = ['apple', 'banana', 'lemon', 'orange'];
comboBox.selectedItems = ['lemon', 'orange'];

Styling

The following shadow DOM parts are available for styling:

Part nameDescription
chipsThe element that wraps slotted chips for selected items
labelThe label element
input-fieldThe element that wraps prefix, value and suffix
field-buttonSet on both clear and toggle buttons
clear-buttonThe clear button
error-messageThe error message element
helper-textThe helper text element wrapper
required-indicatorThe required state indicator element
toggle-buttonThe toggle button
overlayThe overlay container
contentThe overlay content
loaderThe loading indicator shown while loading items

The following state attributes are available for styling:

AttributeDescription
disabledSet to a disabled element
has-valueSet when the element has a value
has-labelSet when the element has a label
has-helperSet when the element has helper text or slot
has-error-messageSet when the element has an error message
has-tooltipSet when the element has a slotted tooltip
invalidSet when the element is invalid
focusedSet when the element is focused
focus-ringSet when the element is keyboard focused
loadingSet when loading items from the data provider
openedSet when the dropdown is open
readonlySet to a readonly element

The following custom CSS properties are available for styling:

Custom CSS property
--vaadin-chip-background
--vaadin-chip-border-color
--vaadin-chip-border-radius
--vaadin-chip-border-width
--vaadin-chip-font-size
--vaadin-chip-font-weight
--vaadin-chip-gap
--vaadin-chip-height
--vaadin-chip-padding
--vaadin-chip-remove-button-text-color
--vaadin-chip-text-color
--vaadin-field-default-width
--vaadin-input-field-background
--vaadin-input-field-border-color
--vaadin-input-field-border-radius
--vaadin-input-field-border-width
--vaadin-input-field-bottom-end-radius
--vaadin-input-field-bottom-start-radius
--vaadin-input-field-button-text-color
--vaadin-input-field-container-gap
--vaadin-input-field-disabled-background
--vaadin-input-field-disabled-text-color
--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-gap
--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-label-color
--vaadin-input-field-label-font-size
--vaadin-input-field-label-font-weight
--vaadin-input-field-label-line-height
--vaadin-input-field-padding
--vaadin-input-field-placeholder-color
--vaadin-input-field-required-indicator
--vaadin-input-field-required-indicator-color
--vaadin-input-field-top-end-radius
--vaadin-input-field-top-start-radius
--vaadin-input-field-value-color
--vaadin-input-field-value-font-size
--vaadin-input-field-value-font-weight
--vaadin-input-field-value-line-height
--vaadin-item-overlay-padding
--vaadin-multi-select-combo-box-chip-min-width
--vaadin-multi-select-combo-box-chips-gap
--vaadin-multi-select-combo-box-input-min-width
--vaadin-multi-select-combo-box-overlay-max-height
--vaadin-multi-select-combo-box-overlay-width

Internal components

In addition to <vaadin-multi-select-combo-box> itself, the following internal components are themable:

  • <vaadin-multi-select-combo-box-chip>

  • <vaadin-multi-select-combo-box-item> - has the same API as <vaadin-item>.

See Styling Components documentation.

Constructors

Link copied to clipboard
constructor()

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
Link copied to clipboard
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
open var ariaActiveDescendantElement: Element?
Link copied to clipboard
open var ariaAtomic: String?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open var ariaBusy: String?
Link copied to clipboard
open var ariaChecked: String?
Link copied to clipboard
open var ariaColCount: String?
Link copied to clipboard
open var ariaColIndex: String?
Link copied to clipboard
Link copied to clipboard
open var ariaColSpan: String?
Link copied to clipboard
open var ariaControlsElements: ReadonlyArray<Element>?
Link copied to clipboard
open var ariaCurrent: String?
Link copied to clipboard
open var ariaDescribedByElements: ReadonlyArray<Element>?
Link copied to clipboard
Link copied to clipboard
open var ariaDetailsElements: ReadonlyArray<Element>?
Link copied to clipboard
open var ariaDisabled: String?
Link copied to clipboard
open var ariaErrorMessageElements: ReadonlyArray<Element>?
Link copied to clipboard
open var ariaExpanded: String?
Link copied to clipboard
open var ariaFlowToElements: ReadonlyArray<Element>?
Link copied to clipboard
open var ariaHasPopup: String?
Link copied to clipboard
open var ariaHidden: String?
Link copied to clipboard
open var ariaInvalid: String?
Link copied to clipboard
Link copied to clipboard
open var ariaLabel: String?
Link copied to clipboard
open var ariaLabelledByElements: ReadonlyArray<Element>?
Link copied to clipboard
open var ariaLevel: String?
Link copied to clipboard
open var ariaLive: String?
Link copied to clipboard
open var ariaModal: String?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open var ariaOwnsElements: ReadonlyArray<Element>?
Link copied to clipboard
Link copied to clipboard
open var ariaPosInSet: String?
Link copied to clipboard
open var ariaPressed: String?
Link copied to clipboard
open var ariaReadOnly: String?
Link copied to clipboard
open var ariaRelevant: String?
Link copied to clipboard
open var ariaRequired: String?
Link copied to clipboard
Link copied to clipboard
open var ariaRowCount: String?
Link copied to clipboard
open var ariaRowIndex: String?
Link copied to clipboard
Link copied to clipboard
open var ariaRowSpan: String?
Link copied to clipboard
open var ariaSelected: String?
Link copied to clipboard
open var ariaSetSize: String?
Link copied to clipboard
open var ariaSort: String?
Link copied to clipboard
open var ariaValueMax: String?
Link copied to clipboard
open var ariaValueMin: String?
Link copied to clipboard
open var ariaValueNow: String?
Link copied to clipboard
Link copied to clipboard
open val assignedSlot: HTMLSlotElement?
Link copied to clipboard
val attributes: NamedNodeMap
Link copied to clipboard
open val attributeStyleMap: StylePropertyMap
Link copied to clipboard
var autocapitalize: AutoCapitalize
Link copied to clipboard
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
open var autofocus: Boolean
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
Link copied to clipboard
Link copied to clipboard
val childNodes: NodeList<ChildNode>
Link copied to clipboard
open val children: HTMLCollection<*>
Link copied to clipboard
val classList: DOMTokenList<ClassName>
Link copied to clipboard
var className: ClassName
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
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
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
Link copied to clipboard
Link copied to clipboard
val customElementRegistry: CustomElementRegistry?
Link copied to clipboard

Function that provides items lazily. Receives arguments params, callback

Link copied to clipboard
open val dataset: DOMStringMap
Link copied to clipboard
var dataTestId: DataTestId?
Link copied to clipboard
var dir: String
Link copied to clipboard
abstract var disabled: Boolean

If true, the user cannot interact with this element.

Link copied to clipboard
Link copied to clipboard
var editContext: EditContext?
Link copied to clipboard
open var enterKeyHint: EnterKeyHint
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
val firstChild: ChildNode?
Link copied to clipboard
open val firstElementChild: Element?
Link copied to clipboard
abstract var helperText: String

String used for the helper text.

Link copied to clipboard
var hidden: Hidden
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
var id: ElementId
Link copied to clipboard
Link copied to clipboard
var innerHTML: HtmlSource
Link copied to clipboard
Link copied to clipboard
open var inputMode: InputMode
Link copied to clipboard
abstract var invalid: Boolean

Set to true when the field is invalid.

Link copied to clipboard
Link copied to clipboard
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
Link copied to clipboard
val lastChild: ChildNode?
Link copied to clipboard
open val lastElementChild: Element?
Link copied to clipboard
abstract var loading: Boolean

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

Link copied to clipboard
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
Link copied to clipboard
open val nextElementSibling: Element?
Link copied to clipboard
val nextSibling: ChildNode?
Link copied to clipboard
Link copied to clipboard
val nodeType: NodeType
Link copied to clipboard
Link copied to clipboard
open var nonce: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val offsetParent: Element?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open var onabort: EventHandler<UIEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onanimationcancel: EventHandler<AnimationEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onanimationend: EventHandler<AnimationEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onanimationiteration: EventHandler<AnimationEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onanimationstart: EventHandler<AnimationEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onauxclick: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onbeforeinput: EventHandler<InputEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onbeforematch: EventHandler<Event, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onbeforetoggle: EventHandler<ToggleEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onblur: EventHandler<FocusEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var oncancel: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var oncanplay: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var oncanplaythrough: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onchange: EventHandler<Event, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onclick: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onclose: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var oncommand: EventHandler<CommandEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var oncontextlost: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var oncontextmenu: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var oncontextrestored: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var oncopy: EventHandler<ClipboardEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var oncuechange: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var oncut: EventHandler<ClipboardEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondblclick: EventHandler<MouseEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondrag: EventHandler<DragEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondragend: EventHandler<DragEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondragenter: EventHandler<DragEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondragleave: EventHandler<DragEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondragover: EventHandler<DragEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondragstart: EventHandler<DragEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondrop: EventHandler<DragEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondurationchange: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onemptied: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onended: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onerror: JsFunction<*, *>?
Link copied to clipboard
open var onfocus: EventHandler<FocusEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onformdata: EventHandler<FormDataEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
var onfullscreenchange: EventHandler<Event, Element, Node>?
Link copied to clipboard
var onfullscreenerror: EventHandler<Event, Element, Node>?
Link copied to clipboard
open var ongotpointercapture: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var oninput: EventHandler<InputEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var oninvalid: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onkeydown: EventHandler<KeyboardEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onkeyup: EventHandler<KeyboardEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onload: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onloadeddata: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onloadedmetadata: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onloadstart: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onlostpointercapture: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onmousedown: EventHandler<MouseEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onmouseenter: EventHandler<MouseEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onmouseleave: EventHandler<MouseEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onmousemove: EventHandler<MouseEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onmouseout: EventHandler<MouseEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onmouseover: EventHandler<MouseEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onmouseup: EventHandler<MouseEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onpaste: EventHandler<ClipboardEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onpause: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onplay: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onplaying: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onpointercancel: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onpointerdown: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onpointerenter: EventHandler<PointerEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onpointerleave: EventHandler<PointerEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onpointermove: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onpointerout: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onpointerover: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onpointerrawupdate: EventHandler<Event, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onpointerup: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onprogress: EventHandler<ProgressEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onratechange: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onreset: EventHandler<Event, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onresize: EventHandler<UIEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onscroll: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onscrollend: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onsecuritypolicyviolation: EventHandler<SecurityPolicyViolationEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onseeked: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onseeking: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onselect: EventHandler<Event, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onselectionchange: EventHandler<Event, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onselectstart: EventHandler<Event, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onslotchange: EventHandler<Event, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onstalled: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onsubmit: EventHandler<SubmitEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onsuspend: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var ontimeupdate: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var ontoggle: EventHandler<ToggleEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var ontouchcancel: EventHandler<TouchEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ontouchend: EventHandler<TouchEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ontouchmove: EventHandler<TouchEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ontouchstart: EventHandler<TouchEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ontransitioncancel: EventHandler<TransitionEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ontransitionend: EventHandler<TransitionEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ontransitionrun: EventHandler<TransitionEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ontransitionstart: EventHandler<TransitionEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onvolumechange: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onwaiting: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onwheel: EventHandler<WheelEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
abstract var opened: Boolean

True if the dropdown is open, false otherwise.

Link copied to clipboard
var outerHTML: HtmlSource
Link copied to clipboard
Link copied to clipboard
open override val ownerDocument: Document
Link copied to clipboard
abstract var pageSize: Double

Number of items fetched at a time from the dataprovider.

Link copied to clipboard
val parentElement: HTMLElement?
Link copied to clipboard
val parentNode: ParentNode?
Link copied to clipboard
val part: DOMTokenList<JsString>
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
var popover: Popover?
Link copied to clipboard
Link copied to clipboard
open val previousElementSibling: Element?
Link copied to clipboard
val previousSibling: ChildNode?
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
open var role: String?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
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
val shadowRoot: ShadowRoot?
Link copied to clipboard
abstract var size: Double

Total number of items.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open val style: CSSStyleDeclaration
Link copied to clipboard
open var tabIndex: Int
Link copied to clipboard
Link copied to clipboard
open override var textContent: String?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract var value: String

The value of the field.

Link copied to clipboard

Functions

Link copied to clipboard
open fun after(vararg nodes: String)
open fun after(vararg nodes: Node)
Link copied to clipboard
open fun animate(keyframes: ReadonlyArray<Keyframe>?, options: Double): Animation
open fun animate(keyframes: ReadonlyArray<Keyframe>?, options: KeyframeAnimationOptions): Animation
open fun animate(keyframes: PropertyIndexedKeyframes?, options: Double): Animation
open fun animate(keyframes: PropertyIndexedKeyframes?, options: KeyframeAnimationOptions): Animation
Link copied to clipboard
open fun append(vararg nodes: String)
open fun append(vararg nodes: Node)
Link copied to clipboard
fun <T : Node> appendChild(node: T): T
Link copied to clipboard
fun attachInternals(): ElementInternals
Link copied to clipboard
fun attachShadow(init: ShadowRootInit): ShadowRoot
Link copied to clipboard
open fun before(vararg nodes: String)
open fun before(vararg nodes: Node)
Link copied to clipboard
open fun blur()
Link copied to clipboard
abstract fun checkValidity(): Boolean

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

Link copied to clipboard
fun checkVisibility(options: CheckVisibilityOptions): Boolean
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
fun click()
Link copied to clipboard
fun cloneNode(subtree: Boolean): Node
Link copied to clipboard
abstract fun close()

Closes the dropdown list.

Link copied to clipboard
fun closest(selector: String): Element?
fun <T : Element> closest(selector: TagName<T>): T?
Link copied to clipboard
fun compareDocumentPosition(other: Node): NodePosition
Link copied to clipboard
fun computedStyleMap(): StylePropertyMapReadOnly
Link copied to clipboard
fun contains(other: Node?): Boolean
Link copied to clipboard
open fun dispatchEvent(event: Event): Boolean
Link copied to clipboard
open fun focus(options: FocusOptions)
Link copied to clipboard
open fun getAnimations(options: GetAnimationsOptions): ReadonlyArray<Animation>
Link copied to clipboard
fun getAttribute(qualifiedName: String): String?
Link copied to clipboard
fun getAttributeNames(): ReadonlyArray<JsString>
Link copied to clipboard
fun getAttributeNode(qualifiedName: String): Attr?
Link copied to clipboard
fun getAttributeNodeNS(namespace: String?, localName: String): Attr?
Link copied to clipboard
fun getAttributeNS(namespace: String?, localName: String): String?
Link copied to clipboard
fun getBoundingClientRect(): DOMRect
Link copied to clipboard
fun getClientRects(): DOMRectList
Link copied to clipboard
fun getElementsByClassName(classNames: ClassName): HTMLCollection<Element>
Link copied to clipboard
fun getElementsByTagName(qualifiedName: String): HTMLCollection<Element>
fun <T : Element> getElementsByTagName(qualifiedName: TagName<T>): HTMLCollection<T>
Link copied to clipboard
fun getElementsByTagNameNS(namespace: String?, localName: String): HTMLCollection<Element>
fun <T : Element> getElementsByTagNameNS(namespaceURI: TagNamespace<T>, localName: TagName<T>): HTMLCollection<T>
Link copied to clipboard
fun getHTML(options: GetHTMLOptions): String
Link copied to clipboard
fun getRootNode(options: GetRootNodeOptions): Node
Link copied to clipboard
fun hasAttribute(qualifiedName: String): Boolean
Link copied to clipboard
fun hasAttributeNS(namespace: String?, localName: String): Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun hasPointerCapture(pointerId: Int): Boolean
Link copied to clipboard
Link copied to clipboard
fun insertAdjacentElement(where: InsertPosition, element: Element): Element?
Link copied to clipboard
fun insertAdjacentHTML(position: InsertPosition, string: String)
fun insertAdjacentHTML(position: InsertPosition, string: TrustedHTML)
Link copied to clipboard
fun insertAdjacentText(where: InsertPosition, data: String)
Link copied to clipboard
fun <T : Node> insertBefore(node: T, child: Node?): T
Link copied to clipboard
Link copied to clipboard
fun isEqualNode(otherNode: Node?): Boolean
Link copied to clipboard
fun isSameNode(otherNode: Node?): Boolean
Link copied to clipboard
Link copied to clipboard
fun lookupPrefix(namespace: String?): String?
Link copied to clipboard
fun matches(selectors: String): Boolean
Link copied to clipboard
open fun moveBefore(node: Node, child: Node?)
Link copied to clipboard
fun normalize()
Link copied to clipboard
abstract fun open()

Opens the dropdown list.

Link copied to clipboard
open fun prepend(vararg nodes: String)
open fun prepend(vararg nodes: Node)
Link copied to clipboard
open fun querySelector(selectors: String): Element?
open fun <T : Element> querySelector(selectors: TagName<T>): T?
Link copied to clipboard
open fun querySelectorAll(selectors: String): NodeList<Element>
open fun <T : Element> querySelectorAll(selectors: TagName<T>): NodeList<T>
Link copied to clipboard
fun releasePointerCapture(pointerId: Int)
Link copied to clipboard
open fun remove()
Link copied to clipboard
fun removeAttribute(qualifiedName: String)
Link copied to clipboard
fun removeAttributeNode(attr: Attr): Attr
Link copied to clipboard
fun removeAttributeNS(namespace: String?, localName: String)
Link copied to clipboard
fun <T : Node> removeChild(child: T): T
Link copied to clipboard
fun <T : Node> replaceChild(node: Node, child: T): T
Link copied to clipboard
open fun replaceChildren()
open fun replaceChildren(vararg nodes: String)
open fun replaceChildren(vararg nodes: Node)
Link copied to clipboard
open fun replaceWith(vararg nodes: String)
open fun replaceWith(vararg nodes: Node)
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
fun requestFullscreenAsync(options: FullscreenOptions): Promise<Void>
Link copied to clipboard
fun requestPointerLockAsync(options: PointerLockOptions): Promise<Void>
Link copied to clipboard
fun scroll(options: ScrollToOptions): Promise<Void>?
fun scroll(x: Double, y: Double): Promise<Void>?
Link copied to clipboard
fun scrollBy(options: ScrollToOptions): Promise<Void>?
fun scrollBy(x: Double, y: Double): Promise<Void>?
Link copied to clipboard
fun scrollIntoView(options: ScrollIntoViewOptions): Promise<Void>?
Link copied to clipboard
fun scrollTo(options: ScrollToOptions): Promise<Void>?
fun scrollTo(x: Double, y: Double): Promise<Void>?
Link copied to clipboard
fun setAttribute(qualifiedName: String, value: String)
Link copied to clipboard
fun setAttributeNode(attr: Attr): Attr?
Link copied to clipboard
fun setAttributeNodeNS(attr: Attr): Attr?
Link copied to clipboard
fun setAttributeNS(namespace: String?, qualifiedName: String, value: String)
Link copied to clipboard
fun setHTML(html: String, options: SetHTMLOptions)
Link copied to clipboard
fun setHTMLUnsafe(html: String, options: SetHTMLUnsafeOptions)
fun setHTMLUnsafe(html: TrustedHTML, options: SetHTMLUnsafeOptions)
Link copied to clipboard
fun setPointerCapture(pointerId: Int)
Link copied to clipboard
fun showPopover(options: ShowPopoverOptions)
Link copied to clipboard
fun toggleAttribute(qualifiedName: String, force: Boolean): Boolean
Link copied to clipboard
fun togglePopover(options: TogglePopoverOptions): Boolean
Link copied to clipboard
abstract fun validate(): Boolean

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

Link copied to clipboard
fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>