Combobox Item

Child component of Combobox

API reference

Properties

PropertyAttributeDescriptionTypeDefault
activeactiveWhen true, the component is active.booleanfalse
ancestorsSpecifies the parent and grandparent items, which are set on calcite-combobox.Array<HTMLCalciteComboboxItemElement | HTMLCalciteComboboxItemGroupElement>
descriptiondescriptionA description for the component, which displays below the heading.string
disableddisabledWhen true, interaction is prevented and the component is displayed with lower opacity.booleanfalse
filterDisabledfilter-disabledWhen true, omits the component from the calcite-combobox filtered search results.booleanfalse
guidguidThe id attribute of the component. When omitted, a globally unique identifier is used.string
headingheadingThe component's text.string
iconiconSpecifies an icon to display.string
iconFlipRtlicon-flip-rtlWhen true, the icon will be flipped when the element direction is right-to-left ("rtl").booleanfalse
labellabelThe component's label.any
metadataProvides additional metadata to the component used in filtering.{ [x: string]: unknown; }
selectedselectedWhen true, the component is selected.booleanfalse
shortHeadingshort-headingThe component's short heading. When provided, the short heading will be displayed in the component's selection. It is recommended to use 5 characters or fewer.string
textLabeltext-label
deprecatedUse heading instead.
The component's text.
string
valuerequiredvalueThe component's value.any

Slots

NameDescription
default (unnamed)A slot for adding nested calcite-combobox-items.
content-endA slot for adding non-actionable elements after the component's content.
content-startA slot for adding non-actionable elements before the component's content.

Events

NameDescriptionBehavior
calciteComboboxItemChangeFires whenever the component is selected or unselected.bubblescomposed

Methods

NameDescriptionSignature
componentOnReadyCreate a promise that resolves once component is fully loaded.componentOnReady(): Promise<void>

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close