> Markdown version of [Multi-Select Combo Box](https://vaadin.com/docs/v23/components/multi-select-combo-box). Section index: [llms.txt](https://vaadin.com/docs/v23/components/llms.txt)

# Multi-Select Combo Box (since V23.2)

Multi-Select Combo Box allows the user to choose one or more values from a filterable list of options presented in an overlay. The component [supports the same features as the regular Combo Box](https://vaadin.com/docs/v23/components/combo-box.md), such as lazy loading or allowing custom typed values.

**TypeScript** — `multi-select-combo-box-basic.ts`

```typescript
@state()
private items: Country[] = [];

protected override async firstUpdated() {
  this.items = await getCountries();
}

protected override render() {
  return html`
    <vaadin-multi-select-combo-box
      label="Countries"
      item-label-path="name"
      item-id-path="id"
      .items="${this.items}"
    ></vaadin-multi-select-combo-box>
  `;
}
```

**TypeScript** — `Country.ts`

```typescript
/**
 * This module is generated from com.vaadin.demo.domain.Country.
 * All changes to this file are overridden. Consider editing the corresponding Java file if necessary.
 * @see {@link file:///srv/jenkins/workspace/docs/docs-site-v23/docs/src/main/java/com/vaadin/demo/domain/Country.java}
 */
export default interface Country {
  name: string;
  abbreviation: string;
  id: number;
}
```

**Java** — `MultiSelectComboBoxBasic.java`

```java
MultiSelectComboBox<Country> comboBox = new MultiSelectComboBox<>(
        "Countries");
comboBox.setItems(DataService.getCountries());
comboBox.setItemLabelGenerator(Country::getName);
add(comboBox);
```

**Java** — `Country.java`

```java
public class Country {

    @Nonnull
    private String name;

    @Nonnull
    private String abbreviation;

    @Nonnull
    private Integer id;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getAbbreviation() {
        return abbreviation;
    }

    public void setAbbreviation(String abbreviation) {
        this.abbreviation = abbreviation;
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    @Override
    public int hashCode() {
        return id;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof Country)) {
            return false;
        }
        Country other = (Country) obj;
        return id == other.id;
    }
}
```

The overlay opens when the user clicks the field using a pointing device. Using the `Up` and `Down`arrow keys or typing a character (that occurs in at least one of the options) when the field is focused also opens the popup.

## <a id="common-combo-box-features"></a>Common Combo Box Features

Multi-Select Combo Box supports the following features from the regular Combo Box. All the linked examples and code snippets can be applied by replacing the Combo Box with a Multi-Select Combo Box.

- [Custom Value Entry](https://vaadin.com/docs/v23/components/combo-box.md#custom-value-entry)

- [Custom Item Presentation](https://vaadin.com/docs/v23/components/combo-box.md#custom-item-representation)

- [Auto Open](https://vaadin.com/docs/v23/components/combo-box.md#auto-open)

- [Placeholder](https://vaadin.com/docs/v23/components/combo-box.md#placeholder)

- [Custom Filtering](https://vaadin.com/docs/v23/components/combo-box.md#custom-filtering)

- [Popup Width](https://vaadin.com/docs/v23/components/combo-box.md#popup-width), using the `--vaadin-multi-select-combo-box-overlay-width` style, instead of `--vaadin-combo-box-overlay-width`

## <a id="selection"></a>Selection

The component allows selecting multiple values, each of which is displayed as a chip inside the component. If there isn’t enough space in the component to display chips for all selected values, then some values are collapsed into an overflow chip. The example below shows a Multi-Select Combo Box with multiple preselected values, some of which are collapsed into the overflow chip:

**TypeScript** — `multi-select-combo-box-selection.ts`

```html
<vaadin-multi-select-combo-box
  label="Countries"
  item-label-path="name"
  item-id-path="id"
  .items="${this.items}"
  .selectedItems="${this.items.slice(0, 4)}"
></vaadin-multi-select-combo-box>
```

**TypeScript** — `Country.ts`

```typescript
/**
 * This module is generated from com.vaadin.demo.domain.Country.
 * All changes to this file are overridden. Consider editing the corresponding Java file if necessary.
 * @see {@link file:///srv/jenkins/workspace/docs/docs-site-v23/docs/src/main/java/com/vaadin/demo/domain/Country.java}
 */
export default interface Country {
  name: string;
  abbreviation: string;
  id: number;
}
```

**Java** — `MultiSelectComboBoxSelection.java`

```java
comboBox.select(countries.subList(0, 4));
```

**Java** — `Country.java`

```java
public class Country {

    @Nonnull
    private String name;

    @Nonnull
    private String abbreviation;

    @Nonnull
    private Integer id;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getAbbreviation() {
        return abbreviation;
    }

    public void setAbbreviation(String abbreviation) {
        this.abbreviation = abbreviation;
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    @Override
    public int hashCode() {
        return id;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof Country)) {
            return false;
        }
        Country other = (Country) obj;
        return id == other.id;
    }
}
```

When the overlay is closed, items can be removed one by one (starting with the most recently selected item) using the `Backspace` key. The first `Backspace` press moves focus to the last chip; the second press removes that chip, and the corresponding item, from the selection.

### <a id="selection-change"></a>Selection Change

The following example demonstrates how to listen for selection changes:

Use the `selected-items-changed` event to react to the user changing the selection.

**TypeScript** — `multi-select-combo-box-selection-change.ts`

```typescript
@state()
private selectedCountries: Country[] = [];

private get selectedCountriesText(): string {
  return this.selectedCountries.map((country) => country.name).join(', ');
}

protected override render() {
  return html`
    <vaadin-horizontal-layout theme="spacing">
      <vaadin-multi-select-combo-box
        label="Countries"
        item-label-path="name"
        item-id-path="id"
        .items="${this.items}"
        .selectedItems="${this.selectedCountries}"
        @selected-items-changed="${(e: MultiSelectComboBoxSelectedItemsChangedEvent<Country>) => {
          this.selectedCountries = e.detail.value;
        }}"
      ></vaadin-multi-select-combo-box>
      <vaadin-text-area
        label="Selected Countries"
        readonly
        .value="${this.selectedCountriesText}"
      ></vaadin-text-area>
    </vaadin-horizontal-layout>
  `;
}
```

**TypeScript** — `Country.ts`

```typescript
/**
 * This module is generated from com.vaadin.demo.domain.Country.
 * All changes to this file are overridden. Consider editing the corresponding Java file if necessary.
 * @see {@link file:///srv/jenkins/workspace/docs/docs-site-v23/docs/src/main/java/com/vaadin/demo/domain/Country.java}
 */
export default interface Country {
  name: string;
  abbreviation: string;
  id: number;
}
```

Use `addValueChangeListener()` to be notified about the user changing the selection. Alternatively `addSelectionChangeListener()` can be used to get more detailed information about the selection change.

**Java** — `MultiSelectComboBoxSelectionChange.java`

```java
TextArea selectedCountries = new TextArea("Selected Countries");
selectedCountries.setReadOnly(true);

comboBox.addValueChangeListener(e -> {
    String selectedCountriesText = e.getValue().stream()
            .map(Country::getName).collect(Collectors.joining(", "));

    selectedCountries.setValue(selectedCountriesText);
});
```

**Java** — `Country.java`

```java
public class Country {

    @Nonnull
    private String name;

    @Nonnull
    private String abbreviation;

    @Nonnull
    private Integer id;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getAbbreviation() {
        return abbreviation;
    }

    public void setAbbreviation(String abbreviation) {
        this.abbreviation = abbreviation;
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    @Override
    public int hashCode() {
        return id;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof Country)) {
            return false;
        }
        Country other = (Country) obj;
        return id == other.id;
    }
}
```

## <a id="read-only"></a>Read-Only

The component can be set to read-only, which prevents the user from modifying its value. A read-only Multi-Select Combo Box still allows opening the overlay, which then shows only the selected values, instead of all the options. This can be useful if selected values have been collapsed into the overflow chip.

**TypeScript** — `multi-select-combo-box-read-only.ts`

```html
<vaadin-multi-select-combo-box
  label="Countries"
  item-label-path="name"
  item-id-path="id"
  .items="${this.items}"
  .selectedItems="${this.items.slice(0, 4)}"
  readonly
></vaadin-multi-select-combo-box>
```

**Java** — `MultiSelectComboBoxReadOnly.java`

```java
comboBox.setReadOnly(true);
```

## <a id="internationalization-i18n"></a>Internationalization (i18n)

Multi-Select Combo Box allows localizing the following messages. These texts are only used in screen reader announcements, and can’t be observed visually.

| Message      | Default                               | Description                                                                                                                                                                                                  |
| ------------ | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `cleared`    | "Selection cleared"                   | Announced by screen readers when the clear button is clicked                                                                                                                                                 |
| `focused`    | " focused. Press Backspace to remove" | Announced by screen readers when a chip is focused                                                                                                                                                           |
| `selected`   | " added to selection"                 | Announced by screen readers when an item is added to the selection.                                                                                                                                          |
| `deselected` | " removed from selection"             | Announced by screen readers when an item is removed from the selection.                                                                                                                                      |
| `total`      | "{count} items selected"              | Announced by screen readers to inform about the total number of selected items. The string must contain a `{count}` placeholder, which is replaced with the actual count of selected items by the component. |

The following example demonstrates how to localize the component’s messages into German:

**TypeScript** — `multi-select-combo-box-i18n.ts`

```typescript
private i18n: MultiSelectComboBoxI18n = {
  cleared: 'Alle Einträge entfernt',
  focused: ' ausgewählt. Drücke Rücktaste zum Entfernen',
  selected: ' hinzugefügt',
  deselected: ' entfernt',
  total: '{count} Einträge ausgewählt',
};

protected override render() {
  return html`
    <vaadin-multi-select-combo-box
      label="Länder"
      item-label-path="name"
      item-id-path="id"
      .items="${this.items}"
      .i18n="${this.i18n}"
    ></vaadin-multi-select-combo-box>
  `;
}
```

**Java** — `MultiSelectComboBoxI18nDemo.java`

```java
MultiSelectComboBoxI18n i18n = new MultiSelectComboBoxI18n();
i18n.setCleared("Alle Einträge entfernt");
i18n.setFocused(" ausgewählt. Drücke Rücktaste zum Entfernen");
i18n.setSelected(" hinzugefügt");
i18n.setDeselected(" entfernt");
i18n.setTotal("{count} Einträge ausgewählt");

comboBox.setI18n(i18n);
```

## <a id="best-practices"></a>Best Practices

Multi-Select Combo Box supports lazy loading for large datasets. It reduces the initial load time, and consumes less bandwidth and resources.

For consistency, the default width of the Multi-Select Combo Box matches that of other input fields. You should increase the width of the component when using items with long labels, or if you expect users to select several items, to avoid collapsing selected items into the overflow chip.

Example of increasing component width

```html
<vaadin-multi-select-combo-box
  style="width: 300px"
></vaadin-multi-select-combo-box>
```

```Java
comboBox.setWidth("300px");
```

## <a id="related-components"></a>Related Components

| Component                                                            | Usage recommendations                                                                     |
| -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| [Combo Box](https://vaadin.com/docs/v23/components/combo-box.md)     | Same feature set, but for selecting a single value.                                       |
| [List Box](https://vaadin.com/docs/v23/components/list-box.md)       | Scrollable inline list of options. Supports single and multi-select.                      |
| [Checkbox Group](https://vaadin.com/docs/v23/components/checkbox.md) | Serves the same purpose in a more user-friendly format, but takes up more vertical space. |
