Locators

Role Locator in Playwright

Role Locator in Playwright: definition, detailed explanation, practical usage, examples, mistakes, interview notes, and practice for Playwright automation.

Definition and Brief Explanation

Definition: A role locator finds elements by their accessibility role and accessible name, such as button, link, heading, checkbox, or textbox.

Explanation: Role locators are usually the best first choice because they match how users and assistive technologies understand the page. If a button is named Save, getByRole("button", { name: "Save" }) targets the actual button, not just any text that says Save.

Why It Matters

  • It makes tests easier to read because the locator describes the target element clearly.
  • It reduces flaky failures caused by layout changes or generated CSS classes.
  • It works with Playwright auto-waiting, so actions and assertions wait for the element state.
  • It supports maintainable Page Object Model code because selectors are meaningful.

How It Works

  1. Identify the element by user-facing meaning first: role, label, text, placeholder, alt text, or title.
  2. Confirm the locator points to the intended element and is unique when used for an action.
  3. Use filters, chaining, or test ids when the page has repeated controls.
  4. Avoid positional locators unless order is the behavior being tested.

Syntax and Examples

Example 1: Button by role

await page.getByRole('button', { name: 'Submit' }).click();

Explanation: Finds a button by accessible role and name. This is usually the best locator for buttons.

Example 2: Heading by role

await expect(page.getByRole('heading', { name: 'Dashboard' })).toBeVisible();

Explanation: Verifies that a visible heading named Dashboard exists.

Common Mistakes

  • Using generated CSS classes as the first option.
  • Using broad text that appears in many places.
  • Adding nth() only to silence strict mode.
  • Storing element handles instead of using locators.

Interview Notes

  1. What is a Role Locator in Playwright?
  2. When would you choose Role Locator?
  3. How do you make the locator unique?
  4. What makes this locator stable or unstable?

Practice Task

Create a small Playwright example for Role Locator. Add one positive assertion, one note about what can go wrong, and one improvement that would make the test more maintainable.

☰