playwright/docs/src/locators.md

id	title
locators	Locators

[Locator]s are the central piece of Playwright's auto-waiting and retry-ability. In a nutshell, locators represent a way to find element(s) on the page at any moment.

const locator = page.getByText('Submit');
await locator.click();

Locator locator = page.getByText("Submit");
locator.click();

locator = page.get_by_text("Submit")
await locator.click()

locator = page.get_by_text("Submit")
locator.click()

var locator = page.GetByText("Submit");
await locator.ClickAsync();

Every time locator is used for some action, up-to-date DOM element is located in the page. So in the snippet below, underlying DOM element is going to be located twice, prior to every action. This means that if the DOM changes in between the calls due to re-render, the new element corresponding to the locator will be used.

const locator = page.getByText('Submit');
// ...
await locator.hover();
await locator.click();

Locator locator = page.getByText("Submit");
locator.hover();
locator.click();

locator = page.get_by_text("Submit")
await locator.hover()
await locator.click()

locator = page.get_by_text("Submit")
locator.hover()
locator.click()

var locator = page.GetByText("Submit");
await locator.HoverAsync();
await locator.ClickAsync();

Strictness

Locators are strict. This means that all operations on locators that imply some target DOM element will throw an exception if more than one element matches given selector. For example, the following call throws if there are several buttons in the DOM:

await page.getByRole('button').click();

await page.get_by_role("button").click()

page.get_by_role("button").click()

page.getByRole("button").click();

await page.GetByRole("button").ClickAsync();

On the other hand, Playwright understands when you perform a multiple-element operation, so the following call works perfectly fine when locator resolves to multiple elements.

await page.getByRole('button').count();

await page.get_by_role("button").count()

page.get_by_role("button").count()

page.getByRole("button").count();

await page.GetByRole("button").CountAsync();

You can explicitly opt-out from strictness check by telling Playwright which element to use when multiple element match, through [method: Locator.first], [method: Locator.last], and [method: Locator.nth]. These methods are not recommended because when your page changes, Playwright may click on an element you did not intend. Instead, follow best practices below to create a locator that uniquely identifies the target element.

Locating elements

Playwright comes with multiple built-in ways to create a locator. To make tests resilient, we recommend prioritizing user-facing attributes and explicit contracts, and provide dedicated methods for them, such as [method: Page.getByText]. It is often convenient to use the code generator to generate a locator, and then edit it as you'd like.

await page.getByText('Log in').click();

page.getByText("Log in").click();

await page.get_by_text("Log in").click()

page.get_by_text("Log in").click()

await page.GetByText("Log in").ClickAsync();

If you absolutely must use CSS or XPath locators, you can use [method: Page.locator] to create a locator that takes a selector describing how to find an element in the page.

Note that all methods that create a locator, such as [method: Page.getByLabel], are also available on the [Locator] and [FrameLocator] classes, so you can chain them and iteratively narrow down your locator.

const locator = page.frameLocator('#my-frame').getByText('Submit');
await locator.click();

Locator locator = page.frameLocator("#my-frame").getByText("Submit");
locator.click();

locator = page.frame_locator("#my-frame").get_by_text("Submit")
await locator.click()

locator = page.frame_locator("my-frame").get_by_text("Submit")
locator.click()

var locator = page.FrameLocator("#my-frame").GetByText("Submit");
await locator.ClickAsync();

Locate by text using [method: Page.getByText]

The easiest way to find an element is to look for the text it contains. You can match by a substring, exact string, or a regular expression.

await page.getByText('Log in').click();
await page.getByText('Log in', { exact: true }).click();
await page.getByText(/log in$/i).click();

page.getByText("Log in").click();
page.getByText("Log in", new Page.GetByTextOptions().setExact(true)).click();
page.getByText(Pattern.compile("log in$", Pattern.CASE_INSENSITIVE)).click();

await page.get_by_text("Log in").click()
await page.get_by_text("Log in", exact=True).click()
await page.get_by_text(re.compile("Log in", re.IGNORECASE)).click()

page.get_by_text("Log in").click()
page.get_by_text("Log in", exact=True).click()
page.get_by_text(re.compile("Log in", re.IGNORECASE)).click()

await page.GetByText("Log in").ClickAsync();
await page.GetByText("Log in", new() { Exact: true }).ClickAsync();
await page.GetByText(new Regex("Log in", RegexOptions.IgnoreCase)).ClickAsync();

You can also filter by text when locating in some other way, for example find a particular item in the list.

await page.getByTestId('product-item').filter({ hasText: 'Playwright Book' }).click();

page.getByTestId("product-item").filter(new Locator.FilterOptions().setHasText("Playwright Book")).click();

await page.get_by_test_id("product-item").filter(has_text="Playwright Book").click()

