Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs: selectors guide merge (#16571)

Browse source 
Co-authored-by: Max Schmitt <max@schmitt.mx>
This commit is contained in:
Debbie O'Brien 2022-08-16 16:14:02 +02:00 committed by GitHub
parent ab53f195b3
commit 26623a0a77
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
23 changed files with 1472 additions and 1476 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/src/api/class-elementhandle.md
View file

@ -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-%%

8
docs/src/api/class-frame.md
View file

@ -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-%%

2
docs/src/api/class-playwright.md
View file

@ -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

2
docs/src/api/class-selectors.md
View file

@ -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

10
docs/src/api/params.md
View file

@ -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">>

16
docs/src/ci-intro-js.md
View file

@ -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)

6
docs/src/debug.md
View file

@ -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.
<img width="557" alt="Paused on line" src="https://user-images.githubusercontent.com/883973/108614337-71761580-73ae-11eb-9f61-3d29c52c9520.png"></img>

2
docs/src/getting-started-vscode-js.md
View file

@ -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.
<img width="860" alt="image" src="https://user-images.githubusercontent.com/13063165/182151374-03273172-38cd-4f27-add5-cb3d3cdc7bcd.png" />

1403
docs/src/locators.md
View file

File diff suppressed because it is too large Load diff

2
docs/src/protractor-js.md
View file

@ -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)

14
docs/src/release-notes-csharp.md
View file

@ -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

20
docs/src/release-notes-java.md
View file

@ -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.

20
docs/src/release-notes-js.md
View file

@ -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.

20
docs/src/release-notes-python.md
View file

@ -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.

2
docs/src/running-tests-csharp.md
View file

@ -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

2
docs/src/running-tests-js.md
View file

@ -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:

2
docs/src/running-tests-python.md
View file

@ -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

1389
docs/src/selectors.md
View file

File diff suppressed because it is too large Load diff

8
docs/src/testing-library-js.md
View file

@ -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`

4
docs/src/why-playwright.md
View file

@ -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).

2
docs/src/writing-tests-csharp.md
View file

@ -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();

4
docs/src/writing-tests-js.md
View file

@ -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

2
docs/src/writing-tests-python.md
View file

@ -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