MultiSelectComboBoxElement
Playwright element wrapper for <vaadin-multi-select-combo-box>. Provides helpers to open the overlay, filter items, select/deselect multiple items, and query selected chips.
Component Tag
vaadin-multi-select-combo-box
Implements
FocusableElementHasAriaLabelElementHasInputFieldElementHasThemeElementHasPlaceholderElementHasEnabledElementHasTooltipElementHasValidationPropertiesElementHasClearButtonElementHasAllowedCharPatternElement
Factory Methods
getByLabel (Page)
public static MultiSelectComboBoxElement getByLabel(Page page, String label)
MultiSelectComboBoxElement by its label. Uses ARIA role COMBOBOX.
The accessible label of the field
MultiSelectComboBoxElement
getByLabel (Locator)
public static MultiSelectComboBoxElement getByLabel(Locator locator, String label)
MultiSelectComboBoxElement by its label within a given scope.
The locator to search within
The accessible label of the field
MultiSelectComboBoxElement
Constructor
MultiSelectComboBoxElement
public MultiSelectComboBoxElement(Locator locator)
MultiSelectComboBoxElement.
The locator for the <vaadin-multi-select-combo-box> element
Selection Methods
selectItem
public void selectItem(String item)
Label of the item to select
deselectItem
public void deselectItem(String item)
Label of the item to deselect
selectItems
public void selectItems(String... items)
Labels of the items to select
deselectItems
public void deselectItems(String... items)
Labels of the items to deselect
filterAndSelectItem
public void filterAndSelectItem(String filter, String item)
Text to type for filtering
Label of the item to select
Filter Methods
setFilter
public void setFilter(String filter)
pressSequentially to fire keyboard events that the component listens to for filtering.
getFilter
public String getFilter()
Open/Close Methods
open
Open the combo box overlay.
close
Close the combo box overlay.
isOpened
public boolean isOpened()
true when the overlay is open
assertOpened
public void assertOpened()
assertClosed
public void assertClosed()
Value Methods
getValue
@Override
public String getValue()
selectedItems property.
Returns: Comma-separated selected values, or empty string when nothing is selected
assertValue
@Override
public void assertValue(String expected)
Expected comma-separated value or empty string for no selection
Read-Only Methods
isReadOnly
public boolean isReadOnly()
true when read-only
assertReadOnly
public void assertReadOnly()
assertNotReadOnly
public void assertNotReadOnly()
public Locator getToggleButtonLocator()
public void clickToggleButton()
Overlay Item Methods
getOverlayItemCount
public int getOverlayItemCount()
assertItemCount
public void assertItemCount(int expected)
Chip Methods
getChipLocators
public Locator getChipLocators()
getOverflowChipLocator
public Locator getOverflowChipLocator()
getSelectedItems
public List<String> getSelectedItems()
selectedItems property from the web component.
Returns: List of selected item labels
getSelectedItemCount
public int getSelectedItemCount()
selectedItems property.
Returns: Number of selected items
assertSelectedItems
public void assertSelectedItems(String... expected)
assertSelectedCount
public void assertSelectedCount(int expected)
Expected number of selected items
Component Query Methods
getOverlayItemComponent (by text)
public <T extends VaadinElement> T getOverlayItemComponent(String itemText, Class<T> type)
@PlaywrightElement and have a public constructor accepting a single Locator parameter.
Text of the overlay item to search in
The element class (e.g., ButtonElement.class)
getOverlayItemComponent (by index)
public <T extends VaadinElement> T getOverlayItemComponent(int index, Class<T> type)
@PlaywrightElement and have a public constructor accepting a single Locator parameter.
0-based visible item index
The element class (e.g., ButtonElement.class)
Locator Methods
getFocusLocator
@Override
public Locator getFocusLocator()
getAriaLabelLocator
@Override
public Locator getAriaLabelLocator()
getEnabledLocator
@Override
public Locator getEnabledLocator()
Usage Examples
Basic Multi-Selection
MultiSelectComboBoxElement comboBox = MultiSelectComboBoxElement.getByLabel(page, "Fruits");
comboBox.assertVisible();
comboBox.selectItems("Apple", "Cherry");
comboBox.close();
comboBox.assertSelectedCount(2);
Deselection
MultiSelectComboBoxElement comboBox = MultiSelectComboBoxElement.getByLabel(page, "Fruits");
comboBox.selectItems("Apple", "Cherry");
comboBox.close();
comboBox.assertSelectedCount(2);
comboBox.deselectItem("Apple");
comboBox.close();
comboBox.assertSelectedCount(1);
Filter and Select
MultiSelectComboBoxElement comboBox = MultiSelectComboBoxElement.getByLabel(page, "Filterable MultiSelect");
comboBox.filterAndSelectItem("Apr", "Apricot");
comboBox.close();
comboBox.assertSelectedCount(1);
Clear Selection
MultiSelectComboBoxElement comboBox = MultiSelectComboBoxElement.getByLabel(page, "MultiSelect with placeholder and clear button");
comboBox.selectItems("Apple", "Banana");
comboBox.close();
comboBox.assertSelectedCount(2);
comboBox.clickClearButton();
comboBox.assertSelectedCount(0);
Verify Selected Items
MultiSelectComboBoxElement comboBox = MultiSelectComboBoxElement.getByLabel(page, "Fruits");
comboBox.selectItems("Apple", "Cherry");
comboBox.close();
assertTrue(comboBox.getSelectedItems().contains("Apple"));
assertTrue(comboBox.getSelectedItems().contains("Cherry"));
comboBox.assertSelectedCount(2);
Lazy Loading
MultiSelectComboBoxElement comboBox = MultiSelectComboBoxElement.getByLabel(page, "Lazy MultiSelect");
comboBox.filterAndSelectItem("Item 250", "Item 250");
comboBox.close();
comboBox.assertSelectedCount(1);
assertThat(page.locator("#lazy-selected-value")).hasText("Item 250");
Custom Renderer with Components
MultiSelectComboBoxElement comboBox = MultiSelectComboBoxElement.getByLabel(page, "Custom renderer");
comboBox.open();
ButtonElement button = comboBox.getOverlayItemComponent("Apple", ButtonElement.class);
button.assertVisible();
assertThat(button.getLocator()).hasText("Info Apple");
// Click the button inside an item
ButtonElement bananaButton = comboBox.getOverlayItemComponent("Banana", ButtonElement.class);
bananaButton.click();
assertThat(page.locator("#custom-renderer-output")).hasText("Clicked: Banana");
Read-Only State
MultiSelectComboBoxElement comboBox = MultiSelectComboBoxElement.getByLabel(page, "Read-only MultiSelect");
comboBox.assertVisible();
comboBox.assertReadOnly();
comboBox.assertSelectedCount(2);
Validation
MultiSelectComboBoxElement comboBox = MultiSelectComboBoxElement.getByLabel(page, "MultiSelect with theme");
comboBox.assertValid();
ButtonElement.getByText(page, "Validate").click();
comboBox.assertInvalid();
assertThat(comboBox.getErrorMessageLocator()).hasText("Required field");