Selectors are strings that point to the elements in the page. They are used to perform actions on those elements by means of methods such as page.click(selector[, options]), page.fill(selector, value[, options]) and alike. All those methods accept
selector as their first argument.
- Quick guide
- Text selector
- CSS selector
- Selecting visible elements
- Selecting elements that contain other elements
- Selecting elements matching one of the conditions
- Selecting elements in Shadow DOM
- Selecting elements based on layout
- XPath selectors
- id, data-testid, data-test-id, data-test selectors
- Pick n-th match from the query result
- Chaining selectors
- Best practices
Text selectorawait page.click('text=Log in');
CSS selectorawait page.click('button');await page.click('#nav-bar .contact-us-item');
Select by attribute, with css selectorawait page.click('[data-test=login-button]');await page.click('[aria-label="Sign in"]');
Combine css and text selectorsawait page.click('article:has-text("Playwright")');await page.click('#nav-bar :text("Contact us")');
Element that contains another, with css selectorawait page.click('.item-description:has(.item-promo-banner)');
Selecting based on layout, with css selectorawait page.click('input:right-of(:text("Username"))');
Only visible elements, with css selectorawait page.click('.login-button:visible');
Pick n-th matchawait page.click(':nth-match(:text("Buy"), 3)');
XPath selectorawait page.click('xpath=//button');
Text selector locates elements that contain passed text.
Text selector has a few variations:
text=Log in- default matching is case-insensitive and searches for a substring. For example,
<button>Log in</button>.await page.click('text=Log in');
text="Log in"- text body can be escaped with single or double quotes to search for a text node with exact content. For example,
text="Log"does not match
<button>contains a single text node
"Log in"that is not equal to
<button>contains a text node
Quoted body follows the usual escaping rules, e.g. use
\"to escape double quote in a double-quoted string:
text="foo\"bar".await page.click('text="Log in"');
"Log in"- selector starting and ending with a quote (either
') is assumed to be a text selector. For example,
"Log in"is converted to
text="Log in"internally.await page.click('"Log in"');
/symbols. For example,
<button>log IN</button>.await page.click('text=/Log\\s*in/i');
:has-text()pseudo-class can be used inside a css selector. It matches any element containing specified text somewhere inside, possibly in a child or a descendant element. For example,
:has-text()should be used together with other
cssspecifiers, otherwise it will match all the elements containing specified text, including the
<body>.// Wrong, will match many elements including <body>await page.click(':has-text("Playwright")');// Correct, only matches the <article> elementawait page.click('article:has-text("Playwright")');
#nav-bar :text("Home")- the
:text()pseudo-class can be used inside a css selector. It matches the smallest element containing specified text. This example is equivalent to
text=Home, but inside the
#nav-barelement.await page.click('#nav-bar :text("Home")');
#nav-bar :text-is("Home")- the
:text-is()pseudo-class can be used inside a css selector, for strict text node match. This example is equivalent to
text="Home"(note quotes), but inside the
#nav-bar :text-matches("reg?ex", "i")- the
:text-matches()pseudo-class can be used inside a css selector, for regex-based match. This example is equivalent to
text=/reg?ex/i, but inside the
Matching always normalizes whitespace, for example it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace.
Input elements of the type
submit are matched by their
value instead of text content. For example,
text=Log in matches
<input type=button value="Log in">.
Playwright augments standard CSS selectors in two ways:
cssengine pierces open shadow DOM by default.
- Playwright adds custom pseudo-classes like
:visible pseudo-class in CSS selectors matches the elements that are visible. For example,
input matches all the inputs on the page, while
input:visible matches only visible inputs. This is useful to distinguish elements that are very similar but differ in visibility.
It's usually better to follow the best practices and find a more reliable way to uniquely identify the element.
Consider a page with two buttons, first invisible and second visible.
This will find the first button, because it is the first one in DOM order. Then it will wait for the button to become visible before clicking, or timeout while waiting:await page.click('button');
This will find a second button, because it is visible, and then click it.await page.click('button:visible');
:visible with caution, because it has two major drawbacks:
- When elements change their visibility dynamically,
:visiblewill give unpredictable results based on the timing.
:visibleforces a layout and may lead to querying being slow, especially when used with
:has() pseudo-class is an experimental CSS pseudo-class. It returns an element if any of the selectors passed as parameters relative to the :scope of the given element match at least one element.
Following snippet returns text content of an
<article> element that has a
<div class=promo> inside.
:is() pseudo-class is an experimental CSS pseudo-class. It is a function that takes a selector list as its argument, and selects any element that can be selected by one of the selectors in that list. This is useful for writing large selectors in a more compact form.
text engines pierce the Shadow DOM by default:
- First they search for the elements in the light DOM in the iteration order, and
- Then they search recursively inside open shadow roots in the iteration order.
In particular, in
css engine, any Descendant combinator or Child combinator pierces an arbitrary number of open shadow roots, including the implicit descendant combinator at the start of the selector. It does not search inside closed shadow roots or iframes.
If you'd like to opt-out of this behavior, you can use
:light CSS extension or
text:light selector engine. They do not pierce shadow roots.
More advanced Shadow DOM use cases:
":light(article div)"match the first
<div>In the light dom</div>.
"article > div"and
":light(article > div)"match two
divelements that are direct children of the
"article .in-the-shadow"matches the
<div class='in-the-shadow'>, piercing the shadow root, while
":light(article .in-the-shadow)"does not match anything.
":light(article div > span)"does not match anything, because both light-dom
divelements do not contain a
"article div > span"matches the
<span class='content'>, piercing the shadow root.
"article > .in-the-shadow"does not match anything, because
<div class='in-the-shadow'>is not a direct child of
":light(article > .in-the-shadow)"does not match anything.
"article li#target"matches the
<li id='target'>Deep in the shadow</li>, piercing two shadow roots.
Playwright can select elements based on the page layout. These can be combined with regular CSS for better results, for example
input:right-of(:text("Password")) matches an input field that is to the right of text "Password".
Layout selectors depend on the page layout and may produce unexpected results. For example, a different element could be matched when layout changes by one pixel.
Layout selectors use bounding client rect to compute distance and relative position of the elements.
:right-of(inner > selector)- Matches elements that are to the right of any element matching the inner selector.
:left-of(inner > selector)- Matches elements that are to the left of any element matching the inner selector.
:above(inner > selector)- Matches elements that are above any of the elements matching the inner selector.
:below(inner > selector)- Matches elements that are below any of the elements matching the inner selector.
:near(inner > selector)- Matches elements that are near (within 50 CSS pixels) any of the elements matching the inner selector.
All layout selectors support optional maximum pixel distance as the last argument. For example
button:near(:text("Username"), 120) matches a button that is at most 120 pixels away from the element with the text "Username".
XPath selectors are equivalent to calling
Selector starting with
.. is assumed to be an xpath selector. For example, Playwright converts
xpath does not pierce shadow roots
Playwright supports a shorthand for selecting elements using certain attributes. Currently, only the following attributes are supported:
Attribute selectors pierce shadow DOM. To opt-out from this behavior, use
:light suffix after attribute, for example `page.click('data-test-id:light=submit')
Sometimes page contains a number of similar elements, and it is hard to select a particular one. For example:
In this case,
:nth-match(:text("Buy"), 3) will select the third button from the snippet above. Note that index is one-based.
:nth-match() is also useful to wait until a specified number of elements appear, using page.waitForSelector(selector[, options]).
:nth-child(), elements do not have to be siblings, they could be anywhere on the page. In the snippet above, all three buttons match
:text("Buy") selector, and
:nth-match() selects the third button.
Selectors defined as
engine=body or in short-form can be combined with the
>> token, e.g.
selector1 >> selector2 >> selectors3. When selectors are chained, next one is queried relative to the previous one's result.
If a selector needs to include
>> in the body, it should be escaped inside a string to not be confused with chaining separator, e.g.
text="some >> text".
By default, chained selectors resolve to an element queried by the last selector. A selector can be prefixed with
* to capture elements that are queried by an intermediate selector.
css=article >> text=Hello captures the element with the text
*css=article >> text=Hello (note the
*) captures the
article element that contains some element with the text
The choice of selectors determines the resiliency of automation scripts. To reduce the maintenance burden, we recommend prioritizing user-facing attributes and explicit contracts.
Attributes like text content, input placeholder, accessibility roles and labels are user-facing attributes that change rarely. These attributes are not impacted by DOM structure changes.