Combobox Item

API reference

calcite-combobox-item
v1.0.0-beta.83

Properties

PropertyAttributeDescriptionTypeValues
activeactive

True when item is highlighted either from keyboard or mouse hover

booleanA boolean property should be present, or not
truefalse
ancestors

Parent and grandparent combobox items, this is set internally for use from combobox

element(s)An element or elements
ComboboxChildElement[]
constantconstant

Don't filter this item based on the search text

booleanA boolean property should be present, or not
truefalse
disableddisabled

When true, the item cannot be clicked and is visually muted.

booleanA boolean property should be present, or not
truefalse
guidguid

Unique identifier, used for accessibility

stringA custom string
guid() (default)
iconicon

Custom icon to display both in combobox chips and next to combobox item text

optional
iconAccepts a Calcite UI Icon string
selectedselected

Set this to true to pre-select an item. Toggles when an item is checked/unchecked.

booleanA boolean property should be present, or not
truefalse
textLabeltext-label

The main label for this item.

required
stringA custom string
undefined
valuevalue

The item's associated value

required
typedChoose from a set of typed values
any

Events

NameDescriptionDetail
calciteComboboxItemChange

Emitted whenever the item is selected or unselected.

bubblescomposedcancelable
any

Methods

NameDescriptionSignatureReturns
toggleSelected

Used to toggle the selection state. By default this won't trigger an event. The first argument allows the value to be coerced, rather than swapping values.

toggleSelected(coerce?: boolean) => Promise<void>Promise<void>

Slots

NameDescription
default (unnamed)

A slot for adding nested `calcite-combobox-item`s.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.