page.get_by_test_id("product-item").filter(has_text="Playwright Book").click()

await page.GetByTestId("product-item").Filter(new() { HasText = "Playwright Book" }).ClickAsync();

:::note Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace. :::

Locate based on accessible attributes with [method: Page.getByRole]

The [method: Page.getByRole] locator reflects how users and assistive technology percieve the page, for example whether some element is a button or a checkbox. When locating by role, you should usually pass the accessible name as well, so that locator pinpoints the exact element.

await page.getByRole('button', { name: /submit/i }).click();

await page.getByRole('checkbox', { checked: true, name: "Check me" }).check();

await page.get_by_role("button", name=re.compile("submit", re.IGNORECASE)).click()

await page.get_by_role("checkbox", checked=True, name="Check me"]).check()

page.get_by_role("button", name=re.compile("submit", re.IGNORECASE)).click()

page.get_by_role("checkbox", checked=True, name="Check me"]).check()

page.getByRole("button", new Page.GetByRoleOptions().setName(Pattern.compile("submit", Pattern.CASE_INSENSITIVE))).click();

page.getByRole("checkbox", new Page.GetByRoleOptions().setChecked(true).setName("Check me"))).check();

await page.GetByRole("button", new() { Name = new Regex("submit", RegexOptions.IgnoreCase) }).ClickAsync();

await page.GetByRole("checkbox", new() { Checked = true, Name = "Check me" }).CheckAsync();

Role locators follow W3C specificaitons for ARIA role, ARIA attributes and accessible name.

Note that role locators do not replace accessibility audits and conformance tests, but rather give early feedback about the ARIA guidelines.

Define explicit contract and use [method: Page.getByTestId]

User-facing attributes like text or accessible name can change over time. In this case it is convenient to define explicit test ids.

<button data-testid="directions">Itinéraire</button>

await page.getByTestId('directions').click();

page.getByTestId("directions").click();

await page.get_by_test_id('directions').click()

page.get_by_test_id('directions').click()

await page.GetByTestId("directions").ClickAsync();

By default, [method: Page.getByTestId] will locate elements baed on the data-testid attribute, but you can configure it in your test config or calling [method: Selectors.setTestIdAttribute].

Locate by label text with [method: Page.getByLabel]

Most form controls usually have dedicated labels that could be conveniently used to interact with the form. In this case, you can locate the control by its associated label.

For example, consider the following DOM structure.

<label for="password">Password:</label><input type="password">

You can fill the input after locating it by the label text:

await page.getByLabel('Password').fill('secret');

page.getByLabel("Password").fill("secret");

await page.get_by_label("Password").fill("secret")

page.get_by_label("Password").fill("secret")

await page.GetByLabel("Password").FillAsync("secret");

Locate in a subtree

You can chain methods that create a locator, like [method: Page.getByText] or [method: Locator.getByRole], to narrow down the search to a particular part of the page.

For example, consider the following DOM structure:

<div data-testid='product-card'>
  <span>Product 1</span>
  <button>Buy</button>
</div>
<div data-testid='product-card'>
  <span>Product 2</span>
  <button>Buy</button>
</div>

For example, we can first find a product card that contains text "Product 2", and then click the button in this specific product card.

const product = page.getByTestId('product-card').filter({ hasText: 'Product 2' });

await product.getByText('Buy').click();

product = page.get_by_test_id("product-card").filter(has_text="Product 2")

await product.getByText("Buy").click()

product = page.get_by_test_id("product-card").filter(has_text="Product 2")

product.get_by_text("Buy").click()

Locator product = page.getByTestId("product-card").filter(new Locator.FilterOptions().setHasText("Product 2"));

product.get_by_text("Buy").click();

var product = page.GetByTestId("product-card").Filter(new() { HasText = "Product 2" });

await product.GetByText("Buy").clickAsync();

Locate by CSS or XPath selector

Playwright supports CSS and XPath selectors, and auto-detects them if you omit css= or xpath= prefix. Use [method: Page.locator] for this:

await page.locator('css=button').click();
await page.locator('xpath=//button').click();

await page.locator('button').click();
await page.locator('//button').click();

page.locator("css=button").click();
page.locator("xpath=//button").click();

page.locator("button").click();
page.locator("//button").click();

await page.locator("css=button").click()
await page.locator("xpath=//button").click()

await page.locator("button").click()
await page.locator("//button").click()

page.locator("css=button").click()
page.locator("xpath=//button").click()

page.locator("button").click()
page.locator("//button").click()

await page.Locator('css=button').ClickAsync();
await page.Locator('xpath=//button').ClickAsync();

await page.Locator('button').ClickAsync();
await page.Locator('//button').ClickAsync();

XPath and CSS selectors can be tied to the DOM structure or implementation. These selectors can break when the DOM structure changes. Long CSS or XPath chains below are an example of a bad practice that leads to unstable tests:

