ComboBoxItem
<ui5-cb-item>
The ui5-cb-item represents the item for a ui5-combobox.
Properties
additionalText
| Description | Defines the additional text of the component. |
| Type | string | undefined |
| Default | undefined |
| Since | 1.0.0-rc.11 |
text
| Description | Defines the text of the component. |
| Type | string | undefined |
| Default | undefined |
value
| Description | Defines the value of the ui5-cb-item.
Use this property to associate a unique identifier or machine-readable value with the item, separate from the display text. This enables:
- Selecting items programmatically via selectedValue on the ComboBox
- Submitting machine-readable values in forms
- Distinguishing between items with identical display text
When to use:
- Recommended: Use the value property on items together with selectedValue on the ComboBox when you need unique identifiers
- Omit value if the display text (text property) is sufficient for your use case
Example: html <ui5-combobox selected-value="DE"> <ui5-cb-item text="Germany" value="DE"></ui5-cb-item> <ui5-cb-item text="France" value="FR"></ui5-cb-item> </ui5-combobox> |
| Type | string | undefined |
| Default | undefined |
| Since | 2.20.0 |
Slots
No slots available for this component.
Events
click
| Description | Fired when the component is activated either with a mouse/tap or by using the Enter or Space key.
Note: The event will not be fired if the disabled property is set to true. |
| Type | CustomEvent<ListItemBaseClickEventDetail> |
| Parameters | item: ListItemBase
The activated item.
originalEvent: Event
The original event from the user interaction. |
| Since | 2.22.0 |
| Bubbles | Yes |
| Cancelable | No |
Methods
No methods available for this component.
CSS Parts
No CSS parts available for this component.
CSS Custom States
No CSS custom states available for this component.