Child component of Autocomplete

API reference

Properties

PropertyAttributeDescriptionTypeDefault
descriptiondescription

Specifies a description for the component. Displays below the label.

string | undefined
disableddisabled

When true, interaction is prevented and the component is displayed with lower opacity.

booleanfalse
headingrequiredheading

Specifies the component's heading text.

string
iconEndicon-end

Specifies an icon to display at the end of the component.

IconName | undefined
iconFlipRtlicon-flip-rtl

Displays the iconStart and/or iconEnd as flipped when the element direction is right-to-left ("rtl").

FlipContext | undefined
iconStarticon-start

Specifies an icon to display at the start of the component.

IconName | undefined
labellabel

Specifies an accessible label for the component.

string | undefined
selectedselected

When true, the component is selected. The parent calcite-autocomplete synchronizes this property with its non-empty value; declarative selection is preserved when no initial value is provided, but is cleared when a controlled value is explicitly reset.

booleanfalse
valuevalue

Specifies the component's value.

string

Slots

NameDescription
content-end

A slot for adding non-actionable elements after content of the component.

content-start

A slot for adding non-actionable elements before content of the component.

Styles

NameDescription
--calcite-autocomplete-background-color

Specifies the component's background color.

--calcite-autocomplete-description-text-color

Specifies the text color of the component's description.

--calcite-autocomplete-heading-text-color

Specifies the text color of the component's heading.

--calcite-autocomplete-text-color

Specifies the component's text color.

Events

NameDescriptionBehavior
calciteAutocompleteItemSelect

Fires when selection is requested.

bubblescomposed

Methods

NameDescriptionSignature
componentOnReady

Creates a promise that resolves once the component is fully loaded.

componentOnReady(): Promise<this>

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