await page.locator('#tsf > div:nth-child(2) > div.A8SBwf > div.RNNXgb > div > div.a4bIc > input').click();

await page.locator('//*[@id="tsf"]/div[2]/div[1]/div[1]/div/div[2]/input').click();

page.locator("#tsf > div:nth-child(2) > div.A8SBwf > div.RNNXgb > div > div.a4bIc > input").click();

page.locator("//*[@id='tsf']/div[2]/div[1]/div[1]/div/div[2]/input").click();

await page.locator("#tsf > div:nth-child(2) > div.A8SBwf > div.RNNXgb > div > div.a4bIc > input").click()

await page.locator("//*[@id="tsf"]/div[2]/div[1]/div[1]/div/div[2]/input").click()

page.locator("#tsf > div:nth-child(2) > div.A8SBwf > div.RNNXgb > div > div.a4bIc > input").click()

page.locator("//*[@id="tsf"]/div[2]/div[1]/div[1]/div/div[2]/input").click()

await page.Locator("#tsf > div:nth-child(2) > div.A8SBwf > div.RNNXgb > div > div.a4bIc > input").ClickAsync();

await page.Locator("//*[@id='tsf']/div[2]/div[1]/div[1]/div/div[2]/input").ClickAsync();

Instead, try to come up with a locator that is close to how user perceives the page or define an explicit testing contract.

Locate elements that contain other elements

Filter by text

Locator can be optionally filtered by text. It will search for a particular string somewhere inside the element, possibly in a descendant element, case-insensitively. You can also pass a regular expression.

await page.getByTestId('product-card').filter({ hasText: 'Product 3' }).click();
await page.getByTestId('product-card').filter({ hasText: /product 3/ }).click();

page.getByTestId("product-card").filter(new Locator.FilterOptions().setHasText("Product 3")).click();
page.getByTestId("product-card").filter(new Locator.FilterOptions().setHasText(Pattern.compile("Product 3"))).click();

await page.get_by_test_id("product-card").filter(has_text="Product 3").click()
await page.get_by_test_id("product-card").filter(has_text=re.compile("Product 3")).click()

page.get_by_test_id("product-card").filter(has_text="Product 3").click()
page.get_by_test_id("product-card").filter(has_text=re.compile("Product 3")).click()

await page.GetByTestId("product-card").Filter(new() { HasText = "Product 3" }).ClickAsync();
await page.GetByTestId("product-card").Filter(new() { HasText = new Regex("Product 3") }).ClickAsync();

Filter by another locator

Locators support an option to only select elements that have a descendant matching another locator.

page.getByRole('section').filter({ has: page.getByTestId('subscribe-button') })

page.getByRole("section").filter(new Locator.FilterOptions().setHas(page.getByTestId("subscribe-button")))

page.get_by_role("section"), has=page.get_by_test_id("subscribe-button"))

page.get_by_role("section"), has=page.get_by_test_id("subscribe-button"))

page.GetByRole("section"), new() { Has = page.GetByTestId("subscribe-button") })

Note that inner locator is matched starting from the outer one, not from the document root.

Augment an existing locator

You can filter an existing locator by text or another one, using [method: Locator.filter] method, possibly chaining it multiple times.

const rowLocator = page.locator('tr');
// ...
await rowLocator
    .filter({ hasText: 'text in column 1' })
    .filter({ has: page.getByRole('button', { name: 'column 2 button' }) })
    .screenshot();

Locator rowLocator = page.locator("tr");
// ...
rowLocator
    .filter(new Locator.FilterOptions().setHasText("text in column 1"))
    .filter(new Locator.FilterOptions().setHas(
        page.getByRole("button", new Page.GetByRoleOptions().setName("column 2 button"))
    ))
    .screenshot();

row_locator = page.locator("tr")
# ...
await row_locator
    .filter(has_text="text in column 1")
    .filter(has=page.get_by_role("button", name="column 2 button"))
    .screenshot()

row_locator = page.locator("tr")
# ...
row_locator
    .filter(has_text="text in column 1")
    .filter(has=page.get_by_role("button", name="column 2 button"))
    .screenshot()

var rowLocator = page.Locator("tr");
// ...
await rowLocator
    .Filter(new LocatorFilterOptions { HasText = "text in column 1" })
    .Filter(new LocatorFilterOptions {
        Has = page.GetByRole("button", new() { Name = "column 2 button" } )
    })
    .ScreenshotAsync();

Locate elements in Shadow DOM

All locators in Playwright by default work with elements in Shadow DOM. The exceptions are:

• Locating by XPath does not pierce shadow roots.
• Closed-mode shadow roots are not supported.

Consider the following example with a custom web component:

