Skip to contents

Create a ComboboxItem component

Usage

calcite_combobox_item(...)

Arguments

...

named attributes passed to htmltools::tag()

Value

an object of class calcite_component which is a subclass of shiny.tag

Details

Properties

The following properties are provided by this component:

NameAttributeDescriptionValuesReflects to Attribute
activeactiveWhen true, the component is active.booleanTRUE
ancestorsNASpecifies the parent and grandparent items, which are set on calcite-combobox.Check API referenceFALSE
descriptiondescriptionA description for the component, which displays below the heading.stringFALSE
disableddisabledWhen true, interaction is prevented and the component is displayed with lower opacity.booleanTRUE
filterDisabledfilter-disabledWhen true, omits the component from the calcite-combobox filtered search results.booleanTRUE
guidguidThe id attribute of the component. When omitted, a globally unique identifier is used.stringTRUE
headingheadingThe component's text.stringFALSE
iconiconSpecifies an icon to display.stringTRUE
iconFlipRtlicon-flip-rtlWhen true, the icon will be flipped when the element direction is right-to-left ("rtl").booleanTRUE
labellabelThe component's label.anyFALSE
metadataNAProvides additional metadata to the component used in filtering.Check API referenceFALSE
selectedselectedWhen true, the component is selected.booleanTRUE
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.stringFALSE
textLabeltext-labelThe component's text.stringTRUE
valuevalueThe component's value.anyFALSE

Events

The following events are observed by shiny:

EventDescription
calciteComboboxItemChangeFires whenever the component is selected or unselected.

Slots

The following slots are provided by this component:

SlotDescription
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.

Examples

calcite_combobox_item()
#> <calcite-combobox-item></calcite-combobox-item>