Playwright supports multiple selector engines used to query elements in the web page.
Selector is a string that consists of one or more clauses separated by
>> token, e.g.
clause1 >> clause2 >> clause3. When multiple clauses are present, next one is queried relative to the previous one's result.
Each clause contains a selector engine name and selector body, e.g.
engine is one of the supported engines (e.g.
css or a custom one). Selector
body follows the format of the particular engine, e.g. for
css engine it should be a css selector. Body format is assumed to ignore leading and trailing white spaces, so that extra whitespace can be added for readability. If selector engine needs to include
>> in the body, it should be escaped inside a string to not be confused with clause separator, e.g.
text="some >> text".
is equivalent to
Selector engine name can be prefixed with
* to capture element that matches the particular clause instead of the last one. For example,
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
For convenience, selectors in the wrong format are heuristically converted to the right format:
- Selector starting with
//is assumed to be
page.click('//html')is converted to
- Selector starting and ending with a quote (either
') is assumed to be
page.click('"foo"')is converted to
- Otherwise, selector is assumed to be
page.click('div')is converted to
css is a default engine - any malformed selector not starting with
// nor starting and ending with a quote is assumed to be a css selector. For example, Playwright converts
page.$('span > button') to
page.$('css=span > button').
css:light engine is equivalent to
Document.querySelector and behaves according to the CSS spec. However, it does not pierce shadow roots, which may be inconvenient when working with Shadow DOM and Web Components. For that reason,
css engine pierces shadow roots. More specifically, every Descendant combinator pierces an arbitrary number of open shadow roots, including the implicit descendant combinator at the start of the selector.
css engine first searches for elements in the light dom in the iteration order, and then recursively inside open shadow roots in the iteration order. It does not search inside closed shadow roots or iframes.
<open mode shadow root> is not an html element, but rather a shadow root created with
"css:light=article div"match the first
<div>In the light dom</div>.
"css=article > div"and
"css:light=article > div"match two
divelements that are direct children of the
"css=article .in-the-shadow"matches the
<div class='in-the-shadow'>, piercing the shadow root, while
"css:light=article .in-the-shadow"does not match anything.
"css:light=article div > span"does not match anything, because both light-dom
divelements do not contain a
"css=article div > span"matches the
<span class='content'>, piercing the shadow root.
"css=article > .in-the-shadow"does not match anything, because
<div class='in-the-shadow'>is not a direct child of
"css:light=article > .in-the-shadow"does not match anything.
"css=article li#target"matches the
<li id='target'>Deep in the shadow</li>, piercing two shadow roots.
XPath engine is equivalent to
Malformed selector starting with
// is assumed to be an xpath selector. For example, Playwright converts
xpath does not pierce shadow roots.
Text engine finds an element that contains a text node with the passed text. For example,
page.click('text=Login') clicks on a login button, and
page.waitForSelector('"lazy loaded text") waits for the
"lazy loaded text" to appear in the page.
- By default, the match is case-insensitive, ignores leading/trailing whitespace and searches for a substring. This means
<button>Button loGIN (click me)</button>.
- Text body can be escaped with single or double quotes for precise matching, insisting on exact match, including specified whitespace and case. This means
text="Login "will only match
<button>Login </button>with exactly one space after "Login". Quoted text follows the usual escaping rules, e.g. use
\"to escape double quote in a double-quoted string:
/symbols. This means
<button> loGIN</button>with any number of spaces before "Login" and no spaces after.
- Input elements of the type
submitare rendered with their value as text, and text engine finds them. For example,
<input type=button value="Login">.
Malformed selector starting and ending with a quote (either
') is assumed to be a text selector. For example, Playwright converts
text engine open pierces shadow roots similarly to
text:light does not. Text engine first searches for elements in the light dom in the iteration order, and then recursively inside open shadow roots in the iteration order. It does not search inside closed shadow roots or iframes.
Attribute engines are selecting based on the corresponding attribute value. For example:
data-test-id=foo is equivalent to
id:light=foo is equivalent to