diff --git a/docs/src/api/class-elementhandle.md b/docs/src/api/class-elementhandle.md index 21683c3d30..4c9e8075ea 100644 --- a/docs/src/api/class-elementhandle.md +++ b/docs/src/api/class-elementhandle.md @@ -375,7 +375,7 @@ Optional event-specific initialization properties. Returns the return value of [`param: expression`]. The method finds an element matching the specified selector in the `ElementHandle`s subtree and passes it as a first -argument to [`param: expression`]. See [Working with selectors](../selectors.md) for more +argument to [`param: expression`]. See [Working with selectors](../locators.md#selectors) for more details. If no elements match the selector, the method throws an error. If [`param: expression`] returns a [Promise], then [`method: ElementHandle.evalOnSelector`] would wait for the promise to resolve and return its @@ -436,7 +436,7 @@ Returns the return value of [`param: expression`]. The method finds all elements matching the specified selector in the `ElementHandle`'s subtree and passes an array of matched elements as a first argument to [`param: expression`]. See -[Working with selectors](../selectors.md) for more details. +[Working with selectors](../locators.md#selectors) for more details. If [`param: expression`] returns a [Promise], then [`method: ElementHandle.evalOnSelectorAll`] would wait for the promise to resolve and return its value. @@ -669,7 +669,7 @@ Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - returns: <[null]|[ElementHandle]> The method finds an element matching the specified selector in the `ElementHandle`'s subtree. See -[Working with selectors](../selectors.md) for more details. If no elements match the selector, +[Working with selectors](../locators.md#selectors) for more details. If no elements match the selector, returns `null`. ### param: ElementHandle.querySelector.selector = %%-query-selector-%% @@ -683,7 +683,7 @@ returns `null`. - returns: <[Array]<[ElementHandle]>> The method finds all elements matching the specified selector in the `ElementHandle`s subtree. See -[Working with selectors](../selectors.md) for more details. If no elements match the selector, +[Working with selectors](../locators.md#selectors) for more details. If no elements match the selector, returns empty array. ### param: ElementHandle.querySelectorAll.selector = %%-query-selector-%% diff --git a/docs/src/api/class-frame.md b/docs/src/api/class-frame.md index 12a4a7d109..ef2a2f9bba 100644 --- a/docs/src/api/class-frame.md +++ b/docs/src/api/class-frame.md @@ -449,7 +449,7 @@ the flaky tests. Use [`method: Locator.evaluate`], other [Locator] helper method ::: The method finds an element matching the specified selector within the frame and passes it as a first argument to -[`param: expression`]. See [Working with selectors](../selectors.md) for more details. If no +[`param: expression`]. See [Working with selectors](../locators.md#selectors) for more details. If no elements match the selector, the method throws an error. If [`param: expression`] returns a [Promise], then [`method: Frame.evalOnSelector`] would wait for the promise to resolve and return its @@ -514,7 +514,7 @@ In most cases, [`method: Locator.evaluateAll`], other [Locator] helper methods a ::: The method finds all elements matching the specified selector within the frame and passes an array of matched elements -as a first argument to [`param: expression`]. See [Working with selectors](../selectors.md) for +as a first argument to [`param: expression`]. See [Working with selectors](../locators.md#selectors) for more details. If [`param: expression`] returns a [Promise], then [`method: Frame.evalOnSelectorAll`] would wait for the promise to resolve and return its @@ -1222,7 +1222,7 @@ The use of [ElementHandle] is discouraged, use [Locator] objects and web-first a ::: The method finds an element matching the specified selector within the frame. See -[Working with selectors](../selectors.md) for more details. If no elements match the selector, +[Working with selectors](../locators.md#selectors) for more details. If no elements match the selector, returns `null`. ### param: Frame.querySelector.selector = %%-query-selector-%% @@ -1245,7 +1245,7 @@ The use of [ElementHandle] is discouraged, use [Locator] objects instead. ::: The method finds all elements matching the specified selector within the frame. See -[Working with selectors](../selectors.md) for more details. If no elements match the selector, +[Working with selectors](../locators.md#selectors) for more details. If no elements match the selector, returns empty array. ### param: Frame.querySelectorAll.selector = %%-query-selector-%% diff --git a/docs/src/api/class-playwright.md b/docs/src/api/class-playwright.md index ca1e866ddd..f8d0be43ed 100644 --- a/docs/src/api/class-playwright.md +++ b/docs/src/api/class-playwright.md @@ -233,7 +233,7 @@ Exposes API that can be used for the Web API testing. - type: <[Selectors]> Selectors can be used to install custom selector engines. See -[Working with selectors](../selectors.md) for more information. +[Working with selectors](../locators.md#selectors) for more information. ## property: Playwright.webkit * since: v1.8 diff --git a/docs/src/api/class-selectors.md b/docs/src/api/class-selectors.md index 51241b070d..cc79568b3d 100644 --- a/docs/src/api/class-selectors.md +++ b/docs/src/api/class-selectors.md @@ -1,7 +1,7 @@ # class: Selectors * since: v1.8 -Selectors can be used to install custom selector engines. See [Working with selectors](../selectors.md) for more +Selectors can be used to install custom selector engines. See [Working with selectors](../locators.md#selectors) for more information. ## async method: Selectors.register diff --git a/docs/src/api/params.md b/docs/src/api/params.md index f976220672..19670aca87 100644 --- a/docs/src/api/params.md +++ b/docs/src/api/params.md @@ -52,19 +52,19 @@ Whether to bypass the [actionability](../actionability.md) checks. Defaults to ` - `selector` <[string]> A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See -[working with selectors](../selectors.md) for more details. +[working with selectors](../locators.md#selectors) for more details. ## input-source - `source` <[string]> A selector to search for an element to drag. If there are multiple elements satisfying the selector, the first will be used. See -[working with selectors](../selectors.md) for more details. +[working with selectors](../locators.md#selectors) for more details. ## input-target - `target` <[string]> A selector to search for an element to drop onto. If there are multiple elements satisfying the selector, the first will be used. See -[working with selectors](../selectors.md) for more details. +[working with selectors](../locators.md#selectors) for more details. ## input-position - `position` <[Object]> @@ -130,12 +130,12 @@ Whether to check or uncheck the checkbox. ## query-selector - `selector` <[string]> -A selector to query for. See [working with selectors](../selectors.md) for more details. +A selector to query for. See [working with selectors](../locators.md#selectors) for more details. ## find-selector - `selector` <[string]> -A selector to use when resolving DOM element. See [working with selectors](../selectors.md) for more details. +A selector to use when resolving DOM element. See [working with selectors](../locators.md#selectors) for more details. ## wait-for-selector-state - `state` <[WaitForSelectorState]<"attached"|"detached"|"visible"|"hidden">> diff --git a/docs/src/ci-intro-js.md b/docs/src/ci-intro-js.md index 9d81c35843..ec6c8c363f 100644 --- a/docs/src/ci-intro-js.md +++ b/docs/src/ci-intro-js.md @@ -7,13 +7,13 @@ When installing Playwright you are given the option to add a [GitHub Actions](ht **What you will learn:** -- [How to use GitHub Actions to run your tests](#github-actions) -- [How to create a repo and push to GitHub](#create-a-repo-and-push-to-github) -- [How to open the workflows](#opening-the-workflows) -- [How to view the test logs](#viewing-test-logs) -- [How to download the report from GitHub](#downloading-the-html-report) -- [How to view the report](#viewing-the-html-report) -- [How to view the trace](#viewing-the-trace) +- [How to use GitHub Actions to run your tests](./ci-intro.md#github-actions) +- [How to create a repo and push to GitHub](./ci-intro.md#create-a-repo-and-push-to-github) +- [How to open the workflows](./ci-intro.md#opening-the-workflows) +- [How to view the test logs](./ci-intro.md#viewing-test-logs) +- [How to download the report from GitHub](./ci-intro.md#downloading-the-html-report) +- [How to view the report](./ci-intro.md#viewing-the-html-report) +- [How to view the trace](./ci-intro.md#viewing-the-trace) ## GitHub Actions @@ -111,5 +111,5 @@ To learn more about running tests on CI check out our detailed guide on [Continu ## What's Next - [Learn how to use Web First Assertions](/test-assertions.md) -- [Learn how to use Selectors](/selectors.md) - [Learn how to use Locators](/locators.md) +- [Learn how to use Selectors](/locators.md#selectors) diff --git a/docs/src/debug.md b/docs/src/debug.md index 970fc2b23b..411672301b 100644 --- a/docs/src/debug.md +++ b/docs/src/debug.md @@ -3,7 +3,7 @@ id: debug title: "Debugging Tests" --- -The Playwright inspector is a great tool to help with debugging. It opens up a browser window highlighting the selectors as you step through each line of the test. You can also use the explore button to find other available [selectors](./selectors.md) which you can then copy into your test file and rerun your tests to see if it passes. For debugging selectors, see [here](./debug-selectors.md). +The Playwright inspector is a great tool to help with debugging. It opens up a browser window highlighting the selectors as you step through each line of the test. You can also use the explore button to find other available [selectors](./locators.md#selectors) which you can then copy into your test file and rerun your tests to see if it passes. For debugging selectors, see [here](./debug-selectors.md). ## Playwright Inspector @@ -104,7 +104,7 @@ Using `PWDEBUG=console` will configure the browser for debugging in Developer to - **Runs headed**: Browsers always launch in headed mode - **Disables timeout**: Sets default timeout to 0 (= no timeout) - **Console helper**: Configures a `playwright` object in the browser to generate and highlight - [Playwright selectors](./selectors.md). This can be used to verify text or + [Playwright selectors](./locators.md#selectors). This can be used to verify text or composite selectors. ```bash tab=bash-bash lang=js @@ -198,7 +198,7 @@ pwsh bin/Debug/netX/playwright.ps1 codegen wikipedia.org ### Stepping through the Playwright script -The Inspector opens up a browser window highlighting the selectors as you step through each line of the test. Use the explore button to find other available [selectors](./selectors.md) which you can then copy into your test file and rerun your tests to see if they pass. +The Inspector opens up a browser window highlighting the selectors as you step through each line of the test. Use the explore button to find other available [selectors](./locators.md#selectors) which you can then copy into your test file and rerun your tests to see if they pass. Paused on line diff --git a/docs/src/getting-started-vscode-js.md b/docs/src/getting-started-vscode-js.md index b33fb4158f..5c409329a2 100644 --- a/docs/src/getting-started-vscode-js.md +++ b/docs/src/getting-started-vscode-js.md @@ -83,7 +83,7 @@ To record a test click on the record icon. This will create a `test-1.spec.ts` f ### Selector Highlighting -As you interact with the page Codegen will generate the test for you in the newly created file in VS Code. When you hover over an element Playwright will highlight the element and show the [selector](./selectors.md) underneath it. +As you interact with the page Codegen will generate the test for you in the newly created file in VS Code. When you hover over an element Playwright will highlight the element and show the [selector](./locators.md#selectors) underneath it. image diff --git a/docs/src/locators.md b/docs/src/locators.md index e3018b803c..86764447f3 100644 --- a/docs/src/locators.md +++ b/docs/src/locators.md @@ -3,8 +3,9 @@ id: locators title: "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. Locator can be created with the [`method: Page.locator`] method. +[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. Locator can be created with the [`method: Page.locator`] method. + +### Using Locators ```js const locator = page.locator('text=Submit'); @@ -67,9 +68,9 @@ await locator.HoverAsync(); await locator.ClickAsync(); ``` -## Creating Locators +### Creating Locators -Use [`method: Page.locator`] method to create a locator. This method takes a selector that describes how to find an element in the page. Playwright supports many different selectors like [Text](./selectors.md#text-selector), [CSS](./selectors.md#css-selector), [XPath](./selectors.md#xpath-selectors) and many more. Learn more about available selectors and how to pick one in this [in-depth guide](./selectors.md). +Use [`method: Page.locator`] method to create a locator. This method takes a selector that describes how to find an element in the page. Playwright supports many different selectors like [Text](./text-selector), [CSS](./#css-selector), [XPath](./#xpath-selectors) and many more. Learn more about available selectors and how to pick one in this [in-depth guide](./#selectors). ```js // Find by text. @@ -126,7 +127,7 @@ await page.Locator("button.sign-up").ClickAsync(); await page.Locator("data-testid=sign-up").ClickAsync(); ``` -## Strictness +### 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 @@ -188,10 +189,10 @@ await page.Locator("button").CountAsync(); ``` :::caution -Using [`method: Locator.first`], [`method: Locator.last`], and [`method: Locator.nth`] is discouraged since it disables the concept of strictness, and as your page changes, Playwright may click on an element you did not intend. It's better to make your locator more specific. Learn more below in [Filtering Locators](#filtering-locators) and the [selectors guide](./selectors.md). +Using [`method: Locator.first`], [`method: Locator.last`], and [`method: Locator.nth`] is discouraged since it disables the concept of strictness, and as your page changes, Playwright may click on an element you did not intend. It's better to make your locator more specific. Learn more below in [Filtering Locators](#filtering-locators) and the [selectors guide](./#selectors). ::: -## Lists +### Lists You can also use locators to work with the element lists. @@ -280,7 +281,7 @@ for (let i = 0; i < count; ++i) var texts = await rows.EvaluateAllAsync("list => list.map(element => element.textContent)"); ``` -## Filtering Locators +### Filtering Locators When creating a locator, you can pass additional options to filter it. @@ -367,7 +368,7 @@ await rowLocator .ScreenshotAsync(); ``` -## Locator vs ElementHandle +### Locator vs ElementHandle :::caution We only recommend using [ElementHandle] in the rare cases when you need to perform extensive DOM traversal @@ -441,3 +442,1387 @@ var locator = page.Locator("text=Submit"); await locator.HoverAsync(); await locator.ClickAsync(); ``` +## Selectors + +Selectors are strings that are used to create [Locator]s. Locators are used to perform actions on the elements by means of methods such as [`method: Locator.click`], [`method: Locator.fill`] and alike. For debugging selectors, see [here](./debug-selectors). + +Writing good selectors is part art, part science so be sure to checkout the [Best Practices](#best-practices) section. + +### Quick guide + +- Text selector + ```js + await page.locator('text=Log in').click(); + ``` + ```java + page.locator("text=Log in").click(); + ``` + ```python async + await page.locator("text=Log in").click() + ``` + ```python sync + page.locator("text=Log in").click() + ``` + ```csharp + await page.Locator("text=Log in").ClickAsync(); + ``` + Learn more about [text selector][text]. +- CSS selector + ```js + await page.locator('button').click(); + await page.locator('#nav-bar .contact-us-item').click(); + ``` + ```java + page.locator("button").click(); + page.locator("#nav-bar .contact-us-item").click(); + ``` + ```python async + await page.locator("button").click() + await page.locator("#nav-bar .contact-us-item").click() + ``` + ```python sync + page.locator("button").click() + page.locator("#nav-bar .contact-us-item").click() + ``` + ```csharp + await page.Locator("button").ClickAsync(); + await page.Locator("#nav-bar .contact-us-item").ClickAsync(); + ``` + Learn more about [css selector][css]. +- Select by attribute, with css selector + ```js + await page.locator('[data-test=login-button]').click(); + await page.locator('[aria-label="Sign in"]').click(); + ``` + ```java + page.locator("[data-test=login-button]").click(); + page.locator("[aria-label='Sign in']").click(); + ``` + ```python async + await page.locator("[data-test=login-button]").click() + await page.locator("[aria-label='Sign in']").click() + ``` + ```python sync + page.locator("[data-test=login-button]").click() + page.locator("[aria-label='Sign in']").click() + ``` + ```csharp + await page.Locator("[data-test=login-button]").ClickAsync(); + await page.Locator("[aria-label='Sign in']").ClickAsync(); + ``` + Learn more about [css selector][css]. +- Combine css and text selectors + ```js + await page.locator('article:has-text("Playwright")').click(); + await page.locator('#nav-bar >> text=Contact Us').click(); + ``` + ```java + page.locator("article:has-text(\"Playwright\")").click(); + page.locator("#nav-bar :text(\"Contact us\")").click(); + ``` + ```python async + await page.locator("article:has-text('Playwright')").click() + await page.locator("#nav-bar :text('Contact us')").click() + ``` + ```python sync + page.locator("article:has-text('Playwright')").click() + page.locator("#nav-bar :text('Contact us')").click() + ``` + ```csharp + await page.Locator("article:has-text(\"Playwright\")").ClickAsync(); + await page.Locator("#nav-bar :text(\"Contact us\")").ClickAsync(); + ``` + Learn more about [`:has-text()` and `:text()` pseudo classes][text]. +- Element that contains another, with css selector + ```js + await page.locator('.item-description:has(.item-promo-banner)').click(); + ``` + ```java + page.locator(".item-description:has(.item-promo-banner)").click(); + ``` + ```python async + await page.locator(".item-description:has(.item-promo-banner)").click() + ``` + ```python sync + page.locator(".item-description:has(.item-promo-banner)").click() + ``` + ```csharp + await page.Locator(".item-description:has(.item-promo-banner)").ClickAsync(); + ``` + Learn more about [`:has()` pseudo class](#selecting-elements-that-contain-other-elements). +- Selecting based on layout, with css selector + ```js + await page.locator('input:right-of(:text("Username"))').click(); + ``` + ```java + page.locator("input:right-of(:text(\"Username\"))").click(); + ``` + ```python async + await page.locator("input:right-of(:text('Username'))").click() + ``` + ```python sync + page.locator("input:right-of(:text('Username'))").click() + ``` + ```csharp + await page.Locator("input:right-of(:text(\"Username\"))").ClickAsync(); + ``` + Learn more about [layout selectors](#selecting-elements-based-on-layout). +- Only visible elements, with css selector + ```js + await page.locator('.login-button:visible').click(); + ``` + ```java + page.locator(".login-button:visible").click(); + ``` + ```python async + await page.locator(".login-button:visible").click() + ``` + ```python sync + page.locator(".login-button:visible").click() + ``` + ```csharp + await page.Locator(".login-button:visible").ClickAsync(); + ``` + Learn more about [selecting visible elements](#selecting-visible-elements). +- Pick n-th match + ```js + await page.locator(':nth-match(:text("Buy"), 3)').click(); + ``` + ```java + page.locator(":nth-match(:text('Buy'), 3)").click(); + ``` + ```python async + await page.locator(":nth-match(:text('Buy'), 3)").click() + ``` + ```python sync + page.locator(":nth-match(:text('Buy'), 3)").click() + ``` + ```csharp + await page.Locator(":nth-match(:text('Buy'), 3)").ClickAsync(); + ``` + Learn more about [`:nth-match()` pseudo-class](#pick-n-th-match-from-the-query-result). +- XPath selector + ```js + await page.locator('xpath=//button').click(); + ``` + ```java + page.locator("xpath=//button").click(); + ``` + ```python async + await page.locator("xpath=//button").click() + ``` + ```python sync + page.locator("xpath=//button").click() + ``` + ```csharp + await page.Locator("xpath=//button").ClickAsync(); + ``` + Learn more about [XPath selector][xpath]. +- React selector (experimental) + ```js + await page.locator('_react=ListItem[text *= "milk" i]').click(); + ``` + ```java + page.locator("_react=ListItem[text *= 'milk' i]").click(); + ``` + ```python async + await page.locator("_react=ListItem[text *= 'milk' i]").click() + ``` + ```python sync + page.locator("_react=ListItem[text *= 'milk' i]").click() + ``` + ```csharp + await page.Locator("_react=ListItem[text *= 'milk' i]").ClickAsync(); + ``` + Learn more about [React selectors][react]. +- Vue selector (experimental) + ```js + await page.locator('_vue=list-item[text *= "milk" i]').click(); + ``` + ```java + page.locator("_vue=list-item[text *= 'milk' i]").click(); + ``` + ```python async + await page.locator("_vue=list-item[text *= 'milk' i]").click() + ``` + ```python sync + page.locator("_vue=list-item[text *= 'milk' i]").click() + ``` + ```csharp + await page.Locator("_vue=list-item[text *= 'milk' i]").ClickAsync(); + ``` + Learn more about [Vue selectors][vue]. + + + +### Text selector + +Text selector locates elements that contain passed text. + +```js +await page.locator('text=Log in').click(); +``` +```java +page.locator("text=Log in").click(); +``` +```python async +await page.locator("text=Log in").click() +``` +```python sync +page.locator("text=Log in").click() +``` +```csharp +await page.Locator("text=Log in").ClickAsync(); +``` + +Text selector has a few variations: + +- `text=Log in` - default matching is case-insensitive and searches for a substring. For example, `text=Log` matches ``. + + ```js + await page.locator('text=Log in').click(); + ``` + ```java + page.locator("text=Log in").click(); + ``` + ```python async + await page.locator("text=Log in").click() + ``` + ```python sync + page.locator("text=Log in").click() + ``` + ```csharp + await page.Locator("text=Log in").ClickAsync(); + ``` + +- `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 `` because ``, because ``. + + Quoted body follows the usual escaping rules, e.g. use `\"` to escape double quote in a double-quoted string: `text="foo\"bar"`. + + ```js + await page.locator('text="Log in"').click(); + ``` + ```java + page.locator("text='Log in'").click(); + ``` + ```python async + await page.locator("text='Log in'").click() + ``` + ```python sync + page.locator("text='Log in'").click() + ``` + ```csharp + await page.Locator("text='Log in'").ClickAsync(); + ``` + +- `"Log in"` - selector starting and ending with a quote (either `"` or `'`) is assumed to be a text selector. For example, `"Log in"` is converted to `text="Log in"` internally. + + ```js + await page.locator('"Log in"').click(); + ``` + ```java + page.locator("'Log in'").click(); + ``` + ```python async + await page.locator("'Log in'").click() + ``` + ```python sync + page.locator("'Log in'").click() + ``` + ```csharp + await page.Locator("'Log in'").ClickAsync(); + ``` + +- `/Log\s*in/i` - body can be a [JavaScript-like regex](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) wrapped in `/` symbols. For example, `text=/Log\s*in/i` matches `` and ``. + + ```js + await page.locator('text=/Log\\s*in/i').click(); + ``` + ```java + page.locator("text=/Log\\s*in/i").click(); + ``` + ```python async + await page.locator("text=/Log\s*in/i").click() + ``` + ```python sync + page.locator("text=/Log\s*in/i").click() + ``` + ```csharp + await page.Locator("text=/Log\\s*in/i").ClickAsync(); + ``` + +- `article:has-text("Playwright")` - the `: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. Matching is case-insensitive and searches for a substring. For example, `article:has-text("Playwright")` matches `
Playwright
`. + + Note that `:has-text()` should be used together with other `css` specifiers, otherwise it will match all the elements containing specified text, including the ``. + ```js + // Wrong, will match many elements including + await page.locator(':has-text("Playwright")').click(); + // Correct, only matches the
element + await page.locator('article:has-text("Playwright")').click(); + ``` + + ```java + // Wrong, will match many elements including + page.locator(":has-text(\"Playwright\")").click(); + // Correct, only matches the
element + page.locator("article:has-text(\"Playwright\")").click(); + ``` + + ```python async + # Wrong, will match many elements including + await page.locator(':has-text("Playwright")').click() + # Correct, only matches the
element + await page.locator('article:has-text("Playwright")').click() + ``` + ```python sync + # Wrong, will match many elements including + page.locator(':has-text("Playwright")').click() + # Correct, only matches the
element + page.locator('article:has-text("All products")').click() + ``` + + ```csharp + // Wrong, will match many elements including + await page.Locator(":has-text(\"Playwright\")").ClickAsync(); + // Correct, only matches the
element + await page.Locator("article:has-text(\"Playwright\")").ClickAsync(); + ``` + +- `#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-bar` element. + + ```js + await page.locator('#nav-bar :text("Home")').click(); + ``` + ```java + page.locator("#nav-bar :text('Home')").click(); + ``` + ```python async + await page.locator("#nav-bar :text('Home')").click() + ``` + ```python sync + page.locator("#nav-bar :text('Home')").click() + ``` + ```csharp + await page.Locator("#nav-bar :text('Home')").ClickAsync(); + ``` + +- `#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` element. + +* `#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 `#nav-bar` element. + +:::note +Matching always normalizes whitespace. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace. +::: + +:::note +Input elements of the type `button` and `submit` are matched by their `value` instead of text content. For example, `text=Log in` matches ``. +::: + +### CSS selector + +Playwright augments standard CSS selectors in two ways: +* `css` engine pierces open shadow DOM by default. +* Playwright adds custom pseudo-classes like `:visible`, `:text` and more. + +```js +await page.locator('button').click(); +``` + +```java +page.locator("button").click(); +``` + +```python async +await page.locator("button").click() +``` + +```python sync +page.locator("button").click() +``` + +```csharp +await page.Locator("button").ClickAsync(); +``` + +### Selecting visible elements + +There are two ways of selecting only [visible](./actionability.md#visible) elements with Playwright: +- `:visible` pseudo-class in CSS selectors +- `visible=` selector engine + +If you prefer your selectors to be CSS and don't want to rely on [chaining selectors](#chaining-selectors), use `:visible` pseudo class like so: `input:visible`. If you prefer combining selector engines, use `input >> visible=true`. The latter allows you to combine `text=`, `xpath=` and other selector engines with the visibility filter. + +For example, `input` matches all the inputs on the page, while +`input:visible` and `input >> visible=true` only match visible inputs. This is useful to distinguish elements +that are very similar but differ in visibility. + +:::note +It's usually better to follow the [best practices](#best-practices) and find a more reliable way to +uniquely identify the element. +::: + +Consider a page with two buttons, first invisible and second visible. + +```html + + +``` + +* This will find the first button because it is the first element in DOM order. Then it will wait for the button to become visible before clicking, or timeout while waiting: + + ```js + await page.locator('button').click(); + ``` + + ```java + page.locator("button").click(); + ``` + + ```python async + await page.locator("button").click() + ``` + + ```python sync + page.locator("button").click() + ``` + + ```csharp + await page.Locator("button").ClickAsync(); + ``` + +* These will find a second button, because it is visible, and then click it. + + ```js + await page.locator('button:visible').click(); + await page.locator('button >> visible=true').click(); + ``` + ```java + page.locator("button:visible").click(); + page.locator("button >> visible=true").click(); + ``` + ```python async + await page.locator("button:visible").click() + await page.locator("button >> visible=true").click() + ``` + ```python sync + page.locator("button:visible").click() + page.locator("button >> visible=true").click() + ``` + ```csharp + await page.Locator("button:visible").ClickAsync(); + await page.Locator("button >> visible=true").ClickAsync(); + ``` + +### Selecting elements that contain other elements + +#### Filter by text + +Locators support an option to only select elements that have some text somewhere inside, possibly in a descendant element. Matching is case-insensitive and searches for a substring. + + ```js + await page.locator('button', { hasText: 'Click me' }).click(); + ``` + ```java + page.locator("button", new Page.LocatorOptions().setHasText("Click me")).click(); + ``` + ```python async + await page.locator("button", has_text="Click me").click() + ``` + ```python sync + page.locator("button", has_text="Click me").click() + ``` + ```csharp + await page.Locator("button", new() { HasText = "Click me" }).ClickAsync(); + ``` + +You can also pass a regular expression. + +#### Filter by another locator + +Locators support an option to only select elements that have a descendant matching another locator. + + ```js + page.locator('article', { has: page.locator('button.subscribe') }) + ``` + ```java + page.locator("article", new Page.LocatorOptions().setHas(page.locator("button.subscribe"))) + ``` + ```python async + page.locator("article", has=page.locator("button.subscribe")) + ``` + ```python sync + page.locator("article", has=page.locator("button.subscribe")) + ``` + ```csharp + page.Locator("article", new() { Has = page.Locator("button.subscribe") }) + ``` + +Note that inner locator is matched starting from the outer one, not from the document root. + +#### Inside CSS selector + +The `:has()` pseudo-class is an [experimental CSS pseudo-class](https://developer.mozilla.org/en-US/docs/Web/CSS/:has). 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 `
` element that has a `
` inside. + +```js +await page.locator('article:has(div.promo)').textContent(); +``` + +```java +page.locator("article:has(div.promo)").textContent(); +``` + +```python async +await page.locator("article:has(div.promo)").text_content() +``` + +```python sync +page.locator("article:has(div.promo)").text_content() +``` + +```csharp +await page.Locator("article:has(div.promo)").TextContentAsync(); +``` + +### Augmenting existing locators + +You can add filtering to any locator by passing `:scope` selector to [`method: Locator.locator`] and specifying desired options. For example, given the locator `row` that selects some rows in the table, you can filter to just those that contain text "Hello". + + ```js + const row = page.locator('.row'); + // ... later on ... + await row.locator(':scope', { hasText: 'Hello' }).click(); + ``` + ```java + Locator row = page.locator(".row"); + // ... later on ... + row.locator(":scope", new Locator.LocatorOptions().setHasText("Hello")).click(); + ``` + ```python async + row = page.locator(".row") + # ... later on ... + await row.locator(":scope", has_text="Hello").click() + ``` + ```python sync + row = page.locator(".row") + # ... later on ... + row.locator(":scope", has_text="Hello").click() + ``` + ```csharp + var locator = page.Locator(".row"); + // ... later on ... + await locator.Locator(":scope", new() { HasText = "Hello" }).ClickAsync(); + ``` + +### Selecting elements matching one of the conditions + +#### CSS selector list + +Comma-separated list of CSS selectors will match all elements that can be selected by +one of the selectors in that list. + +```js +// Clicks a +
+
+``` + +In this case, `:nth-match(:text("Buy"), 3)` will select the third button from the snippet above. Note that index is one-based. + +```js +// Click the third "Buy" button +await page.locator(':nth-match(:text("Buy"), 3)').click(); +``` + +```java +// Click the third "Buy" button +page.locator(":nth-match(:text('Buy'), 3)").click(); +``` + +```python async +# Click the third "Buy" button +await page.locator(":nth-match(:text('Buy'), 3)").click() +``` + +```python sync +# Click the third "Buy" button +page.locator(":nth-match(:text('Buy'), 3)").click() +``` + +```csharp +// Click the third "Buy" button +await page.Locator(":nth-match(:text('Buy'), 3)").ClickAsync(); +``` + +`:nth-match()` is also useful to wait until a specified number of elements appear, using [`method: Locator.waitFor`]. + +```js +// Wait until all three buttons are visible +await page.locator(':nth-match(:text("Buy"), 3)').waitFor(); +``` + +```java +// Wait until all three buttons are visible +page.locator(":nth-match(:text('Buy'), 3)").waitFor(); +``` + +```python async +# Wait until all three buttons are visible +await page.locator(":nth-match(:text('Buy'), 3)").wait_for() +``` + +```python sync +# Wait until all three buttons are visible +page.locator(":nth-match(:text('Buy'), 3)").wait_for() +``` + +```csharp +// Wait until all three buttons are visible +await page.Locator(":nth-match(:text('Buy'), 3)").WaitForAsync(); +``` + +:::note +Unlike [`:nth-child()`](https://developer.mozilla.org/en-US/docs/Web/CSS/: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. +::: + +:::note +It is usually possible to distinguish elements by some attribute or text content. In this case, +prefer using [text] or [css] selectors over the `:nth-match()`. +::: + +### Parent selector + +The parent could be selected with `..`, which is a short form for `xpath=..`. + +For example: + +```js +const parentLocator = elementLocator.locator('..'); +``` + +```java +Locator parentLocator = elementLocator.locator(".."); +``` + +```python async +parent_locator = element_locator.locator('..') +``` + +```python sync +parent_locator = element_locator.locator('..') +``` + +```csharp +var parentLocator = elementLocator.Locator(".."); +``` + +### Chaining selectors + +Selectors defined as `engine=body` or in short-form can be combined with the `>>` token, e.g. `selector1 >> selector2 >> selectors3`. When selectors are chained, the next one is queried relative to the previous one's result. + +For example, +``` +css=article >> css=.bar > .baz >> css=span[attr=value] +``` +is equivalent to + +```js browser +document + .querySelector('article') + .querySelector('.bar > .baz') + .querySelector('span[attr=value]') +``` + +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"`. + +#### Intermediate matches + +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. + +For example, `css=article >> text=Hello` captures the element with the text `Hello`, and `*css=article >> text=Hello` (note the `*`) captures the `article` element that contains some element with the text `Hello`. + +### Best practices + +The choice of selectors determines the resiliency of automation scripts. To reduce the maintenance burden, we recommend prioritizing user-facing attributes and explicit contracts. + +#### Prioritize user-facing attributes +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. + +The following examples use the built-in [text] and [css] selector engines. + +```js +// queries "Login" text selector +await page.locator('text="Login"').click(); +await page.locator('"Login"').click(); // short-form + +// queries "Search GitHub" placeholder attribute +await page.locator('css=[placeholder="Search GitHub"]').fill('query'); +await page.locator('[placeholder="Search GitHub"]').fill('query'); // short-form + +// queries "Close" accessibility label +await page.locator('css=[aria-label="Close"]').click(); +await page.locator('[aria-label="Close"]').click(); // short-form + +// combine role and text queries +await page.locator('css=nav >> text=Login').click(); +``` + +```java +// queries "Login" text selector +page.locator("text=\"Login\"").click(); +page.locator("\"Login\"").click(); // short-form + +// queries "Search GitHub" placeholder attribute +page.locator("css=[placeholder='Search GitHub']").fill("query"); +page.locator("[placeholder='Search GitHub']").fill("query"); // short-form + +// queries "Close" accessibility label +page.locator("css=[aria-label='Close']").click(); +page.locator("[aria-label='Close']").click(); // short-form + +// combine role and text queries +page.locator("css=nav >> text=Login").click(); +``` + +```python async +# queries "Login" text selector +await page.locator('text="Login"').click() +await page.locator('"Login"').click() # short-form + +# queries "Search GitHub" placeholder attribute +await page.locator('css=[placeholder="Search GitHub"]').fill('query') +await page.locator('[placeholder="Search GitHub"]').fill('query') # short-form + +# queries "Close" accessibility label +await page.locator('css=[aria-label="Close"]').click() +await page.locator('[aria-label="Close"]').click() # short-form + +# combine role and text queries +await page.locator('css=nav >> text=Login').click() +``` + +```python sync +# queries "Login" text selector +page.locator('text="Login"').click() +page.locator('"Login"').click() # short-form + +# queries "Search GitHub" placeholder attribute +page.locator('css=[placeholder="Search GitHub"]').fill('query') +page.locator('[placeholder="Search GitHub"]').fill('query') # short-form + +# queries "Close" accessibility label +page.locator('css=[aria-label="Close"]').click() +page.locator('[aria-label="Close"]').click() # short-form + +# combine role and text queries +page.locator('css=nav >> text=Login').click() +``` + +```csharp +// queries "Login" text selector +await page.Locator("text=\"Login\"").ClickAsync(); +await page.Locator("\"Login\"").ClickAsync(); // short-form + +// queries "Search GitHub" placeholder attribute +await page.Locator("css=[placeholder='Search GitHub']").FillAsync("query"); +await page.Locator("[placeholder='Search GitHub']").FillAsync("query"); // short-form + +// queries "Close" accessibility label +await page.Locator("css=[aria-label='Close']").ClickAsync(); +await page.Locator("[aria-label='Close']").ClickAsync(); // short-form + +// combine role and text queries +await page.Locator("css=nav >> text=Login").ClickAsync(); +``` + +#### Define explicit contract + +When user-facing attributes change frequently, it is recommended to use explicit test ids, like `data-test-id`. These `data-*` attributes are supported by the [css] and [id selectors][id]. + +```html + +``` + +```js +// queries data-test-id attribute with css +await page.locator('css=[data-test-id=directions]').click(); +await page.locator('[data-test-id=directions]').click(); // short-form + +// queries data-test-id with id +await page.locator('data-test-id=directions').click(); +``` + +```java +// queries data-test-id attribute with css +page.locator("css=[data-test-id=directions]").click(); +page.locator("[data-test-id=directions]").click(); // short-form + +// queries data-test-id with id +page.locator("data-test-id=directions").click(); +``` + +```python async +# queries data-test-id attribute with css +await page.locator('css=[data-test-id=directions]').click() +await page.locator('[data-test-id=directions]').click() # short-form + +# queries data-test-id with id +await page.locator('data-test-id=directions').click() +``` + +```python sync +# queries data-test-id attribute with css +page.locator('css=[data-test-id=directions]').click() +page.locator('[data-test-id=directions]').click() # short-form + +# queries data-test-id with id +page.locator('data-test-id=directions').click() +``` + +```csharp +// queries data-test-id attribute with css +await page.Locator("css=[data-test-id=directions]").ClickAsync(); +await page.Locator("[data-test-id=directions]").ClickAsync(); // short-form + +// queries data-test-id with id +await page.Locator("data-test-id=directions").ClickAsync(); +``` + +#### Avoid selectors tied to implementation + +[xpath] and [css] can be tied to the DOM structure or implementation. These selectors can break when +the DOM structure changes. Similarly, [`method: Locator.nth`], [`method: Locator.first`], and [`method: Locator.last`] are tied to implementation and the structure of the DOM, and will target the incorrect element if the DOM changes. + +```js +// avoid long css or xpath chains +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(); +``` + +```java +// avoid long css or xpath chains +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(); +``` + +```python async +# avoid long css or xpath chains +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() +``` + +```python sync +# avoid long css or xpath chains +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() +``` + +```csharp +// avoid long css or xpath chains +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(); +``` + +[text]: #text-selector +[css]: #css-selector +[xpath]: #xpath-selectors +[react]: #react-selectors +[vue]: #vue-selectors +[id]: #id-data-testid-data-test-id-data-test-selectors diff --git a/docs/src/protractor-js.md b/docs/src/protractor-js.md index e938b29d54..be5470679a 100644 --- a/docs/src/protractor-js.md +++ b/docs/src/protractor-js.md @@ -163,7 +163,7 @@ Learn more about Playwright Test runner: - [Getting Started](./intro) - [Fixtures](./test-fixtures) - [Locators](./api/class-locator) -- [Selectors](./selectors) +- [Selectors](./locators.md#selectors) - [Assertions](./test-assertions) - [Auto-waiting](./actionability) diff --git a/docs/src/release-notes-csharp.md b/docs/src/release-notes-csharp.md index d625bc151c..30d5d26469 100644 --- a/docs/src/release-notes-csharp.md +++ b/docs/src/release-notes-csharp.md @@ -202,7 +202,7 @@ Note that the new methods [`method: Page.routeFromHAR`] and [`method: BrowserCon await page.Locator("role=button[name='log in']").ClickAsync(); ``` - Read more in [our documentation](./selectors#role-selector). + Read more in [our documentation](./locators#role-selector). - New [`method: Locator.filter`] API to filter an existing locator @@ -224,7 +224,7 @@ Note that the new methods [`method: Page.routeFromHAR`] and [`method: BrowserCon await page.Locator("role=button[name='log in']").ClickAsync(); ``` - Read more in [our documentation](./selectors#role-selector). + Read more in [our documentation](./locators#role-selector). - New `scale` option in [`method: Page.screenshot`] for smaller sized screenshots. - New `caret` option in [`method: Page.screenshot`] to control text caret. Defaults to `"hide"`. - We now ship a designated .NET docker image `mcr.microsoft.com/playwright/dotnet`. Read more in [our documentation](./docker). @@ -512,7 +512,7 @@ await locator.ClickAsync(); Learn more in the [documentation](./api/class-locator). -#### đŸ§© Experimental [**React**](./selectors#react-selectors) and [**Vue**](./selectors#vue-selectors) selector engines +#### đŸ§© Experimental [**React**](./locators#react-selectors) and [**Vue**](./locators#vue-selectors) selector engines React and Vue selectors allow selecting elements by its component name and/or property values. The syntax is very similar to [attribute selectors](https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors) and supports all attribute selector operators. @@ -521,12 +521,12 @@ await page.Locator("_react=SubmitButton[enabled=true]").ClickAsync(); await page.Locator("_vue=submit-button[enabled=true]").ClickAsync(); ``` -Learn more in the [react selectors documentation](./selectors#react-selectors) and the [vue selectors documentation](./selectors#vue-selectors). +Learn more in the [react selectors documentation](./locators#react-selectors) and the [vue selectors documentation](./locators#vue-selectors). -#### ✨ New [**`nth`**](./selectors#n-th-element-selector) and [**`visible`**](./selectors#selecting-visible-elements) selector engines +#### ✨ New [**`nth`**](./locators#n-th-element-selector) and [**`visible`**](./locators#selecting-visible-elements) selector engines -- [`nth`](./selectors#n-th-element-selector) selector engine is equivalent to the `:nth-match` pseudo class, but could be combined with other selector engines. -- [`visible`](./selectors#selecting-visible-elements) selector engine is equivalent to the `:visible` pseudo class, but could be combined with other selector engines. +- [`nth`](./locators#n-th-element-selector) selector engine is equivalent to the `:nth-match` pseudo class, but could be combined with other selector engines. +- [`visible`](./locators#selecting-visible-elements) selector engine is equivalent to the `:visible` pseudo class, but could be combined with other selector engines. ```csharp // select the first button among all buttons diff --git a/docs/src/release-notes-java.md b/docs/src/release-notes-java.md index 35e7409ef8..573e30c1da 100644 --- a/docs/src/release-notes-java.md +++ b/docs/src/release-notes-java.md @@ -143,7 +143,7 @@ Note that the new methods [`method: Page.routeFromHAR`] and [`method: BrowserCon page.locator("role=button[name='log in']").click(); ``` - Read more in [our documentation](./selectors#role-selector). + Read more in [our documentation](./locators#role-selector). - New [`method: Locator.filter`] API to filter an existing locator @@ -169,7 +169,7 @@ Note that the new methods [`method: Page.routeFromHAR`] and [`method: BrowserCon page.locator("role=button[name='log in']").click(); ``` - Read more in [our documentation](./selectors#role-selector). + Read more in [our documentation](./locators#role-selector). - New `scale` option in [`method: Page.screenshot`] for smaller sized screenshots. - New `caret` option in [`method: Page.screenshot`] to control text caret. Defaults to `"hide"`. @@ -476,7 +476,7 @@ locator.click(); Learn more in the [documentation](./api/class-locator). -#### đŸ§© Experimental [**React**](./selectors#react-selectors) and [**Vue**](./selectors#vue-selectors) selector engines +#### đŸ§© Experimental [**React**](./locators#react-selectors) and [**Vue**](./locators#vue-selectors) selector engines React and Vue selectors allow selecting elements by its component name and/or property values. The syntax is very similar to [attribute selectors](https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors) and supports all attribute selector operators. @@ -485,12 +485,12 @@ page.locator("_react=SubmitButton[enabled=true]").click(); page.locator("_vue=submit-button[enabled=true]").click(); ``` -Learn more in the [react selectors documentation](./selectors#react-selectors) and the [vue selectors documentation](./selectors#vue-selectors). +Learn more in the [react selectors documentation](./locators#react-selectors) and the [vue selectors documentation](./locators#vue-selectors). -#### ✨ New [**`nth`**](./selectors#n-th-element-selector) and [**`visible`**](./selectors#selecting-visible-elements) selector engines +#### ✨ New [**`nth`**](./locators#n-th-element-selector) and [**`visible`**](./locators#selecting-visible-elements) selector engines -- [`nth`](./selectors#n-th-element-selector) selector engine is equivalent to the `:nth-match` pseudo class, but could be combined with other selector engines. -- [`visible`](./selectors#selecting-visible-elements) selector engine is equivalent to the `:visible` pseudo class, but could be combined with other selector engines. +- [`nth`](./locators#n-th-element-selector) selector engine is equivalent to the `:nth-match` pseudo class, but could be combined with other selector engines. +- [`visible`](./locators#selecting-visible-elements) selector engine is equivalent to the `:visible` pseudo class, but could be combined with other selector engines. ```java // select the first button among all buttons @@ -663,7 +663,7 @@ This version of Playwright was also tested against the following stable channels - **Pause script execution** with [`method: Page.pause`] in headed mode. Pausing the page launches [Playwright Inspector](./debug.md) for debugging. -- **New has-text pseudo-class** for CSS selectors. `:has-text("example")` matches any element containing `"example"` somewhere inside, possibly in a child or a descendant element. See [more examples](./selectors.md#text-selector). +- **New has-text pseudo-class** for CSS selectors. `:has-text("example")` matches any element containing `"example"` somewhere inside, possibly in a child or a descendant element. See [more examples](./locators.md#text-selector). - **Page dialogs are now auto-dismissed** during execution, unless a listener for `dialog` event is configured. [Learn more](./dialogs.md) about this. @@ -681,7 +681,7 @@ This version of Playwright was also tested against the following stable channels ## Version 1.8 -- [Selecting elements based on layout](./selectors.md#selecting-elements-based-on-layout) with `:left-of()`, `:right-of()`, `:above()` and `:below()`. +- [Selecting elements based on layout](./locators.md#selecting-elements-based-on-layout) with `:left-of()`, `:right-of()`, `:above()` and `:below()`. - Playwright now includes [command line interface](./cli.md), former playwright-cli. ```bash java mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="--help" @@ -715,7 +715,7 @@ This version of Playwright was also tested against the following stable channels - **New Java SDK**: [Playwright for Java](https://github.com/microsoft/playwright-java) is now on par with [JavaScript](https://github.com/microsoft/playwright), [Python](https://github.com/microsoft/playwright-python) and [.NET bindings](https://github.com/microsoft/playwright-dotnet). - **Browser storage API**: New convenience APIs to save and load browser storage state (cookies, local storage) to simplify automation scenarios with authentication. -- **New CSS selectors**: We heard your feedback for more flexible selectors and have revamped the selectors implementation. Playwright 1.7 introduces [new CSS extensions](./selectors.md) and there's more coming soon. +- **New CSS selectors**: We heard your feedback for more flexible selectors and have revamped the selectors implementation. Playwright 1.7 introduces [new CSS extensions](./locators.md#selectors) and there's more coming soon. - **New website**: The docs website at [playwright.dev](https://playwright.dev/) has been updated and is now built with [Docusaurus](https://v2.docusaurus.io/). - **Support for Apple Silicon**: Playwright browser binaries for WebKit and Chromium are now built for Apple Silicon. diff --git a/docs/src/release-notes-js.md b/docs/src/release-notes-js.md index 71756875d9..8e4c3279f0 100644 --- a/docs/src/release-notes-js.md +++ b/docs/src/release-notes-js.md @@ -342,7 +342,7 @@ WebServer is now considered "ready" if request to the specified port has any of await page.locator('role=button[name="log in"]').click() ``` - Read more in [our documentation](./selectors#role-selector). + Read more in [our documentation](./locators#role-selector). - New [`method: Locator.filter`] API to filter an existing locator @@ -384,7 +384,7 @@ WebServer is now considered "ready" if request to the specified port has any of await page.locator('role=button[name="log in"]').click() ``` - Read more in [our documentation](./selectors#role-selector). + Read more in [our documentation](./locators#role-selector). - New `scale` option in [`method: Page.screenshot`] for smaller sized screenshots. - New `caret` option in [`method: Page.screenshot`] to control text caret. Defaults to `"hide"`. @@ -976,7 +976,7 @@ await locator.click(); Learn more in the [documentation](./api/class-locator). -#### đŸ§© Experimental [**React**](./selectors#react-selectors) and [**Vue**](./selectors#vue-selectors) selector engines +#### đŸ§© Experimental [**React**](./locators#react-selectors) and [**Vue**](./locators#vue-selectors) selector engines React and Vue selectors allow selecting elements by its component name and/or property values. The syntax is very similar to [attribute selectors](https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors) and supports all attribute selector operators. @@ -985,12 +985,12 @@ await page.locator('_react=SubmitButton[enabled=true]').click(); await page.locator('_vue=submit-button[enabled=true]').click(); ``` -Learn more in the [react selectors documentation](./selectors#react-selectors) and the [vue selectors documentation](./selectors#vue-selectors). +Learn more in the [react selectors documentation](./locators#react-selectors) and the [vue selectors documentation](./locators#vue-selectors). -#### ✨ New [**`nth`**](./selectors#n-th-element-selector) and [**`visible`**](./selectors#selecting-visible-elements) selector engines +#### ✨ New [**`nth`**](./locators#n-th-element-selector) and [**`visible`**](./locators#selecting-visible-elements) selector engines -- [`nth`](./selectors#n-th-element-selector) selector engine is equivalent to the `:nth-match` pseudo class, but could be combined with other selector engines. -- [`visible`](./selectors#selecting-visible-elements) selector engine is equivalent to the `:visible` pseudo class, but could be combined with other selector engines. +- [`nth`](./locators#n-th-element-selector) selector engine is equivalent to the `:nth-match` pseudo class, but could be combined with other selector engines. +- [`visible`](./locators#selecting-visible-elements) selector engine is equivalent to the `:visible` pseudo class, but could be combined with other selector engines. ```js // select the first button among all buttons @@ -1297,7 +1297,7 @@ This version of Playwright was also tested against the following stable channels - **Pause script execution** with [`method: Page.pause`] in headed mode. Pausing the page launches [Playwright Inspector](./debug.md) for debugging. -- **New has-text pseudo-class** for CSS selectors. `:has-text("example")` matches any element containing `"example"` somewhere inside, possibly in a child or a descendant element. See [more examples](./selectors.md#text-selector). +- **New has-text pseudo-class** for CSS selectors. `:has-text("example")` matches any element containing `"example"` somewhere inside, possibly in a child or a descendant element. See [more examples](./locators.md#text-selector). - **Page dialogs are now auto-dismissed** during execution, unless a listener for `dialog` event is configured. [Learn more](./dialogs.md) about this. @@ -1315,7 +1315,7 @@ This version of Playwright was also tested against the following stable channels ## Version 1.8 -- [Selecting elements based on layout](./selectors.md#selecting-elements-based-on-layout) with `:left-of()`, `:right-of()`, `:above()` and `:below()`. +- [Selecting elements based on layout](./locators.md#selecting-elements-based-on-layout) with `:left-of()`, `:right-of()`, `:above()` and `:below()`. - Playwright now includes [command line interface](./cli.md), former playwright-cli. ```bash js npx playwright --help @@ -1349,7 +1349,7 @@ This version of Playwright was also tested against the following stable channels - **New Java SDK**: [Playwright for Java](https://github.com/microsoft/playwright-java) is now on par with [JavaScript](https://github.com/microsoft/playwright), [Python](https://github.com/microsoft/playwright-python) and [.NET bindings](https://github.com/microsoft/playwright-dotnet). - **Browser storage API**: New convenience APIs to save and load browser storage state (cookies, local storage) to simplify automation scenarios with authentication. -- **New CSS selectors**: We heard your feedback for more flexible selectors and have revamped the selectors implementation. Playwright 1.7 introduces [new CSS extensions](./selectors.md) and there's more coming soon. +- **New CSS selectors**: We heard your feedback for more flexible selectors and have revamped the selectors implementation. Playwright 1.7 introduces [new CSS extensions](./locators.md#selectors) and there's more coming soon. - **New website**: The docs website at [playwright.dev](https://playwright.dev/) has been updated and is now built with [Docusaurus](https://v2.docusaurus.io/). - **Support for Apple Silicon**: Playwright browser binaries for WebKit and Chromium are now built for Apple Silicon. diff --git a/docs/src/release-notes-python.md b/docs/src/release-notes-python.md index 01235055b1..7199352e6b 100644 --- a/docs/src/release-notes-python.md +++ b/docs/src/release-notes-python.md @@ -188,7 +188,7 @@ Note that the new methods [`method: Page.routeFromHAR`] and [`method: BrowserCon page.locator("role=button[name='log in']").click() ``` - Read more in [our documentation](./selectors#role-selector). + Read more in [our documentation](./locators#role-selector). - New [`method: Locator.filter`] API to filter an existing locator @@ -221,7 +221,7 @@ Note that the new methods [`method: Page.routeFromHAR`] and [`method: BrowserCon page.locator("role=button[name='log in']").click() ``` - Read more in [our documentation](./selectors#role-selector). + Read more in [our documentation](./locators#role-selector). - New `scale` option in [`method: Page.screenshot`] for smaller sized screenshots. - New `caret` option in [`method: Page.screenshot`] to control text caret. Defaults to `"hide"`. @@ -549,7 +549,7 @@ locator.click() Learn more in the [documentation](./api/class-locator). -#### đŸ§© Experimental [**React**](./selectors#react-selectors) and [**Vue**](./selectors#vue-selectors) selector engines +#### đŸ§© Experimental [**React**](./locators#react-selectors) and [**Vue**](./locators#vue-selectors) selector engines React and Vue selectors allow selecting elements by its component name and/or property values. The syntax is very similar to [attribute selectors](https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors) and supports all attribute selector operators. @@ -558,12 +558,12 @@ page.locator("_react=SubmitButton[enabled=true]").click() page.locator("_vue=submit-button[enabled=true]").click() ``` -Learn more in the [react selectors documentation](./selectors#react-selectors) and the [vue selectors documentation](./selectors#vue-selectors). +Learn more in the [react selectors documentation](./locators#react-selectors) and the [vue selectors documentation](./locators#vue-selectors). -#### ✨ New [**`nth`**](./selectors#n-th-element-selector) and [**`visible`**](./selectors#selecting-visible-elements) selector engines +#### ✨ New [**`nth`**](./locators#n-th-element-selector) and [**`visible`**](./locators#selecting-visible-elements) selector engines -- [`nth`](./selectors#n-th-element-selector) selector engine is equivalent to the `:nth-match` pseudo class, but could be combined with other selector engines. -- [`visible`](./selectors#selecting-visible-elements) selector engine is equivalent to the `:visible` pseudo class, but could be combined with other selector engines. +- [`nth`](./locators#n-th-element-selector) selector engine is equivalent to the `:nth-match` pseudo class, but could be combined with other selector engines. +- [`visible`](./locators#selecting-visible-elements) selector engine is equivalent to the `:visible` pseudo class, but could be combined with other selector engines. ```py # select the first button among all buttons @@ -734,7 +734,7 @@ This version of Playwright was also tested against the following stable channels - **Pause script execution** with [`method: Page.pause`] in headed mode. Pausing the page launches [Playwright Inspector](./debug.md) for debugging. -- **New has-text pseudo-class** for CSS selectors. `:has-text("example")` matches any element containing `"example"` somewhere inside, possibly in a child or a descendant element. See [more examples](./selectors.md#text-selector). +- **New has-text pseudo-class** for CSS selectors. `:has-text("example")` matches any element containing `"example"` somewhere inside, possibly in a child or a descendant element. See [more examples](./locators.md#text-selector). - **Page dialogs are now auto-dismissed** during execution, unless a listener for `dialog` event is configured. [Learn more](./dialogs.md) about this. @@ -752,7 +752,7 @@ This version of Playwright was also tested against the following stable channels ## Version 1.8 -- [Selecting elements based on layout](./selectors.md#selecting-elements-based-on-layout) with `:left-of()`, `:right-of()`, `:above()` and `:below()`. +- [Selecting elements based on layout](./locators.md#selecting-elements-based-on-layout) with `:left-of()`, `:right-of()`, `:above()` and `:below()`. - Playwright now includes [command line interface](./cli.md), former playwright-cli. ```bash python playwright --help @@ -786,7 +786,7 @@ This version of Playwright was also tested against the following stable channels - **New Java SDK**: [Playwright for Java](https://github.com/microsoft/playwright-java) is now on par with [JavaScript](https://github.com/microsoft/playwright), [Python](https://github.com/microsoft/playwright-python) and [.NET bindings](https://github.com/microsoft/playwright-dotnet). - **Browser storage API**: New convenience APIs to save and load browser storage state (cookies, local storage) to simplify automation scenarios with authentication. -- **New CSS selectors**: We heard your feedback for more flexible selectors and have revamped the selectors implementation. Playwright 1.7 introduces [new CSS extensions](./selectors.md) and there's more coming soon. +- **New CSS selectors**: We heard your feedback for more flexible selectors and have revamped the selectors implementation. Playwright 1.7 introduces [new CSS extensions](./locators.md#selectors) and there's more coming soon. - **New website**: The docs website at [playwright.dev](https://playwright.dev/) has been updated and is now built with [Docusaurus](https://v2.docusaurus.io/). - **Support for Apple Silicon**: Playwright browser binaries for WebKit and Chromium are now built for Apple Silicon. diff --git a/docs/src/running-tests-csharp.md b/docs/src/running-tests-csharp.md index b5129b2042..827fb8a085 100644 --- a/docs/src/running-tests-csharp.md +++ b/docs/src/running-tests-csharp.md @@ -58,7 +58,7 @@ For more information see [selective unit tests](https://docs.microsoft.com/en-us ## Debugging Tests -Since Playwright runs in .NET, you can debug it with your debugger of choice in e.g. Visual Studio Code or Visual Studio. Playwright comes with the Playwright Inspector which allows you to step through Playwright API calls, see their debug logs and explore [selectors](./selectors.md). +Since Playwright runs in .NET, you can debug it with your debugger of choice in e.g. Visual Studio Code or Visual Studio. Playwright comes with the Playwright Inspector which allows you to step through Playwright API calls, see their debug logs and explore [selectors](./locators.md#selectors). ```bash tab=bash-bash lang=csharp PWDEBUG=1 dotnet test diff --git a/docs/src/running-tests-js.md b/docs/src/running-tests-js.md index 739bffee71..0485610693 100644 --- a/docs/src/running-tests-js.md +++ b/docs/src/running-tests-js.md @@ -61,7 +61,7 @@ For a better debugging experience check out the [VS Code Extension](./getting-st ## Debugging Tests -Since Playwright runs in Node.js, you can debug it with your debugger of choice e.g. using `console.log` or inside your IDE or directly in VS Code with the [VS Code Extension](./getting-started-vscode.md). Playwright comes with the [Playwright Inspector](./debug.md#playwright-inspector) which allows you to step through Playwright API calls, see their debug logs and explore [selectors](./selectors.md). +Since Playwright runs in Node.js, you can debug it with your debugger of choice e.g. using `console.log` or inside your IDE or directly in VS Code with the [VS Code Extension](./getting-started-vscode.md). Playwright comes with the [Playwright Inspector](./debug.md#playwright-inspector) which allows you to step through Playwright API calls, see their debug logs and explore [selectors](./locators.md#selectors). - Debugging all tests: diff --git a/docs/src/running-tests-python.md b/docs/src/running-tests-python.md index e250baa94f..cd43cd0cb1 100644 --- a/docs/src/running-tests-python.md +++ b/docs/src/running-tests-python.md @@ -59,7 +59,7 @@ For more information see [Playwright Pytest usage](./test-runners.md) or the Pyt ## Running Tests -Since Playwright runs in Python, you can debug it with your debugger of choice with e.g. the [Python extension](https://code.visualstudio.com/docs/python/python-tutorial) in Visual Studio Code. Playwright comes with the Playwright Inspector which allows you to step through Playwright API calls, see their debug logs and explore [selectors](./selectors.md). +Since Playwright runs in Python, you can debug it with your debugger of choice with e.g. the [Python extension](https://code.visualstudio.com/docs/python/python-tutorial) in Visual Studio Code. Playwright comes with the Playwright Inspector which allows you to step through Playwright API calls, see their debug logs and explore [selectors](./locators.md#selectors). ```bash tab=bash-bash lang=python diff --git a/docs/src/selectors.md b/docs/src/selectors.md deleted file mode 100644 index e378faa657..0000000000 --- a/docs/src/selectors.md +++ /dev/null @@ -1,1389 +0,0 @@ ---- -id: selectors -title: "Selectors" ---- - -Selectors are strings that are used to create [Locator]s. Locators are used to perform actions on the elements by means of methods such as [`method: Locator.click`], [`method: Locator.fill`] and alike. For debugging selectors, see [here](./debug-selectors). - -Writing good selectors is part art, part science so be sure to checkout the [Best Practices](#best-practices) section. - - - -## Quick guide - -- Text selector - ```js - await page.locator('text=Log in').click(); - ``` - ```java - page.locator("text=Log in").click(); - ``` - ```python async - await page.locator("text=Log in").click() - ``` - ```python sync - page.locator("text=Log in").click() - ``` - ```csharp - await page.Locator("text=Log in").ClickAsync(); - ``` - Learn more about [text selector][text]. -- CSS selector - ```js - await page.locator('button').click(); - await page.locator('#nav-bar .contact-us-item').click(); - ``` - ```java - page.locator("button").click(); - page.locator("#nav-bar .contact-us-item").click(); - ``` - ```python async - await page.locator("button").click() - await page.locator("#nav-bar .contact-us-item").click() - ``` - ```python sync - page.locator("button").click() - page.locator("#nav-bar .contact-us-item").click() - ``` - ```csharp - await page.Locator("button").ClickAsync(); - await page.Locator("#nav-bar .contact-us-item").ClickAsync(); - ``` - Learn more about [css selector][css]. -- Select by attribute, with css selector - ```js - await page.locator('[data-test=login-button]').click(); - await page.locator('[aria-label="Sign in"]').click(); - ``` - ```java - page.locator("[data-test=login-button]").click(); - page.locator("[aria-label='Sign in']").click(); - ``` - ```python async - await page.locator("[data-test=login-button]").click() - await page.locator("[aria-label='Sign in']").click() - ``` - ```python sync - page.locator("[data-test=login-button]").click() - page.locator("[aria-label='Sign in']").click() - ``` - ```csharp - await page.Locator("[data-test=login-button]").ClickAsync(); - await page.Locator("[aria-label='Sign in']").ClickAsync(); - ``` - Learn more about [css selector][css]. -- Combine css and text selectors - ```js - await page.locator('article:has-text("Playwright")').click(); - await page.locator('#nav-bar >> text=Contact Us').click(); - ``` - ```java - page.locator("article:has-text(\"Playwright\")").click(); - page.locator("#nav-bar :text(\"Contact us\")").click(); - ``` - ```python async - await page.locator("article:has-text('Playwright')").click() - await page.locator("#nav-bar :text('Contact us')").click() - ``` - ```python sync - page.locator("article:has-text('Playwright')").click() - page.locator("#nav-bar :text('Contact us')").click() - ``` - ```csharp - await page.Locator("article:has-text(\"Playwright\")").ClickAsync(); - await page.Locator("#nav-bar :text(\"Contact us\")").ClickAsync(); - ``` - Learn more about [`:has-text()` and `:text()` pseudo classes][text]. -- Element that contains another, with css selector - ```js - await page.locator('.item-description:has(.item-promo-banner)').click(); - ``` - ```java - page.locator(".item-description:has(.item-promo-banner)").click(); - ``` - ```python async - await page.locator(".item-description:has(.item-promo-banner)").click() - ``` - ```python sync - page.locator(".item-description:has(.item-promo-banner)").click() - ``` - ```csharp - await page.Locator(".item-description:has(.item-promo-banner)").ClickAsync(); - ``` - Learn more about [`:has()` pseudo class](#selecting-elements-that-contain-other-elements). -- Selecting based on layout, with css selector - ```js - await page.locator('input:right-of(:text("Username"))').click(); - ``` - ```java - page.locator("input:right-of(:text(\"Username\"))").click(); - ``` - ```python async - await page.locator("input:right-of(:text('Username'))").click() - ``` - ```python sync - page.locator("input:right-of(:text('Username'))").click() - ``` - ```csharp - await page.Locator("input:right-of(:text(\"Username\"))").ClickAsync(); - ``` - Learn more about [layout selectors](#selecting-elements-based-on-layout). -- Only visible elements, with css selector - ```js - await page.locator('.login-button:visible').click(); - ``` - ```java - page.locator(".login-button:visible").click(); - ``` - ```python async - await page.locator(".login-button:visible").click() - ``` - ```python sync - page.locator(".login-button:visible").click() - ``` - ```csharp - await page.Locator(".login-button:visible").ClickAsync(); - ``` - Learn more about [selecting visible elements](#selecting-visible-elements). -- Pick n-th match - ```js - await page.locator(':nth-match(:text("Buy"), 3)').click(); - ``` - ```java - page.locator(":nth-match(:text('Buy'), 3)").click(); - ``` - ```python async - await page.locator(":nth-match(:text('Buy'), 3)").click() - ``` - ```python sync - page.locator(":nth-match(:text('Buy'), 3)").click() - ``` - ```csharp - await page.Locator(":nth-match(:text('Buy'), 3)").ClickAsync(); - ``` - Learn more about [`:nth-match()` pseudo-class](#pick-n-th-match-from-the-query-result). -- XPath selector - ```js - await page.locator('xpath=//button').click(); - ``` - ```java - page.locator("xpath=//button").click(); - ``` - ```python async - await page.locator("xpath=//button").click() - ``` - ```python sync - page.locator("xpath=//button").click() - ``` - ```csharp - await page.Locator("xpath=//button").ClickAsync(); - ``` - Learn more about [XPath selector][xpath]. -- React selector (experimental) - ```js - await page.locator('_react=ListItem[text *= "milk" i]').click(); - ``` - ```java - page.locator("_react=ListItem[text *= 'milk' i]").click(); - ``` - ```python async - await page.locator("_react=ListItem[text *= 'milk' i]").click() - ``` - ```python sync - page.locator("_react=ListItem[text *= 'milk' i]").click() - ``` - ```csharp - await page.Locator("_react=ListItem[text *= 'milk' i]").ClickAsync(); - ``` - Learn more about [React selectors][react]. -- Vue selector (experimental) - ```js - await page.locator('_vue=list-item[text *= "milk" i]').click(); - ``` - ```java - page.locator("_vue=list-item[text *= 'milk' i]").click(); - ``` - ```python async - await page.locator("_vue=list-item[text *= 'milk' i]").click() - ``` - ```python sync - page.locator("_vue=list-item[text *= 'milk' i]").click() - ``` - ```csharp - await page.Locator("_vue=list-item[text *= 'milk' i]").ClickAsync(); - ``` - Learn more about [Vue selectors][vue]. - - - -## Text selector - -Text selector locates elements that contain passed text. - -```js -await page.locator('text=Log in').click(); -``` -```java -page.locator("text=Log in").click(); -``` -```python async -await page.locator("text=Log in").click() -``` -```python sync -page.locator("text=Log in").click() -``` -```csharp -await page.Locator("text=Log in").ClickAsync(); -``` - -Text selector has a few variations: - -- `text=Log in` - default matching is case-insensitive and searches for a substring. For example, `text=Log` matches ``. - - ```js - await page.locator('text=Log in').click(); - ``` - ```java - page.locator("text=Log in").click(); - ``` - ```python async - await page.locator("text=Log in").click() - ``` - ```python sync - page.locator("text=Log in").click() - ``` - ```csharp - await page.Locator("text=Log in").ClickAsync(); - ``` - -- `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 `` because ``, because ``. - - Quoted body follows the usual escaping rules, e.g. use `\"` to escape double quote in a double-quoted string: `text="foo\"bar"`. - - ```js - await page.locator('text="Log in"').click(); - ``` - ```java - page.locator("text='Log in'").click(); - ``` - ```python async - await page.locator("text='Log in'").click() - ``` - ```python sync - page.locator("text='Log in'").click() - ``` - ```csharp - await page.Locator("text='Log in'").ClickAsync(); - ``` - -- `"Log in"` - selector starting and ending with a quote (either `"` or `'`) is assumed to be a text selector. For example, `"Log in"` is converted to `text="Log in"` internally. - - ```js - await page.locator('"Log in"').click(); - ``` - ```java - page.locator("'Log in'").click(); - ``` - ```python async - await page.locator("'Log in'").click() - ``` - ```python sync - page.locator("'Log in'").click() - ``` - ```csharp - await page.Locator("'Log in'").ClickAsync(); - ``` - -- `/Log\s*in/i` - body can be a [JavaScript-like regex](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) wrapped in `/` symbols. For example, `text=/Log\s*in/i` matches `` and ``. - - ```js - await page.locator('text=/Log\\s*in/i').click(); - ``` - ```java - page.locator("text=/Log\\s*in/i").click(); - ``` - ```python async - await page.locator("text=/Log\s*in/i").click() - ``` - ```python sync - page.locator("text=/Log\s*in/i").click() - ``` - ```csharp - await page.Locator("text=/Log\\s*in/i").ClickAsync(); - ``` - -- `article:has-text("Playwright")` - the `: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. Matching is case-insensitive and searches for a substring. For example, `article:has-text("Playwright")` matches `
Playwright
`. - - Note that `:has-text()` should be used together with other `css` specifiers, otherwise it will match all the elements containing specified text, including the ``. - ```js - // Wrong, will match many elements including - await page.locator(':has-text("Playwright")').click(); - // Correct, only matches the
element - await page.locator('article:has-text("Playwright")').click(); - ``` - - ```java - // Wrong, will match many elements including - page.locator(":has-text(\"Playwright\")").click(); - // Correct, only matches the
element - page.locator("article:has-text(\"Playwright\")").click(); - ``` - - ```python async - # Wrong, will match many elements including - await page.locator(':has-text("Playwright")').click() - # Correct, only matches the
element - await page.locator('article:has-text("Playwright")').click() - ``` - ```python sync - # Wrong, will match many elements including - page.locator(':has-text("Playwright")').click() - # Correct, only matches the
element - page.locator('article:has-text("All products")').click() - ``` - - ```csharp - // Wrong, will match many elements including - await page.Locator(":has-text(\"Playwright\")").ClickAsync(); - // Correct, only matches the
element - await page.Locator("article:has-text(\"Playwright\")").ClickAsync(); - ``` - -- `#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-bar` element. - - ```js - await page.locator('#nav-bar :text("Home")').click(); - ``` - ```java - page.locator("#nav-bar :text('Home')").click(); - ``` - ```python async - await page.locator("#nav-bar :text('Home')").click() - ``` - ```python sync - page.locator("#nav-bar :text('Home')").click() - ``` - ```csharp - await page.Locator("#nav-bar :text('Home')").ClickAsync(); - ``` - -- `#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` element. - -* `#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 `#nav-bar` element. - -:::note -Matching always normalizes whitespace. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace. -::: - -:::note -Input elements of the type `button` and `submit` are matched by their `value` instead of text content. For example, `text=Log in` matches ``. -::: - -## CSS selector - -Playwright augments standard CSS selectors in two ways: -* `css` engine pierces open shadow DOM by default. -* Playwright adds custom pseudo-classes like `:visible`, `:text` and more. - -```js -await page.locator('button').click(); -``` - -```java -page.locator("button").click(); -``` - -```python async -await page.locator("button").click() -``` - -```python sync -page.locator("button").click() -``` - -```csharp -await page.Locator("button").ClickAsync(); -``` - -## Selecting visible elements - -There are two ways of selecting only [visible](./actionability.md#visible) elements with Playwright: -- `:visible` pseudo-class in CSS selectors -- `visible=` selector engine - -If you prefer your selectors to be CSS and don't want to rely on [chaining selectors](#chaining-selectors), use `:visible` pseudo class like so: `input:visible`. If you prefer combining selector engines, use `input >> visible=true`. The latter allows you to combine `text=`, `xpath=` and other selector engines with the visibility filter. - -For example, `input` matches all the inputs on the page, while -`input:visible` and `input >> visible=true` only match visible inputs. This is useful to distinguish elements -that are very similar but differ in visibility. - -:::note -It's usually better to follow the [best practices](#best-practices) and find a more reliable way to -uniquely identify the element. -::: - -Consider a page with two buttons, first invisible and second visible. - -```html - - -``` - -* This will find the first button because it is the first element in DOM order. Then it will wait for the button to become visible before clicking, or timeout while waiting: - - ```js - await page.locator('button').click(); - ``` - - ```java - page.locator("button").click(); - ``` - - ```python async - await page.locator("button").click() - ``` - - ```python sync - page.locator("button").click() - ``` - - ```csharp - await page.Locator("button").ClickAsync(); - ``` - -* These will find a second button, because it is visible, and then click it. - - ```js - await page.locator('button:visible').click(); - await page.locator('button >> visible=true').click(); - ``` - ```java - page.locator("button:visible").click(); - page.locator("button >> visible=true").click(); - ``` - ```python async - await page.locator("button:visible").click() - await page.locator("button >> visible=true").click() - ``` - ```python sync - page.locator("button:visible").click() - page.locator("button >> visible=true").click() - ``` - ```csharp - await page.Locator("button:visible").ClickAsync(); - await page.Locator("button >> visible=true").ClickAsync(); - ``` - -## Selecting elements that contain other elements - -### Filter by text - -Locators support an option to only select elements that have some text somewhere inside, possibly in a descendant element. Matching is case-insensitive and searches for a substring. - - ```js - await page.locator('button', { hasText: 'Click me' }).click(); - ``` - ```java - page.locator("button", new Page.LocatorOptions().setHasText("Click me")).click(); - ``` - ```python async - await page.locator("button", has_text="Click me").click() - ``` - ```python sync - page.locator("button", has_text="Click me").click() - ``` - ```csharp - await page.Locator("button", new() { HasText = "Click me" }).ClickAsync(); - ``` - -You can also pass a regular expression. - -### Filter by another locator - -Locators support an option to only select elements that have a descendant matching another locator. - - ```js - page.locator('article', { has: page.locator('button.subscribe') }) - ``` - ```java - page.locator("article", new Page.LocatorOptions().setHas(page.locator("button.subscribe"))) - ``` - ```python async - page.locator("article", has=page.locator("button.subscribe")) - ``` - ```python sync - page.locator("article", has=page.locator("button.subscribe")) - ``` - ```csharp - page.Locator("article", new() { Has = page.Locator("button.subscribe") }) - ``` - -Note that inner locator is matched starting from the outer one, not from the document root. - -### Inside CSS selector - -The `:has()` pseudo-class is an [experimental CSS pseudo-class](https://developer.mozilla.org/en-US/docs/Web/CSS/:has). 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 `
` element that has a `
` inside. - -```js -await page.locator('article:has(div.promo)').textContent(); -``` - -```java -page.locator("article:has(div.promo)").textContent(); -``` - -```python async -await page.locator("article:has(div.promo)").text_content() -``` - -```python sync -page.locator("article:has(div.promo)").text_content() -``` - -```csharp -await page.Locator("article:has(div.promo)").TextContentAsync(); -``` - -## Augmenting existing locators - -You can add filtering to any locator by passing `:scope` selector to [`method: Locator.locator`] and specifying desired options. For example, given the locator `row` that selects some rows in the table, you can filter to just those that contain text "Hello". - - ```js - const row = page.locator('.row'); - // ... later on ... - await row.locator(':scope', { hasText: 'Hello' }).click(); - ``` - ```java - Locator row = page.locator(".row"); - // ... later on ... - row.locator(":scope", new Locator.LocatorOptions().setHasText("Hello")).click(); - ``` - ```python async - row = page.locator(".row") - # ... later on ... - await row.locator(":scope", has_text="Hello").click() - ``` - ```python sync - row = page.locator(".row") - # ... later on ... - row.locator(":scope", has_text="Hello").click() - ``` - ```csharp - var locator = page.Locator(".row"); - // ... later on ... - await locator.Locator(":scope", new() { HasText = "Hello" }).ClickAsync(); - ``` - -## Selecting elements matching one of the conditions - -### CSS selector list - -Comma-separated list of CSS selectors will match all elements that can be selected by -one of the selectors in that list. - -```js -// Clicks a -
-
-``` - -In this case, `:nth-match(:text("Buy"), 3)` will select the third button from the snippet above. Note that index is one-based. - -```js -// Click the third "Buy" button -await page.locator(':nth-match(:text("Buy"), 3)').click(); -``` - -```java -// Click the third "Buy" button -page.locator(":nth-match(:text('Buy'), 3)").click(); -``` - -```python async -# Click the third "Buy" button -await page.locator(":nth-match(:text('Buy'), 3)").click() -``` - -```python sync -# Click the third "Buy" button -page.locator(":nth-match(:text('Buy'), 3)").click() -``` - -```csharp -// Click the third "Buy" button -await page.Locator(":nth-match(:text('Buy'), 3)").ClickAsync(); -``` - -`:nth-match()` is also useful to wait until a specified number of elements appear, using [`method: Locator.waitFor`]. - -```js -// Wait until all three buttons are visible -await page.locator(':nth-match(:text("Buy"), 3)').waitFor(); -``` - -```java -// Wait until all three buttons are visible -page.locator(":nth-match(:text('Buy'), 3)").waitFor(); -``` - -```python async -# Wait until all three buttons are visible -await page.locator(":nth-match(:text('Buy'), 3)").wait_for() -``` - -```python sync -# Wait until all three buttons are visible -page.locator(":nth-match(:text('Buy'), 3)").wait_for() -``` - -```csharp -// Wait until all three buttons are visible -await page.Locator(":nth-match(:text('Buy'), 3)").WaitForAsync(); -``` - -:::note -Unlike [`:nth-child()`](https://developer.mozilla.org/en-US/docs/Web/CSS/: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. -::: - -:::note -It is usually possible to distinguish elements by some attribute or text content. In this case, -prefer using [text] or [css] selectors over the `:nth-match()`. -::: - -## Parent selector - -The parent could be selected with `..`, which is a short form for `xpath=..`. - -For example: - -```js -const parentLocator = elementLocator.locator('..'); -``` - -```java -Locator parentLocator = elementLocator.locator(".."); -``` - -```python async -parent_locator = element_locator.locator('..') -``` - -```python sync -parent_locator = element_locator.locator('..') -``` - -```csharp -var parentLocator = elementLocator.Locator(".."); -``` - -## Chaining selectors - -Selectors defined as `engine=body` or in short-form can be combined with the `>>` token, e.g. `selector1 >> selector2 >> selectors3`. When selectors are chained, the next one is queried relative to the previous one's result. - -For example, -``` -css=article >> css=.bar > .baz >> css=span[attr=value] -``` -is equivalent to - -```js browser -document - .querySelector('article') - .querySelector('.bar > .baz') - .querySelector('span[attr=value]') -``` - -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"`. - -### Intermediate matches - -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. - -For example, `css=article >> text=Hello` captures the element with the text `Hello`, and `*css=article >> text=Hello` (note the `*`) captures the `article` element that contains some element with the text `Hello`. - -## Best practices - -The choice of selectors determines the resiliency of automation scripts. To reduce the maintenance burden, we recommend prioritizing user-facing attributes and explicit contracts. - -### Prioritize user-facing attributes -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. - -The following examples use the built-in [text] and [css] selector engines. - -```js -// queries "Login" text selector -await page.locator('text="Login"').click(); -await page.locator('"Login"').click(); // short-form - -// queries "Search GitHub" placeholder attribute -await page.locator('css=[placeholder="Search GitHub"]').fill('query'); -await page.locator('[placeholder="Search GitHub"]').fill('query'); // short-form - -// queries "Close" accessibility label -await page.locator('css=[aria-label="Close"]').click(); -await page.locator('[aria-label="Close"]').click(); // short-form - -// combine role and text queries -await page.locator('css=nav >> text=Login').click(); -``` - -```java -// queries "Login" text selector -page.locator("text=\"Login\"").click(); -page.locator("\"Login\"").click(); // short-form - -// queries "Search GitHub" placeholder attribute -page.locator("css=[placeholder='Search GitHub']").fill("query"); -page.locator("[placeholder='Search GitHub']").fill("query"); // short-form - -// queries "Close" accessibility label -page.locator("css=[aria-label='Close']").click(); -page.locator("[aria-label='Close']").click(); // short-form - -// combine role and text queries -page.locator("css=nav >> text=Login").click(); -``` - -```python async -# queries "Login" text selector -await page.locator('text="Login"').click() -await page.locator('"Login"').click() # short-form - -# queries "Search GitHub" placeholder attribute -await page.locator('css=[placeholder="Search GitHub"]').fill('query') -await page.locator('[placeholder="Search GitHub"]').fill('query') # short-form - -# queries "Close" accessibility label -await page.locator('css=[aria-label="Close"]').click() -await page.locator('[aria-label="Close"]').click() # short-form - -# combine role and text queries -await page.locator('css=nav >> text=Login').click() -``` - -```python sync -# queries "Login" text selector -page.locator('text="Login"').click() -page.locator('"Login"').click() # short-form - -# queries "Search GitHub" placeholder attribute -page.locator('css=[placeholder="Search GitHub"]').fill('query') -page.locator('[placeholder="Search GitHub"]').fill('query') # short-form - -# queries "Close" accessibility label -page.locator('css=[aria-label="Close"]').click() -page.locator('[aria-label="Close"]').click() # short-form - -# combine role and text queries -page.locator('css=nav >> text=Login').click() -``` - -```csharp -// queries "Login" text selector -await page.Locator("text=\"Login\"").ClickAsync(); -await page.Locator("\"Login\"").ClickAsync(); // short-form - -// queries "Search GitHub" placeholder attribute -await page.Locator("css=[placeholder='Search GitHub']").FillAsync("query"); -await page.Locator("[placeholder='Search GitHub']").FillAsync("query"); // short-form - -// queries "Close" accessibility label -await page.Locator("css=[aria-label='Close']").ClickAsync(); -await page.Locator("[aria-label='Close']").ClickAsync(); // short-form - -// combine role and text queries -await page.Locator("css=nav >> text=Login").ClickAsync(); -``` - -### Define explicit contract - -When user-facing attributes change frequently, it is recommended to use explicit test ids, like `data-test-id`. These `data-*` attributes are supported by the [css] and [id selectors][id]. - -```html - -``` - -```js -// queries data-test-id attribute with css -await page.locator('css=[data-test-id=directions]').click(); -await page.locator('[data-test-id=directions]').click(); // short-form - -// queries data-test-id with id -await page.locator('data-test-id=directions').click(); -``` - -```java -// queries data-test-id attribute with css -page.locator("css=[data-test-id=directions]").click(); -page.locator("[data-test-id=directions]").click(); // short-form - -// queries data-test-id with id -page.locator("data-test-id=directions").click(); -``` - -```python async -# queries data-test-id attribute with css -await page.locator('css=[data-test-id=directions]').click() -await page.locator('[data-test-id=directions]').click() # short-form - -# queries data-test-id with id -await page.locator('data-test-id=directions').click() -``` - -```python sync -# queries data-test-id attribute with css -page.locator('css=[data-test-id=directions]').click() -page.locator('[data-test-id=directions]').click() # short-form - -# queries data-test-id with id -page.locator('data-test-id=directions').click() -``` - -```csharp -// queries data-test-id attribute with css -await page.Locator("css=[data-test-id=directions]").ClickAsync(); -await page.Locator("[data-test-id=directions]").ClickAsync(); // short-form - -// queries data-test-id with id -await page.Locator("data-test-id=directions").ClickAsync(); -``` - -### Avoid selectors tied to implementation - -[xpath] and [css] can be tied to the DOM structure or implementation. These selectors can break when -the DOM structure changes. Similarly, [`method: Locator.nth`], [`method: Locator.first`], and [`method: Locator.last`] are tied to implementation and the structure of the DOM, and will target the incorrect element if the DOM changes. - -```js -// avoid long css or xpath chains -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(); -``` - -```java -// avoid long css or xpath chains -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(); -``` - -```python async -# avoid long css or xpath chains -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() -``` - -```python sync -# avoid long css or xpath chains -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() -``` - -```csharp -// avoid long css or xpath chains -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(); -``` - -[text]: #text-selector -[css]: #css-selector -[xpath]: #xpath-selectors -[react]: #react-selectors -[vue]: #vue-selectors -[id]: #id-data-testid-data-test-id-data-test-selectors diff --git a/docs/src/testing-library-js.md b/docs/src/testing-library-js.md index d1fcd453c9..56f8a2875d 100644 --- a/docs/src/testing-library-js.md +++ b/docs/src/testing-library-js.md @@ -85,11 +85,11 @@ Migration highlights (see inline comments in the Playwright Test code snippet): All queries like `getBy...`, `findBy...`, `queryBy...` and their multi-element counterparts are replaced with `page.locator('...')`. Locators always auto-wait and retry when needed, so you don't have to worry about choosing the right method. When you want to do a [list operation](./locators#lists), e.g. assert a list of texts, Playwright automatically performs multi-element opertations. -1. `getByRole`: use [role selector](./selectors#role-selector) `component.locator('role=button[name="Sign up"]')`. -1. `getByText`: use `component.locator('text=some value')` and other variations of the [text selector](./selectors#text-selector). -1. `getByTestId`: use [test id selectors](./selectors#id-data-testid-data-test-id-data-test-selectors), for example `component.locator('data-testid=some value')`. +1. `getByRole`: use [role selector](./locators#role-selector) `component.locator('role=button[name="Sign up"]')`. +1. `getByText`: use `component.locator('text=some value')` and other variations of the [text selector](./locators#text-selector). +1. `getByTestId`: use [test id selectors](./locators#id-data-testid-data-test-id-data-test-selectors), for example `component.locator('data-testid=some value')`. 1. `getByPlaceholderText`: use css alternative `component.locator('[placeholder="some value"]')`. -1. `getByAltText`: use css alternative `component.locator('[alt="some value"]')` or [role selector](./selectors#role-selector) `component.locator('role=img[name="some value"]')`. +1. `getByAltText`: use css alternative `component.locator('[alt="some value"]')` or [role selector](./locators#role-selector) `component.locator('role=img[name="some value"]')`. 1. `getByTitle`: use css alternative `component.locator('[title="some value"]')` ## Replacing `waitFor` diff --git a/docs/src/why-playwright.md b/docs/src/why-playwright.md index 755f20000f..492e76c032 100644 --- a/docs/src/why-playwright.md +++ b/docs/src/why-playwright.md @@ -24,13 +24,13 @@ Playwright enables fast, reliable and capable testing and automation across all * **Fast isolation with browser contexts**. Reuse a single browser instance for multiple isolated execution environments with [browser contexts](./browser-contexts.md). -* **Resilient element selectors**. Playwright can rely on user-facing strings, like text content and accessibility labels to [select elements](./selectors.md). These strings are more resilient than selectors tightly-coupled to the DOM structure. +* **Resilient element selectors**. Playwright can rely on user-facing strings, like text content and accessibility labels to [select elements](./locators.md#selectors). These strings are more resilient than selectors tightly-coupled to the DOM structure. ## Powerful automation capabilities * **Multiple domains, pages and frames**. Playwright is an out-of-process automation driver that is not limited by the scope of in-page JavaScript execution and can automate scenarios with [multiple pages](./pages.md). * **Powerful network control**. Playwright introduces context-wide [network interception](./network.md) to stub and mock network requests. -* **Modern web features**. Playwright supports web components through [shadow-piercing selectors](./selectors.md), [geolocation, permissions](./emulation.md), web workers and other modern web APIs. +* **Modern web features**. Playwright supports web components through [shadow-piercing selectors](./locators.md#selectors), [geolocation, permissions](./emulation.md), web workers and other modern web APIs. * **Capabilities to cover all scenarios**. Support for [file downloads](./downloads.md) and [uploads](./input.md), out-of-process iframes, native [input events](./input.md), and even [dark mode](./emulation.md). diff --git a/docs/src/writing-tests-csharp.md b/docs/src/writing-tests-csharp.md index b3e3aed8c2..573c739bed 100644 --- a/docs/src/writing-tests-csharp.md +++ b/docs/src/writing-tests-csharp.md @@ -106,7 +106,7 @@ await Expect(getStarted).ToHaveAttributeAsync("href", "/docs/installation"); await getStarted.ClickAsync(); ``` -[Selectors](./selectors.md) are strings that are used to create Locators. Playwright supports many different selectors like [Text](./selectors.md#text-selector), [CSS](./selectors.md#css-selector), [XPath](./selectors.md#xpath-selectors) and many more. Learn more about available selectors and how to pick one in this [in-depth guide](./selectors.md). +[Selectors](./locators.md#selectors) are strings that are used to create Locators. Playwright supports many different selectors like [Text](./locators.md#text-selector), [CSS](./locators.md#css-selector), [XPath](./locators.md#xpath-selectors) and many more. Learn more about available selectors and how to pick one in this [in-depth guide](./locators.md#selectors). ```csharp await Expect(Page.Locator("text=Installation")).ToBeVisibleAsync(); diff --git a/docs/src/writing-tests-js.md b/docs/src/writing-tests-js.md index 6ed96a4667..0b85c0a13a 100644 --- a/docs/src/writing-tests-js.md +++ b/docs/src/writing-tests-js.md @@ -15,7 +15,7 @@ Playwright assertions are created specifically for the dynamic web. Checks are a ## The Example Test -Take a look at the example test included when installing Playwright to see how to write a test using [web first assertions](/test-assertions.md), [locators](/locators.md) and [selectors](/selectors.md). +Take a look at the example test included when installing Playwright to see how to write a test using [web first assertions](/test-assertions.md), [locators](/locators.md) and [selectors](/locators.md#selectors). ```js tab=js-js // @ts-check @@ -88,7 +88,7 @@ await expect(getStarted).toHaveAttribute('href', '/docs/installation'); await getStarted.click(); ``` -[Selectors](./selectors.md) are strings that are used to create Locators. Playwright supports many different selectors like [Text](./selectors.md#text-selector), [CSS](./selectors.md#css-selector), [XPath](./selectors.md#xpath-selectors) and many more. Learn more about available selectors and how to pick one in this [in-depth guide](./selectors.md). +[Selectors](./locators.md#selectors) are strings that are used to create Locators. Playwright supports many different selectors like [Text](./locators.md#text-selector), [CSS](./locators.md#css-selector), [XPath](./locators.md#xpath-selectors) and many more. Learn more about available selectors and how to pick one in this [in-depth guide](./locators.md#selectors). ```js diff --git a/docs/src/writing-tests-python.md b/docs/src/writing-tests-python.md index 1fc0deb137..ec3721de9e 100644 --- a/docs/src/writing-tests-python.md +++ b/docs/src/writing-tests-python.md @@ -57,7 +57,7 @@ expect(get_started).to_have_attribute("href", "/docs/installation") get_started.click() ``` -[Selectors](./selectors.md) are strings that are used to create Locators. Playwright supports many different selectors like [Text](./selectors.md#text-selector), [CSS](./selectors.md#css-selector), [XPath](./selectors.md#xpath-selectors) and many more. Learn more about available selectors and how to pick one in this [in-depth guide](./selectors.md). +[Selectors](./locators.md#selectors) are strings that are used to create Locators. Playwright supports many different selectors like [Text](./locators.md#text-selector), [CSS](./locators.md#css-selector), [XPath](./locators.md#xpath-selectors) and many more. Learn more about available selectors and how to pick one in this [in-depth guide](./locators.md#selectors). ```python