<x-details role=button aria-expanded=true aria-controls=inner-details>
  <div>Title</div>
  #shadow-root
    <div id=inner-details>Details</div>
</x-details>

You can locate in the same way as if the shadow root was not present at all.

• Click <div>Details</div>

  await page.getByText('Details').click();
  

  page.getByText("Details").click();
  

  await page.get_by_text("Details").click()
  

  page.get_by_text("Details").click()
  

  await page.GetByText("Details").ClickAsync();
  

• Click <x-details>

  await page.locator('x-details', { hasText: 'Details' }).click();
  

  page.locator("x-details", new Page.LocatorOptions().setHasText("Details")).click();
  

  await page.locator("x-details", has_text="Details" ).click()
  

  page.locator("x-details", has_text="Details" ).click()
  

  await page.Locator("x-details", new() { HasText = "Details" }).ClickAsync();
  

• Ensure that <x-details> contains text "Details"

  await expect(page.locator('x-details')).toContainText('Details');
  

  assertThat(page.locator("x-details")).containsText("Details");
  

  await expect(page.locator("x-details")).to_contain_text("Details")
  

  expect(page.locator("x-details")).to_contain_text("Details")
  

  await Expect(page.Locator("x-details")).ToContainTextAsync("Details");
  

Lists

You can also use locators to work with the element lists.

// Locate elements, this locator points to a list.
const rows = page.getByRole('listitem');

// Pattern 1: use locator methods to calculate text on the whole list.
const texts = await rows.allTextContents();

// Pattern 2: do something with each element in the list.
const count = await rows.count()
for (let i = 0; i < count; ++i)
  console.log(await rows.nth(i).textContent());

// Pattern 3: resolve locator to elements on page and map them to their text content.
// Note: the code inside evaluateAll runs in page, you can call any DOM apis there.
const texts = await rows.evaluateAll(list => list.map(element => element.textContent));

# Locate elements, this locator points to a list.
rows = page.get_by_role("listitem")

# Pattern 1: use locator methods to calculate text on the whole list.
texts = await rows.all_text_contents()

# Pattern 2: do something with each element in the list.
count = await rows.count()
for i in range(count):
  print(await rows.nth(i).text_content())

# Pattern 3: resolve locator to elements on page and map them to their text content.
# Note: the code inside evaluateAll runs in page, you can call any DOM apis there.
texts = await rows.evaluate_all("list => list.map(element => element.textContent)")

# Locate elements, this locator points to a list.
rows = page.get_by_role("listitem")

# Pattern 1: use locator methods to calculate text on the whole list.
texts = rows.all_text_contents()

# Pattern 2: do something with each element in the list.
count = rows.count()
for i in range(count):
  print(rows.nth(i).text_content())

# Pattern 3: resolve locator to elements on page and map them to their text content.
# Note: the code inside evaluateAll runs in page, you can call any DOM apis there.
texts = rows.evaluate_all("list => list.map(element => element.textContent)")

// Locate elements, this locator points to a list.
Locator rows = page.getByRole("listitem");

// Pattern 1: use locator methods to calculate text on the whole list.
List<String> texts = rows.allTextContents();

// Pattern 2: do something with each element in the list.
int count = rows.count()
for (int i = 0; i < count; ++i)
  System.out.println(rows.nth(i).textContent());

// Pattern 3: resolve locator to elements on page and map them to their text content.
// Note: the code inside evaluateAll runs in page, you can call any DOM apis there.
Object texts = rows.evaluateAll("list => list.map(element => element.textContent)");

// Locate elements, this locator points to a list.
var rows = page.GetByRole("listitem");

// Pattern 1: use locator methods to calculate text on the whole list.
var texts = await rows.AllTextContentsAsync();

// Pattern 2: do something with each element in the list:
var count = await rows.CountAsync()
for (let i = 0; i < count; ++i)
  Console.WriteLine(await rows.Nth(i).TextContentAsync());

// Pattern 3: resolve locator to elements on page and map them to their text content
// Note: the code inside evaluateAll runs in page, you can call any DOM apis there
var texts = await rows.EvaluateAllAsync("list => list.map(element => element.textContent)");

Picking specific element from a list

If you have a list of identical elements, and the only way to distinguish between them is the order, you can choose a specific element from a list with [method: Locator.first], [method: Locator.last] or [method: Locator.nth].

For example, to click the third item in the list of products:

await page.getByTestId('product-card').nth(3).click();

page.getByTestId("product-card").nth(3).click();

await page.get_by_test_id("product-card").nth(3).click()

page.get_by_test_id("product-card").nth(3).click()

await page.GetByTestId("product-card").Nth(3).ClickAsync();

However, use these methods with caution. Often times, the page might change, and locator will point to a completely different element from the one you expected. Instead, try to come up with a unique locator that will pass the strictness criteria.