MultiSelectComboBoxElement
<vaadin-multi-select-combo-box> is a web component that wraps <vaadin-combo-box> and extends its functionality to allow selecting multiple items, in addition to basic features.
<vaadin-multi-select-combo-box id="comboBox"></vaadin-multi-select-combo-box>const comboBox = document.querySelector('#comboBox');
comboBox.items = ['apple', 'banana', 'lemon', 'orange'];
comboBox.selectedItems = ['lemon', 'orange'];Styling
The following shadow DOM parts are available for styling:
| Part name | Description |
|---|---|
chips | The element that wraps slotted chips for selected items |
label | The label element |
input-field | The element that wraps prefix, value and suffix |
field-button | Set on both clear and toggle buttons |
clear-button | The clear button |
error-message | The error message element |
helper-text | The helper text element wrapper |
required-indicator | The required state indicator element |
toggle-button | The toggle button |
overlay | The overlay container |
content | The overlay content |
loader | The loading indicator shown while loading items |
The following state attributes are available for styling:
| Attribute | Description |
|---|---|
disabled | Set to a disabled element |
has-value | Set when the element has a value |
has-label | Set when the element has a label |
has-helper | Set when the element has helper text or slot |
has-error-message | Set when the element has an error message |
has-tooltip | Set when the element has a slotted tooltip |
invalid | Set when the element is invalid |
focused | Set when the element is focused |
focus-ring | Set when the element is keyboard focused |
loading | Set when loading items from the data provider |
opened | Set when the dropdown is open |
readonly | Set to a readonly element |
The following custom CSS properties are available for styling:
| Custom CSS property |
|---|
--vaadin-chip-background |
--vaadin-chip-border-color |
--vaadin-chip-border-radius |
--vaadin-chip-border-width |
--vaadin-chip-font-size |
--vaadin-chip-font-weight |
--vaadin-chip-gap |
--vaadin-chip-height |
--vaadin-chip-padding |
--vaadin-chip-remove-button-text-color |
--vaadin-chip-text-color |
--vaadin-field-default-width |
--vaadin-input-field-background |
--vaadin-input-field-border-color |
--vaadin-input-field-border-radius |
--vaadin-input-field-border-width |
--vaadin-input-field-bottom-end-radius |
--vaadin-input-field-bottom-start-radius |
--vaadin-input-field-button-text-color |
--vaadin-input-field-container-gap |
--vaadin-input-field-disabled-background |
--vaadin-input-field-disabled-text-color |
--vaadin-input-field-error-color |
--vaadin-input-field-error-font-size |
--vaadin-input-field-error-font-weight |
--vaadin-input-field-error-line-height |
--vaadin-input-field-gap |
--vaadin-input-field-helper-color |
--vaadin-input-field-helper-font-size |
--vaadin-input-field-helper-font-weight |
--vaadin-input-field-helper-line-height |
--vaadin-input-field-label-color |
--vaadin-input-field-label-font-size |
--vaadin-input-field-label-font-weight |
--vaadin-input-field-label-line-height |
--vaadin-input-field-padding |
--vaadin-input-field-placeholder-color |
--vaadin-input-field-required-indicator |
--vaadin-input-field-required-indicator-color |
--vaadin-input-field-top-end-radius |
--vaadin-input-field-top-start-radius |
--vaadin-input-field-value-color |
--vaadin-input-field-value-font-size |
--vaadin-input-field-value-font-weight |
--vaadin-input-field-value-line-height |
--vaadin-item-overlay-padding |
--vaadin-multi-select-combo-box-chip-min-width |
--vaadin-multi-select-combo-box-chips-gap |
--vaadin-multi-select-combo-box-input-min-width |
--vaadin-multi-select-combo-box-overlay-max-height |
--vaadin-multi-select-combo-box-overlay-width |
Internal components
In addition to <vaadin-multi-select-combo-box> itself, the following internal components are themable:
<vaadin-multi-select-combo-box-chip><vaadin-multi-select-combo-box-item>- has the same API as<vaadin-item>.
See Styling Components documentation.
Properties
A space-separated list of IDs referencing the elements that describe the component for screen reader users. The referenced elements are announced in addition to the helper text and the error message.
String used to label the component for screen reader users.
A space-separated list of IDs referencing the elements that label the component for screen reader users.
When true, the user can input a value that is not present in the items list.
A pattern matched against individual characters the user inputs.
Set to true to auto expand horizontally, causing input field to grow until max width is reached.
Set to true to not collapse selected items chips into the overflow chip and instead always expand vertically, causing input field to wrap into multiple lines when width is limited.
Set true to prevent the overlay from opening automatically.
If true, the input text gets fully selected when the field is focused using click or touch / tap.
Set to true to display the clear icon which clears the input. This also enables clearing the input when pressing Esc key.
Set to true to collapse all selected items chips into the overflow chip when they don't all fit, instead of showing as many as possible. Has no effect when autoExpandVertically is true.
Function that provides items lazily. Receives arguments params, callback
Error to show when the field is invalid.
A subset of items, filtered based on the user input. Filtered items can be assigned directly to omit the internal filtering functionality. The items can be of either String or Object type.
String used for the helper text.
A function used to generate CSS class names for dropdown items and selected chips based on the item. The return value should be the generated class name as a string, or multiple class names separated by whitespace characters.
Path for the id of the item. If items is an array of objects, the itemIdPath is used to compare and identify the same item in the selection and in filteredItems (items given by the dataProvider callback).
A function that is used to generate the label for dropdown items based on the item. Receives one argument:
Path for label of the item. If items is an array of objects, the itemLabelPath is used to fetch the displayed string label for each item.
Path for the value of the item. If items is an array of objects, the itemValuePath: is used to fetch the string value for the selected item.
When true, filter string isn't cleared after selecting an item.
Set to true to enable manual validation mode. This mode disables automatic constraint validation, allowing you to control the validation process yourself. You can still trigger constraint validation manually with the validate() method or use checkValidity() to assess the component's validity without affecting the invalid state. In manual validation mode, you can also manipulate the invalid property directly through your application logic without conflicts with the component's internal validation.
Controls which item is automatically set to be selected, for example on Enter, when the typed filter only partially matches its label. The item that will be selected is highlighted in the dropdown while typing:
A hint to the user of what can be entered in the field.
Custom function for rendering the content of every item. Receives three arguments:
The list of selected items. Note: modifying the selected items creates a new array each time.
Set to true to group selected items at the top of the overlay.
Functions
Returns true if the field value satisfies all constraints (if any).
Clears the cached pages and reloads data from dataprovider when needed.
Requests an update for the content of items. While performing the update, it invokes the renderer (passed in the renderer property) once an item.