VaadinElement Specification

For the authoritative method list and signatures, see the auto-generated api-reference.md. This file focuses on behaviour and usage that signatures alone don't convey.

Overview

VaadinElement is the abstract base class for all typed Playwright wrappers around Vaadin components. It exposes common helpers such as clicking, visibility assertions, text retrieval and generic DOM property access. Concrete components add component-specific APIs on top of this.

Class Hierarchy

Every public element wrapper extends VaadinElement, most of them directly. The exceptions share a base with a sibling:

VaadinElement (abstract)
    ├── TextFieldElement
    │     ├── EmailFieldElement
    │     ├── PasswordFieldElement
    │     └── TextAreaElement
    ├── AbstractNumberFieldElement
    │     ├── IntegerFieldElement
    │     └── NumberFieldElement
    ├── AbstractLoginElement
    │     ├── LoginFormElement
    │     └── LoginOverlayElement
    ├── GridElement
    │     └── TreeGridElement
    └── … every other wrapper

The complete, generated list of wrappers, with the tag each one wraps and its factory methods, is the Element index.

Implemented Interfaces

Interface	Description
HasLocatorElement	Provides access to underlying Playwright locator

API Methods

Constructor

VaadinElement(Locator locator)

Creates a new VaadinElement wrapper from a Playwright locator.

Basic Actions

Method	Description
click()	Click the component root
getText()	Get textual content of component

Locator Access

Method	Description
getLocator()	Get the underlying Playwright Locator

Property Access

Method	Description
setProperty(String name, Object value)	Set a DOM property
getProperty(String name)	Get a DOM property value

Visibility

Method	Description
isVisible()	Whether component is visible
isHidden()	Whether component is hidden
assertVisible()	Assert component is visible
assertHidden()	Assert component is hidden

Usage Examples

Basic Usage

// All element classes extend VaadinElement
ButtonElement button = ButtonElement.getByText(page, "Save");

// Common methods available
button.click();
String text = button.getText();

Visibility Checks

DialogElement dialog = new DialogElement(page);

// Check visibility
if (dialog.isVisible()) {
    dialog.click();
}

// Assert visibility
dialog.assertVisible();
dialog.assertHidden();

Property Access

TextFieldElement field = TextFieldElement.getByLabel(page, "Name");

// Set DOM property
field.setProperty("value", "John");

// Get DOM property
Object disabled = field.getProperty("disabled");

Locator Access

CardElement card = CardElement.getByTitle(page, "Product");

// Get underlying locator for custom operations
Locator locator = card.getLocator();
locator.screenshot();
locator.evaluate("el => el.scrollIntoView()");

Extending VaadinElement

To create a new element wrapper:

@PlaywrightElement(MyElement.FIELD_TAG_NAME)
public class MyElement extends VaadinElement {

    public static final String FIELD_TAG_NAME = "my-component";

    public MyElement(Locator locator) {
        super(locator);
    }

    // Add component-specific methods
    public void doSomething() {
        getLocator().locator(".internal").click();
    }
}

Related Interfaces

Elements add behaviour by implementing shared mixin interfaces, such as HasEnabledElement, HasValueElement or HasThemeElement. The full, generated list with every default method is Shared mixins. Two choices need care:

• HasEnabledElement or HasDisabledAttributeElement: use the second when the host's ARIA role is one Playwright does not treat as disableable (see pitfall 7 in AGENTS.md).
• HasLocatorElement is the base of every mixin: it provides getLocator() and waitAfterAction().