ComboBoxElement
Playwright element wrapper for <vaadin-combo-box>. Provides helpers to open the overlay, filter items, and pick items by visible text, along with aria/placeholder/validation mixins.
Component Tag
vaadin-combo-box
Implements
FocusableElementHasAriaLabelElementHasInputFieldElementHasPrefixElementHasThemeElementHasPlaceholderElementHasEnabledElementHasTooltipElementHasValidationPropertiesElementHasClearButtonElementHasAllowedCharPatternElement
Factory Methods
getByLabel (Page)
public static ComboBoxElement getByLabel(Page page, String label)
ComboBoxElement by its label. Uses ARIA role COMBOBOX.
The accessible label of the field
ComboBoxElement
getByLabel (Locator)
public static ComboBoxElement getByLabel(Locator locator, String label)
ComboBoxElement by its label within a given scope.
The locator to search within
The accessible label of the field
ComboBoxElement
Constructor
ComboBoxElement
public ComboBoxElement(Locator locator)
ComboBoxElement.
The locator for the <vaadin-combo-box> element
Methods
selectItem
public void selectItem(String item)
Label of the item to select
filterAndSelectItem
public void filterAndSelectItem(String filter, String item)
Text to type for filtering
Label of the item to select
setFilter
public void setFilter(String filter)
pressSequentially to fire keyboard events that the ComboBox listens to for filtering.
getFilter
public String getFilter()
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()
getValue
@Override
public String getValue()
value property, so this reads the displayed text from the input element instead.
Returns: The displayed value or empty string when nothing is selected
assertValue
@Override
public void assertValue(String expected)
Expected label or empty string for no selection
isReadOnly
public boolean isReadOnly()
true when read-only
assertReadOnly
public void assertReadOnly()
assertNotReadOnly
public void assertNotReadOnly()
public Locator getToggleButtonLocator()
public void clickToggleButton()
getOverlayItemCount
public int getOverlayItemCount()
assertItemCount
public void assertItemCount(int expected)
getFocusLocator
@Override
public Locator getFocusLocator()
getAriaLabelLocator
@Override
public Locator getAriaLabelLocator()
getEnabledLocator
@Override
public Locator getEnabledLocator()
Usage Examples
Basic Selection
ComboBoxElement comboBox = ComboBoxElement.getByLabel(page, "Sort by");
comboBox.assertVisible();
comboBox.selectItem("Rating: high to low");
comboBox.assertValue("Rating: high to low");
Filter and Select
ComboBoxElement comboBox = ComboBoxElement.getByLabel(page, "Filterable ComboBox");
comboBox.filterAndSelectItem("Apr", "Apricot");
comboBox.assertValue("Apricot");
Open/Close Overlay
ComboBoxElement comboBox = ComboBoxElement.getByLabel(page, "Filterable ComboBox");
comboBox.assertClosed();
comboBox.open();
comboBox.assertOpened();
comboBox.close();
comboBox.assertClosed();
Item Count
ComboBoxElement comboBox = ComboBoxElement.getByLabel(page, "Filterable ComboBox");
comboBox.open();
comboBox.assertItemCount(9);
comboBox.close();
Clear Selection
ComboBoxElement comboBox = ComboBoxElement.getByLabel(page, "ComboBox with placeholder and clear button");
comboBox.selectItem("Most recent first");
comboBox.assertValue("Most recent first");
comboBox.clickClearButton();
comboBox.assertValue("");
Read-Only State
ComboBoxElement comboBox = ComboBoxElement.getByLabel(page, "Read-only ComboBox");
comboBox.assertVisible();
comboBox.assertReadOnly();
comboBox.assertValue("Banana");
Validation
ComboBoxElement comboBox = ComboBoxElement.getByLabel(page, "ComboBox with theme");
comboBox.assertValid();
ButtonElement.getByText(page, "Validate").click();
comboBox.assertInvalid();
assertThat(comboBox.getErrorMessageLocator()).hasText("Required field");
Lazy Loading with Filter
ComboBoxElement comboBox = ComboBoxElement.getByLabel(page, "Lazy ComboBox");
comboBox.filterAndSelectItem("Item 250", "Item 250");
comboBox.assertValue("Item 250");
// Verify filtering narrows results
comboBox.setFilter("Item 500");
comboBox.assertItemCount(1);
comboBox.close();
Custom Value Entry
ComboBoxElement comboBox = ComboBoxElement.getByLabel(page, "Custom value ComboBox");
comboBox.getInputLocator().fill("Custom entry");
comboBox.getInputLocator().press("Enter");
assertThat(page.locator("#custom-value-display")).hasText("Custom entry");