From 3cd8d6e5136535dfaab22196929510a7b1754986 Mon Sep 17 00:00:00 2001 From: Pavel Feldman Date: Tue, 16 Aug 2022 22:00:54 -0700 Subject: [PATCH] chore(docs): revert recent changes temporarily (#16590) --- docs/src/api/class-elementhandle.md | 8 +- docs/src/api/class-frame.md | 8 +- docs/src/api/class-playwright.md | 2 +- docs/src/api/class-selectors.md | 2 +- docs/src/api/params.md | 10 +- docs/src/auth.md | 392 +++++ docs/src/browser-contexts.md | 4 +- docs/src/ci-intro-js.md | 16 +- docs/src/debug.md | 6 +- docs/src/getting-started-vscode-js.md | 2 +- docs/src/locators.md | 1403 +---------------- docs/src/pom.md | 196 +++ docs/src/protractor-js.md | 4 +- docs/src/release-notes-csharp.md | 16 +- docs/src/release-notes-java.md | 22 +- docs/src/release-notes-js.md | 22 +- docs/src/release-notes-python.md | 22 +- docs/src/running-tests-csharp.md | 2 +- docs/src/running-tests-js.md | 2 +- docs/src/running-tests-python.md | 2 +- docs/src/screenshots.md | 120 ++ docs/src/selectors.md | 1389 ++++++++++++++++ docs/src/{test-auth.md => test-auth-js.md} | 389 +---- docs/src/test-configuration-js.md | 2 +- docs/src/{test-pom.md => test-pom-js.md} | 151 +- ...test-snapshots.md => test-snapshots-js.md} | 120 -- docs/src/testing-library-js.md | 12 +- docs/src/why-playwright.md | 4 +- docs/src/writing-tests-csharp.md | 2 +- docs/src/writing-tests-js.md | 4 +- docs/src/writing-tests-python.md | 2 +- packages/playwright-core/types/types.d.ts | 300 ++-- 32 files changed, 2348 insertions(+), 2288 deletions(-) create mode 100644 docs/src/auth.md create mode 100644 docs/src/pom.md create mode 100644 docs/src/screenshots.md create mode 100644 docs/src/selectors.md rename docs/src/{test-auth.md => test-auth-js.md} (58%) rename docs/src/{test-pom.md => test-pom-js.md} (53%) rename docs/src/{test-snapshots.md => test-snapshots-js.md} (67%) diff --git a/docs/src/api/class-elementhandle.md b/docs/src/api/class-elementhandle.md index 4c9e8075ea..21683c3d30 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](../locators.md#selectors) for more +argument to [`param: expression`]. See [Working with selectors](../selectors.md) 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](../locators.md#selectors) for more details. +[Working with selectors](../selectors.md) 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](../locators.md#selectors) for more details. If no elements match the selector, +[Working with selectors](../selectors.md) 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](../locators.md#selectors) for more details. If no elements match the selector, +[Working with selectors](../selectors.md) 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 ef2a2f9bba..12a4a7d109 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](../locators.md#selectors) for more details. If no +[`param: expression`]. See [Working with selectors](../selectors.md) 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](../locators.md#selectors) for +as a first argument to [`param: expression`]. See [Working with selectors](../selectors.md) 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](../locators.md#selectors) for more details. If no elements match the selector, +[Working with selectors](../selectors.md) 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](../locators.md#selectors) for more details. If no elements match the selector, +[Working with selectors](../selectors.md) 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 f8d0be43ed..ca1e866ddd 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](../locators.md#selectors) for more information. +[Working with selectors](../selectors.md) 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 cc79568b3d..51241b070d 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](../locators.md#selectors) for more +Selectors can be used to install custom selector engines. See [Working with selectors](../selectors.md) for more information. ## async method: Selectors.register diff --git a/docs/src/api/params.md b/docs/src/api/params.md index 19670aca87..f976220672 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](../locators.md#selectors) for more details. +[working with selectors](../selectors.md) 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](../locators.md#selectors) for more details. +[working with selectors](../selectors.md) 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](../locators.md#selectors) for more details. +[working with selectors](../selectors.md) 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](../locators.md#selectors) for more details. +A selector to query for. See [working with selectors](../selectors.md) for more details. ## find-selector - `selector` <[string]> -A selector to use when resolving DOM element. See [working with selectors](../locators.md#selectors) for more details. +A selector to use when resolving DOM element. See [working with selectors](../selectors.md) for more details. ## wait-for-selector-state - `state` <[WaitForSelectorState]<"attached"|"detached"|"visible"|"hidden">> diff --git a/docs/src/auth.md b/docs/src/auth.md new file mode 100644 index 0000000000..321ba04577 --- /dev/null +++ b/docs/src/auth.md @@ -0,0 +1,392 @@ +--- +id: auth +title: "Authentication" +--- + +Playwright can be used to automate scenarios that require authentication. + +Tests written with Playwright execute in isolated clean-slate environments called +[browser contexts](./browser-contexts.md). This isolation model +improves reproducibility and prevents cascading test failures. New browser +contexts can load existing authentication state. This eliminates the need to +login in every context and speeds up test execution. + +> Note: This guide covers cookie/token-based authentication (logging in via the +app UI). For [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) use [`method: Browser.newContext`]. + + + +## Playwright Test vs. Library +* langs: js + +:::caution +This guide is for [Playwright Library](./library.md), if you are using Playwright Test (`@playwright/test`) see [here](./test-auth.md). +::: + +## Automate logging in + +The Playwright API can automate interaction with a login form. See +[Input guide](./input.md) for more details. + +The following example automates login on GitHub. Once these steps are executed, +the browser context will be authenticated. + +```js +const page = await context.newPage(); +await page.goto('https://github.com/login'); + +// Interact with login form +await page.locator('text=Login').click(); +await page.locator('input[name="login"]').fill(USERNAME); +await page.locator('input[name="password"]').fill(PASSWORD); +await page.locator('text=Submit').click(); +// Verify app is logged in +``` + +```java +Page page = context.newPage(); +page.navigate("https://github.com/login"); +// Interact with login form +page.locator("text=Login").click(); +page.locator("input[name='login']").fill(USERNAME); +page.locator("input[name='password']").fill(PASSWORD); +page.locator("text=Submit").click(); +// Verify app is logged in +``` + +```python async +page = await context.new_page() +await page.goto('https://github.com/login') + +# Interact with login form +await page.locator('text=Login').click() +await page.locator('input[name="login"]').fill(USERNAME) +await page.locator('input[name="password"]').fill(PASSWORD) +await page.locator('text=Submit').click() +# Verify app is logged in +``` + +```python sync +page = context.new_page() +page.goto('https://github.com/login') + +# Interact with login form +page.locator('text=Login').click() +page.locator('input[name="login"]').fill(USERNAME) +page.locator('input[name="password"]').fill(PASSWORD) +page.locator('text=Submit').click() +# Verify app is logged in +``` + +```csharp +var page = await context.NewPageAsync(); +await page.GotoAsync("https://github.com/login"); +// Interact with login form +await page.Locator("text=Login").ClickAsync(); +await page.Locator("input[name='login']").FillAsync(USERNAME); +await page.Locator("input[name='password']").FillAsync(PASSWORD); +await page.Locator("text=Submit").ClickAsync(); +// Verify app is logged in +``` + +These steps can be executed for every browser context. However, redoing login +for every test can slow down test execution. To prevent that, we will reuse +existing authentication state in new browser contexts. + +## Reuse authentication state + +Web apps use cookie-based or token-based authentication, where authenticated +state is stored as [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies) +or in [local storage](https://developer.mozilla.org/en-US/docs/Web/API/Storage). +Playwright provides [`method: BrowserContext.storageState`] method that can be used to retrieve storage state from authenticated contexts and then create new contexts with prepopulated state. + +Cookies and local storage state can be used across different browsers. They depend +on your application's authentication model: some apps might require both cookies +and local storage. + +The following code snippet retrieves state from an authenticated context and +creates a new context with that state. + +```js +// Save storage state into the file. +await context.storageState({ path: 'state.json' }); + +// Create a new context with the saved storage state. +const context = await browser.newContext({ storageState: 'state.json' }); +``` + +```java +// Save storage state into the file. +context.storageState(new BrowserContext.StorageStateOptions().setPath(Paths.get("state.json"))); + +// Create a new context with the saved storage state. +BrowserContext context = browser.newContext( + new Browser.NewContextOptions().setStorageStatePath(Paths.get("state.json"))); +``` + +```python async +# Save storage state into the file. +storage = await context.storage_state(path="state.json") + +# Create a new context with the saved storage state. +context = await browser.new_context(storage_state="state.json") +``` + +```python sync +# Save storage state into the file. +storage = context.storage_state(path="state.json") + +# Create a new context with the saved storage state. +context = browser.new_context(storage_state="state.json") +``` + +```csharp +// Save storage state into the file. +await context.StorageStateAsync(new() +{ + Path = "state.json" +}); + +// Create a new context with the saved storage state. +var context = await browser.NewContextAsync(new() +{ + StorageStatePath = "state.json" +}); +``` + +### Code generation +* langs: js + +Logging in via the UI and then reusing authentication state can be combined to +implement **login once and run multiple scenarios**. The lifecycle looks like: + +1. Run tests (for example, with `npm run test`). +2. Login via UI and retrieve authentication state. + * In Jest, this can be executed in [`globalSetup`](https://jestjs.io/docs/en/configuration#globalsetup-string). +3. In each test, load authentication state in `beforeEach` or `beforeAll` step. + +This approach will also **work in CI environments**, since it does not rely on any external state. + +### Code generation +* langs: python + +Logging in via the UI and then reusing authentication state can be combined to implement **login once and run multiple scenarios**. The lifecycle looks like: + +1. Run tests (for example, with `pytest`). +2. Login via UI and retrieve authentication state. +3. In each test, load authentication state using `autouse=True` fixture with `scope=function`. + +This approach will also **work in CI environments**, since it does not rely on any external state. + +### Code generation +* langs: csharp + +Logging in via the UI and then reusing authentication state can be combined to implement **login once and run multiple scenarios**. The lifecycle looks like: + +1. Run tests (for example, with `dotnet test`). +2. Login via UI and retrieve authentication state. +3. In each test, load authentication state in `SetUp`. + +This approach will also **work in CI environments**, since it does not rely on any external state. + +### Code generation +* langs: java + +Logging in via the UI and then reusing authentication state can be combined to implement **login once and run multiple scenarios**. The lifecycle looks like: + +1. Run tests (for example, with `mvn test`). +2. Login via UI and retrieve authentication state. +3. In each test, load authentication state in `@beforeEach` or `@beforeAll` step. + +This approach will also **work in CI environments**, since it does not rely on any external state. + +### API reference +- [`method: BrowserContext.storageState`] +- [`method: Browser.newContext`] + +## Session storage + +Rarely, [session storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage) is used for storing information +associated with the logged-in state. Session storage is specific to a particular domain and is not persisted across page loads. +Playwright does not provide API to persist session storage, but the following snippet can be used to +save/load session storage. + +```js +// Get session storage and store as env variable +const sessionStorage = await page.evaluate(() => JSON.stringify(sessionStorage)); +process.env.SESSION_STORAGE = sessionStorage; + +// Set session storage in a new context +const sessionStorage = process.env.SESSION_STORAGE; +await context.addInitScript(storage => { + if (window.location.hostname === 'example.com') { + const entries = JSON.parse(storage); + for (const [key, value] of Object.entries(entries)) { + window.sessionStorage.setItem(key, value); + } + } +}, sessionStorage); +``` + +```java +// Get session storage and store as env variable +String sessionStorage = (String) page.evaluate("JSON.stringify(sessionStorage)"); +System.getenv().put("SESSION_STORAGE", sessionStorage); + +// Set session storage in a new context +String sessionStorage = System.getenv("SESSION_STORAGE"); +context.addInitScript("(storage => {\n" + + " if (window.location.hostname === 'example.com') {\n" + + " const entries = JSON.parse(storage);\n" + + " for (const [key, value] of Object.entries(entries)) {\n" + + " window.sessionStorage.setItem(key, value);\n" + + " };\n" + + " }\n" + + "})('" + sessionStorage + "')"); +``` + +```python async +import os +# Get session storage and store as env variable +session_storage = await page.evaluate("() => JSON.stringify(sessionStorage)") +os.environ["SESSION_STORAGE"] = session_storage + +# Set session storage in a new context +session_storage = os.environ["SESSION_STORAGE"] +await context.add_init_script("""(storage => { + if (window.location.hostname === 'example.com') { + const entries = JSON.parse(storage) + for (const [key, value] of Object.entries(entries)) { + window.sessionStorage.setItem(key, key) + } + } +})('""" + session_storage + "')") +``` + +```python sync +import os +# Get session storage and store as env variable +session_storage = page.evaluate("() => JSON.stringify(sessionStorage)") +os.environ["SESSION_STORAGE"] = session_storage + +# Set session storage in a new context +session_storage = os.environ["SESSION_STORAGE"] +context.add_init_script("""(storage => { + if (window.location.hostname === 'example.com') { + const entries = JSON.parse(storage) + for (const [key, value] of Object.entries(entries)) { + window.sessionStorage.setItem(key, key) + } + } +})('""" + session_storage + "')") +``` + +```csharp +// Get session storage and store as env variable +var sessionStorage = await page.EvaluateAsync("() => JSON.stringify(sessionStorage)"); +Environment.SetEnvironmentVariable("SESSION_STORAGE", sessionStorage); + +// Set session storage in a new context +var loadedSessionStorage = Environment.GetEnvironmentVariable("SESSION_STORAGE"); +await context.AddInitScriptAsync(@"(storage => { + if (window.location.hostname === 'example.com') { + const entries = JSON.parse(storage); + for (const [key, value] of Object.entries(entries)) { + window.sessionStorage.setItem(key, value); + } + } + })('" + loadedSessionStorage + "')"); +``` + +### API reference +- [`method: BrowserContext.storageState`] +- [`method: Browser.newContext`] +- [`method: Page.evaluate`] +- [`method: BrowserContext.addInitScript`] + +## Multi-factor authentication + +Accounts with multi-factor authentication (MFA) cannot be fully automated, and need +manual intervention. Persistent authentication can be used to partially automate +MFA scenarios. + +### Persistent authentication + +Note that persistent authentication is not suited for CI environments since it +relies on a disk location. User data directories are specific to browser types +and cannot be shared across browser types. + +User data directories can be used with the [`method: BrowserType.launchPersistentContext`] API. + +```js +const { chromium } = require('playwright'); + +const userDataDir = '/path/to/directory'; +const context = await chromium.launchPersistentContext(userDataDir, { headless: false }); +// Execute login steps manually in the browser window +``` + +```java +import com.microsoft.playwright.*; + +public class Example { + public static void main(String[] args) { + try (Playwright playwright = Playwright.create()) { + BrowserType chromium = playwright.chromium(); + Path userDataDir = Paths.get("/path/to/directory"); + BrowserContext context = chromium.launchPersistentContext(userDataDir, + new BrowserType.LaunchPersistentContextOptions().setHeadless(false)); + // Execute login steps manually in the browser window + } + } +} +``` + +```python async +import asyncio +from playwright.async_api import async_playwright + +async def main(): + async with async_playwright() as p: + user_data_dir = '/path/to/directory' + browser = await p.chromium.launch_persistent_context(user_data_dir, headless=False) + # Execute login steps manually in the browser window + +asyncio.run(main()) +``` + +```python sync +from playwright.sync_api import sync_playwright + +with sync_playwright() as p: + user_data_dir = '/path/to/directory' + browser = p.chromium.launch_persistent_context(user_data_dir, headless=False) + # Execute login steps manually in the browser window +``` + +```csharp +using Microsoft.Playwright; + +class Program +{ + public static async Task Main() + { + using var playwright = await Playwright.CreateAsync(); + var chromium = playwright.Chromium; + var context = chromium.LaunchPersistentContextAsync(@"C:\path\to\directory\", new() + { + Headless = false + }); + } +} +``` + +### Lifecycle + +1. Create a user data directory on disk. +1. Launch a persistent context with the user data directory and login the MFA account. +1. Reuse user data directory to run automation scenarios. + +### API reference +- [BrowserContext] +- [`method: BrowserType.launchPersistentContext`] diff --git a/docs/src/browser-contexts.md b/docs/src/browser-contexts.md index 0fa80a8843..e54c5b6030 100644 --- a/docs/src/browser-contexts.md +++ b/docs/src/browser-contexts.md @@ -1,6 +1,6 @@ --- -id: isolation -title: "Isolation" +id: browser-contexts +title: "Browser Contexts" --- diff --git a/docs/src/ci-intro-js.md b/docs/src/ci-intro-js.md index ec6c8c363f..9d81c35843 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](./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) +- [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) ## 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 411672301b..970fc2b23b 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](./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). +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). ## 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](./locators.md#selectors). This can be used to verify text or + [Playwright selectors](./selectors.md). 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](./locators.md#selectors) 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](./selectors.md) 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 5c409329a2..b33fb4158f 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](./locators.md#selectors) 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](./selectors.md) underneath it. image diff --git a/docs/src/locators.md b/docs/src/locators.md index b94a6ef10e..e3018b803c 100644 --- a/docs/src/locators.md +++ b/docs/src/locators.md @@ -3,9 +3,8 @@ 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. - -### Using 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. ```js const locator = page.locator('text=Submit'); @@ -68,9 +67,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](#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). +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). ```js // Find by text. @@ -127,7 +126,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 @@ -189,10 +188,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). +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). ::: -### Lists +## Lists You can also use locators to work with the element lists. @@ -281,7 +280,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. @@ -368,7 +367,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 @@ -442,1387 +441,3 @@ 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/pom.md b/docs/src/pom.md new file mode 100644 index 0000000000..de866f1a2e --- /dev/null +++ b/docs/src/pom.md @@ -0,0 +1,196 @@ +--- +id: pom +title: "Page Object Models" +--- + +Large test suites can be structured to optimize ease of authoring and maintenance. Page object models are one such +approach to structure your test suite. + + + +## Playwright Test vs. Library +* langs: js + +:::caution +This guide is for [Playwright Library](./library.md), if you are using Playwright Test (`@playwright/test`) see [here](./test-pom.md). +::: + +## Introduction + +A page object represents a part of your web application. An e-commerce web application might have a home page, a +listings page and a checkout page. Each of them can be represented by page object models. + +Page objects **simplify authoring**. They create a higher-level API which suits your application. + +Page objects **simplify maintenance**. They capture element selectors in one place and create reusable code to avoid +repetition. + +## Implementation + +Page object models wrap over a Playwright [Page]. + +```js +// models/Search.js +class SearchPage { + /** + * @param {import('playwright').Page} page + */ + constructor(page) { + this.page = page; + this.searchTermInput = page.locator('[aria-label="Enter your search term"]'); + } + async navigate() { + await this.page.goto('https://bing.com'); + } + async search(text) { + await this.searchTermInput.fill(text); + await this.searchTermInput.press('Enter'); + } +} +module.exports = { SearchPage }; +``` + +```java +// models/SearchPage.java +package models; + +import com.microsoft.playwright; + +public class SearchPage { + private final Page page; + private final Locator searchTermInput; + + public SearchPage(Page page) { + this.page = page; + this.searchTermInput = page.locator("[aria-label='Enter your search term']"); + } + + public void navigate() { + page.navigate("https://bing.com"); + } + + public void search(String text) { + searchTermInput.fill(text); + searchTermInput.press("Enter"); + } +} +``` + +```python async +# models/search.py +class SearchPage: + def __init__(self, page): + self.page = page + self.search_term_input = page.locator('[aria-label="Enter your search term"]') + + async def navigate(self): + await self.page.goto("https://bing.com") + + async def search(self, text): + await self.search_term_input.fill(text) + await self.search_term_input.press("Enter") +``` + +```python sync +# models/search.py +class SearchPage: + def __init__(self, page): + self.page = page + self.search_term_input = page.locator('[aria-label="Enter your search term"]') + + def navigate(self): + self.page.goto("https://bing.com") + + def search(self, text): + self.search_term_input.fill(text) + self.search_term_input.press("Enter") +``` + +```csharp +using System.Threading.Tasks; +using Microsoft.Playwright; + +namespace BigEcommerceApp.Tests.Models; + +public class SearchPage +{ + private readonly IPage _page; + private readonly ILocator _searchTermInput; + + public SearchPage(IPage page) + { + _page = page; + _searchTermInput = page.Locator("[aria-label='Enter your search term']"); + } + + public async Task GotoAsync() + { + await _page.GotoAsync("https://bing.com"); + } + + public async Task SearchAsync(string text) + { + await _searchTermInput.FillAsync(text); + await _searchTermInput.PressAsync("Enter"); + } +} +``` + +Page objects can then be used inside a test. + +```js +// search.spec.js +const { SearchPage } = require('./models/Search'); + +// In the test +const page = await browser.newPage(); +const searchPage = new SearchPage(page); +await searchPage.navigate(); +await searchPage.search('search query'); +``` + +```java +import models.SearchPage; +import com.microsoft.playwright.*; +... + +// In the test +Page page = browser.newPage(); +SearchPage searchPage = new SearchPage(page); +searchPage.navigate(); +searchPage.search("search query"); +``` + +```python async +# test_search.py +from models.search import SearchPage + +# in the test +page = await browser.new_page() +search_page = SearchPage(page) +await search_page.navigate() +await search_page.search("search query") +``` + +```python sync +# test_search.py +from models.search import SearchPage + +# in the test +page = browser.new_page() +search_page = SearchPage(page) +search_page.navigate() +search_page.search("search query") +``` + +```csharp +using BigEcommerceApp.Tests.Models; + +// in the test +var page = new SearchPage(await browser.NewPageAsync()); +await page.GotoAsync(); +await page.SearchAsync("search query"); +``` + +### API reference +- [Page] diff --git a/docs/src/protractor-js.md b/docs/src/protractor-js.md index be5470679a..47527c3da6 100644 --- a/docs/src/protractor-js.md +++ b/docs/src/protractor-js.md @@ -153,7 +153,7 @@ Once you're on Playwright Test, you get a lot! Also you get all these ✨ awesome tools ✨ that come bundled with Playwright Test: - [Playwright Inspector](./debug.md) -- [Playwright Test Code generation](./test-auth#code-generation) +- [Playwright Test Code generation](./auth#code-generation) - [Playwright Tracing](./trace-viewer) for post-mortem debugging ## Further Reading @@ -163,7 +163,7 @@ Learn more about Playwright Test runner: - [Getting Started](./intro) - [Fixtures](./test-fixtures) - [Locators](./api/class-locator) -- [Selectors](./locators.md#selectors) +- [Selectors](./selectors) - [Assertions](./test-assertions) - [Auto-waiting](./actionability) diff --git a/docs/src/release-notes-csharp.md b/docs/src/release-notes-csharp.md index 30d5d26469..0380ab4cfa 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](./locators#role-selector). + Read more in [our documentation](./selectors#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](./locators#role-selector). + Read more in [our documentation](./selectors#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**](./locators#react-selectors) and [**Vue**](./locators#vue-selectors) selector engines +#### 🧩 Experimental [**React**](./selectors#react-selectors) and [**Vue**](./selectors#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](./locators#react-selectors) and the [vue selectors documentation](./locators#vue-selectors). +Learn more in the [react selectors documentation](./selectors#react-selectors) and the [vue selectors documentation](./selectors#vue-selectors). -#### ✨ New [**`nth`**](./locators#n-th-element-selector) and [**`visible`**](./locators#selecting-visible-elements) selector engines +#### ✨ New [**`nth`**](./selectors#n-th-element-selector) and [**`visible`**](./selectors#selecting-visible-elements) 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. +- [`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. ```csharp // select the first button among all buttons @@ -559,7 +559,7 @@ await button.ClickAsync("button >> visible=true"); #### New and Overhauled Guides - [Intro](./intro.md) -- [Authentication](./test-auth.md) +- [Authentication](./auth.md) #### Browser Versions diff --git a/docs/src/release-notes-java.md b/docs/src/release-notes-java.md index 573e30c1da..1e57cb3fda 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](./locators#role-selector). + Read more in [our documentation](./selectors#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](./locators#role-selector). + Read more in [our documentation](./selectors#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**](./locators#react-selectors) and [**Vue**](./locators#vue-selectors) selector engines +#### 🧩 Experimental [**React**](./selectors#react-selectors) and [**Vue**](./selectors#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](./locators#react-selectors) and the [vue selectors documentation](./locators#vue-selectors). +Learn more in the [react selectors documentation](./selectors#react-selectors) and the [vue selectors documentation](./selectors#vue-selectors). -#### ✨ New [**`nth`**](./locators#n-th-element-selector) and [**`visible`**](./locators#selecting-visible-elements) selector engines +#### ✨ New [**`nth`**](./selectors#n-th-element-selector) and [**`visible`**](./selectors#selecting-visible-elements) 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. +- [`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. ```java // select the first button among all buttons @@ -523,7 +523,7 @@ button.click("button >> visible=true"); #### New and Overhauled Guides - [Intro](./intro.md) -- [Authentication](./test-auth.md) +- [Authentication](./auth.md) #### Browser Versions @@ -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](./locators.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](./selectors.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](./locators.md#selecting-elements-based-on-layout) with `:left-of()`, `:right-of()`, `:above()` and `:below()`. +- [Selecting elements based on layout](./selectors.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](./locators.md#selectors) 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](./selectors.md) 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 8e4c3279f0..18c6479cd2 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](./locators#role-selector). + Read more in [our documentation](./selectors#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](./locators#role-selector). + Read more in [our documentation](./selectors#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**](./locators#react-selectors) and [**Vue**](./locators#vue-selectors) selector engines +#### 🧩 Experimental [**React**](./selectors#react-selectors) and [**Vue**](./selectors#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](./locators#react-selectors) and the [vue selectors documentation](./locators#vue-selectors). +Learn more in the [react selectors documentation](./selectors#react-selectors) and the [vue selectors documentation](./selectors#vue-selectors). -#### ✨ New [**`nth`**](./locators#n-th-element-selector) and [**`visible`**](./locators#selecting-visible-elements) selector engines +#### ✨ New [**`nth`**](./selectors#n-th-element-selector) and [**`visible`**](./selectors#selecting-visible-elements) 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. +- [`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. ```js // select the first button among all buttons @@ -1121,7 +1121,7 @@ Learn more in the [documentation](./test-advanced#launching-a-development-web-se #### New and Overhauled Guides - [Intro](./intro.md) -- [Authentication](./test-auth.md) +- [Authentication](./auth.md) - [Chrome Extensions](./chrome-extensions.md) - [Playwright Test Annotations](./test-annotations.md) - [Playwright Test Configuration](./test-configuration.md) @@ -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](./locators.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](./selectors.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](./locators.md#selecting-elements-based-on-layout) with `:left-of()`, `:right-of()`, `:above()` and `:below()`. +- [Selecting elements based on layout](./selectors.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](./locators.md#selectors) 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](./selectors.md) 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 7199352e6b..c025a5a1a8 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](./locators#role-selector). + Read more in [our documentation](./selectors#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](./locators#role-selector). + Read more in [our documentation](./selectors#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**](./locators#react-selectors) and [**Vue**](./locators#vue-selectors) selector engines +#### 🧩 Experimental [**React**](./selectors#react-selectors) and [**Vue**](./selectors#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](./locators#react-selectors) and the [vue selectors documentation](./locators#vue-selectors). +Learn more in the [react selectors documentation](./selectors#react-selectors) and the [vue selectors documentation](./selectors#vue-selectors). -#### ✨ New [**`nth`**](./locators#n-th-element-selector) and [**`visible`**](./locators#selecting-visible-elements) selector engines +#### ✨ New [**`nth`**](./selectors#n-th-element-selector) and [**`visible`**](./selectors#selecting-visible-elements) 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. +- [`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. ```py # select the first button among all buttons @@ -596,7 +596,7 @@ button.click("button >> visible=true") #### New and Overhauled Guides - [Intro](./intro.md) -- [Authentication](./test-auth.md) +- [Authentication](./auth.md) - [Chrome Extensions](./chrome-extensions.md) @@ -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](./locators.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](./selectors.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](./locators.md#selecting-elements-based-on-layout) with `:left-of()`, `:right-of()`, `:above()` and `:below()`. +- [Selecting elements based on layout](./selectors.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](./locators.md#selectors) 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](./selectors.md) 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 827fb8a085..b5129b2042 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](./locators.md#selectors). +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). ```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 0485610693..739bffee71 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](./locators.md#selectors). +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). - Debugging all tests: diff --git a/docs/src/running-tests-python.md b/docs/src/running-tests-python.md index cd43cd0cb1..e250baa94f 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](./locators.md#selectors). +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). ```bash tab=bash-bash lang=python diff --git a/docs/src/screenshots.md b/docs/src/screenshots.md new file mode 100644 index 0000000000..b9a9296405 --- /dev/null +++ b/docs/src/screenshots.md @@ -0,0 +1,120 @@ +--- +id: screenshots +title: "Screenshots" +--- + +Here is a quick way to capture a screenshot and save it into a file: + +```js +await page.screenshot({ path: 'screenshot.png' }); +``` + +```python async +await page.screenshot(path="screenshot.png") +``` + +```python sync +page.screenshot(path="screenshot.png") +``` + +```java +page.screenshot(new Page.ScreenshotOptions() + .setPath(Paths.get("screenshot.png"))) +``` + +```csharp +await Page.ScreenshotAsync(new() +{ + Path = "screenshot.png", +}); +``` + +Screenshots API accepts many parameters for image format, clip area, quality, etc. Make sure to check them out. + + + +## Full page screenshots + +Full page screenshot is a screenshot of a full scrollable page, as if you had a very +tall screen and the page could fit it entirely. + +```js +await page.screenshot({ path: 'screenshot.png', fullPage: true }); +``` + +```java +page.screenshot(new Page.ScreenshotOptions() + .setPath(Paths.get("screenshot.png")) + .setFullPage(true)); +``` + +```python async +await page.screenshot(path="screenshot.png", full_page=True) +``` + +```python sync +page.screenshot(path="screenshot.png", full_page=True) +``` + +```csharp +await Page.ScreenshotAsync(new() +{ + Path = "screenshot.png", + FullPage = true, +}); +``` + +## Capture into buffer + +Rather than writing into a file, you can get a buffer with the image and post-process it or pass it to a third party pixel diff facility. + +```js +const buffer = await page.screenshot(); +console.log(buffer.toString('base64')); +``` + +```java +byte[] buffer = page.screenshot(); +System.out.println(Base64.getEncoder().encode(buffer)); +``` + +```python async +# Capture into Image +screenshot_bytes = await page.screenshot() +print(base64.b64encode(screenshot_bytes).decode()) +``` + +```python sync +screenshot_bytes = page.screenshot() +print(base64.b64encode(screenshot_bytes).decode()) +``` + +```csharp +var bytes = await page.ScreenshotAsync(); +Console.WriteLine(Convert.ToBase64String(bytes)); +``` + + +## Element screenshot + +Sometimes it is useful to take a screenshot of a single element. + +```js +await page.locator('.header').screenshot({ path: 'screenshot.png' }); +``` + +```java +page.locator(".header").screenshot(new Locator.ScreenshotOptions().setPath(Paths.get("screenshot.png"))); +``` + +```python async +await page.locator(".header").screenshot(path="screenshot.png") +``` + +```python sync +page.locator(".header").screenshot(path="screenshot.png") +``` + +```csharp +await page.Locator(".header").ScreenshotAsync(new() { Path = "screenshot.png" }); +``` diff --git a/docs/src/selectors.md b/docs/src/selectors.md new file mode 100644 index 0000000000..e378faa657 --- /dev/null +++ b/docs/src/selectors.md @@ -0,0 +1,1389 @@ +--- +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/test-auth.md b/docs/src/test-auth-js.md similarity index 58% rename from docs/src/test-auth.md rename to docs/src/test-auth-js.md index 510aa81c8d..9f18e18557 100644 --- a/docs/src/test-auth.md +++ b/docs/src/test-auth-js.md @@ -3,17 +3,16 @@ id: test-auth title: "Authentication" --- -Playwright can be used to automate scenarios that require authentication. Tests written with Playwright execute in isolated clean-slate environments called -[browser contexts](./browser-contexts.md). This isolation model -improves reproducibility and prevents cascading test failures. New browser -contexts can load existing authentication state. This eliminates the need to -login in every context and speeds up test execution. +Tests written with Playwright execute in isolated clean-slate environments called +[browser contexts](./browser-contexts.md). Each test gets a brand +new page created in a brand new context. This isolation model improves reproducibility +and prevents cascading test failures. -> Note: This guide covers cookie/token-based authentication (logging in via the -app UI). For [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) use [`method: Browser.newContext`]. +Below are the typical strategies for implementing the signed-in scenarios. + + ## Sign in with beforeEach -* langs: js This is the simplest way where each test signs in inside the `beforeEach` hook. It also is the least efficient one in case the log in process has high latencies. @@ -64,7 +63,6 @@ Redoing login for every test can slow down test execution. To mitigate that, reu existing authentication state instead. ## Reuse signed in state -* langs: js Playwright provides a way to reuse the signed-in state in the tests. That way you can log in only once and then skip the log in step for all of the tests. @@ -163,7 +161,6 @@ However, periodically, you may need to update the `storageState.json` file if yo ::: ### Sign in via API request -* langs: js If your web application supports signing in via API, you can use [APIRequestContext] to simplify sign in flow. Global setup script from the example above would change like this: @@ -206,7 +203,6 @@ export default globalSetup; ``` ### Avoiding multiple sessions per account at a time -* langs: js By default, Playwright Test runs tests in parallel. If you reuse a single signed-in state for all your tests, this usually leads to the same account being signed in from multiple tests at the same time. If this behavior is undesirable for your application, you can sign in with a different account in each [worker process](./test-parallel.md#worker-processes) created by Playwright Test. @@ -288,7 +284,6 @@ test('test', async ({ page }) => { ``` ## Multiple signed in roles -* langs: js Sometimes you have more than one signed-in user in your end to end tests. You can achieve that via logging in for these users multiple times in globalSetup and saving that state into different files. @@ -367,7 +362,6 @@ test.describe(() => { ``` ### Testing multiple roles together -* langs: js If you need to test how multiple authenticated roles interact together, use multiple [BrowserContext]s and [Page]s with different storage states in the same test. Any of the methods above to create multiple storage state files would work. @@ -404,7 +398,6 @@ test('admin and user', async ({ browser }) => { ``` ### Testing multiple roles with POM fixtures -* langs: js If many of your tests require multiple authenticated roles from within the same test, you can introduce fixtures for each role. Any of the methods above to create multiple storage state files would work. @@ -544,7 +537,6 @@ test('admin and user', async ({ adminPage, userPage }) => { ``` ## Reuse the signed in page in multiple tests -* langs: js Although discouraged, sometimes it is necessary to sacrifice the isolation and run a number of tests in the same page. In that case, you can log into that page once in `beforeAll` and then use that same @@ -619,370 +611,3 @@ test('second test', async () => { You can also use `storageState` property when you are creating the [`method: Browser.newPage`] in order to pass it an existing logged in state. ::: - -## Automate logging in - -The Playwright API can automate interaction with a login form. See -[Input guide](./input.md) for more details. - -The following example automates login on GitHub. Once these steps are executed, -the browser context will be authenticated. - -```js -const page = await context.newPage(); -await page.goto('https://github.com/login'); - -// Interact with login form -await page.locator('text=Login').click(); -await page.locator('input[name="login"]').fill(USERNAME); -await page.locator('input[name="password"]').fill(PASSWORD); -await page.locator('text=Submit').click(); -// Verify app is logged in -``` - -```java -Page page = context.newPage(); -page.navigate("https://github.com/login"); -// Interact with login form -page.locator("text=Login").click(); -page.locator("input[name='login']").fill(USERNAME); -page.locator("input[name='password']").fill(PASSWORD); -page.locator("text=Submit").click(); -// Verify app is logged in -``` - -```python async -page = await context.new_page() -await page.goto('https://github.com/login') - -# Interact with login form -await page.locator('text=Login').click() -await page.locator('input[name="login"]').fill(USERNAME) -await page.locator('input[name="password"]').fill(PASSWORD) -await page.locator('text=Submit').click() -# Verify app is logged in -``` - -```python sync -page = context.new_page() -page.goto('https://github.com/login') - -# Interact with login form -page.locator('text=Login').click() -page.locator('input[name="login"]').fill(USERNAME) -page.locator('input[name="password"]').fill(PASSWORD) -page.locator('text=Submit').click() -# Verify app is logged in -``` - -```csharp -var page = await context.NewPageAsync(); -await page.GotoAsync("https://github.com/login"); -// Interact with login form -await page.Locator("text=Login").ClickAsync(); -await page.Locator("input[name='login']").FillAsync(USERNAME); -await page.Locator("input[name='password']").FillAsync(PASSWORD); -await page.Locator("text=Submit").ClickAsync(); -// Verify app is logged in -``` - -These steps can be executed for every browser context. However, redoing login -for every test can slow down test execution. To prevent that, we will reuse -existing authentication state in new browser contexts. -## Reuse authentication state - -Web apps use cookie-based or token-based authentication, where authenticated -state is stored as [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies) -or in [local storage](https://developer.mozilla.org/en-US/docs/Web/API/Storage). -Playwright provides [`method: BrowserContext.storageState`] method that can be used to retrieve storage state from authenticated contexts and then create new contexts with prepopulated state. - -Cookies and local storage state can be used across different browsers. They depend -on your application's authentication model: some apps might require both cookies -and local storage. - -The following code snippet retrieves state from an authenticated context and -creates a new context with that state. - -```js -// Save storage state into the file. -await context.storageState({ path: 'state.json' }); - -// Create a new context with the saved storage state. -const context = await browser.newContext({ storageState: 'state.json' }); -``` - -```java -// Save storage state into the file. -context.storageState(new BrowserContext.StorageStateOptions().setPath(Paths.get("state.json"))); - -// Create a new context with the saved storage state. -BrowserContext context = browser.newContext( - new Browser.NewContextOptions().setStorageStatePath(Paths.get("state.json"))); -``` - -```python async -# Save storage state into the file. -storage = await context.storage_state(path="state.json") - -# Create a new context with the saved storage state. -context = await browser.new_context(storage_state="state.json") -``` - -```python sync -# Save storage state into the file. -storage = context.storage_state(path="state.json") - -# Create a new context with the saved storage state. -context = browser.new_context(storage_state="state.json") -``` - -```csharp -// Save storage state into the file. -await context.StorageStateAsync(new() -{ - Path = "state.json" -}); - -// Create a new context with the saved storage state. -var context = await browser.NewContextAsync(new() -{ - StorageStatePath = "state.json" -}); -``` - -### Code generation -* langs: js - -Logging in via the UI and then reusing authentication state can be combined to -implement **login once and run multiple scenarios**. The lifecycle looks like: - -1. Run tests (for example, with `npm run test`). -2. Login via UI and retrieve authentication state. - * In Jest, this can be executed in [`globalSetup`](https://jestjs.io/docs/en/configuration#globalsetup-string). -3. In each test, load authentication state in `beforeEach` or `beforeAll` step. - -This approach will also **work in CI environments**, since it does not rely on any external state. - -### Code generation -* langs: python - -Logging in via the UI and then reusing authentication state can be combined to implement **login once and run multiple scenarios**. The lifecycle looks like: - -1. Run tests (for example, with `pytest`). -2. Login via UI and retrieve authentication state. -3. In each test, load authentication state using `autouse=True` fixture with `scope=function`. - -This approach will also **work in CI environments**, since it does not rely on any external state. - -### Code generation -* langs: csharp - -Logging in via the UI and then reusing authentication state can be combined to implement **login once and run multiple scenarios**. The lifecycle looks like: - -1. Run tests (for example, with `dotnet test`). -2. Login via UI and retrieve authentication state. -3. In each test, load authentication state in `SetUp`. - -This approach will also **work in CI environments**, since it does not rely on any external state. - -### Code generation -* langs: java - -Logging in via the UI and then reusing authentication state can be combined to implement **login once and run multiple scenarios**. The lifecycle looks like: - -1. Run tests (for example, with `mvn test`). -2. Login via UI and retrieve authentication state. -3. In each test, load authentication state in `@beforeEach` or `@beforeAll` step. - -This approach will also **work in CI environments**, since it does not rely on any external state. - -### API reference -- [`method: BrowserContext.storageState`] -- [`method: Browser.newContext`] - -## Session storage - -Rarely, [session storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage) is used for storing information -associated with the logged-in state. Session storage is specific to a particular domain and is not persisted across page loads. -Playwright does not provide API to persist session storage, but the following snippet can be used to -save/load session storage. - -```js -// Get session storage and store as env variable -const sessionStorage = await page.evaluate(() => JSON.stringify(sessionStorage)); -process.env.SESSION_STORAGE = sessionStorage; - -// Set session storage in a new context -const sessionStorage = process.env.SESSION_STORAGE; -await context.addInitScript(storage => { - if (window.location.hostname === 'example.com') { - const entries = JSON.parse(storage); - for (const [key, value] of Object.entries(entries)) { - window.sessionStorage.setItem(key, value); - } - } -}, sessionStorage); -``` - -```java -// Get session storage and store as env variable -String sessionStorage = (String) page.evaluate("JSON.stringify(sessionStorage)"); -System.getenv().put("SESSION_STORAGE", sessionStorage); - -// Set session storage in a new context -String sessionStorage = System.getenv("SESSION_STORAGE"); -context.addInitScript("(storage => {\n" + - " if (window.location.hostname === 'example.com') {\n" + - " const entries = JSON.parse(storage);\n" + - " for (const [key, value] of Object.entries(entries)) {\n" + - " window.sessionStorage.setItem(key, value);\n" + - " };\n" + - " }\n" + - "})('" + sessionStorage + "')"); -``` - -```python async -import os -# Get session storage and store as env variable -session_storage = await page.evaluate("() => JSON.stringify(sessionStorage)") -os.environ["SESSION_STORAGE"] = session_storage - -# Set session storage in a new context -session_storage = os.environ["SESSION_STORAGE"] -await context.add_init_script("""(storage => { - if (window.location.hostname === 'example.com') { - const entries = JSON.parse(storage) - for (const [key, value] of Object.entries(entries)) { - window.sessionStorage.setItem(key, key) - } - } -})('""" + session_storage + "')") -``` - -```python sync -import os -# Get session storage and store as env variable -session_storage = page.evaluate("() => JSON.stringify(sessionStorage)") -os.environ["SESSION_STORAGE"] = session_storage - -# Set session storage in a new context -session_storage = os.environ["SESSION_STORAGE"] -context.add_init_script("""(storage => { - if (window.location.hostname === 'example.com') { - const entries = JSON.parse(storage) - for (const [key, value] of Object.entries(entries)) { - window.sessionStorage.setItem(key, key) - } - } -})('""" + session_storage + "')") -``` - -```csharp -// Get session storage and store as env variable -var sessionStorage = await page.EvaluateAsync("() => JSON.stringify(sessionStorage)"); -Environment.SetEnvironmentVariable("SESSION_STORAGE", sessionStorage); - -// Set session storage in a new context -var loadedSessionStorage = Environment.GetEnvironmentVariable("SESSION_STORAGE"); -await context.AddInitScriptAsync(@"(storage => { - if (window.location.hostname === 'example.com') { - const entries = JSON.parse(storage); - for (const [key, value] of Object.entries(entries)) { - window.sessionStorage.setItem(key, value); - } - } - })('" + loadedSessionStorage + "')"); -``` - -### API reference -- [`method: BrowserContext.storageState`] -- [`method: Browser.newContext`] -- [`method: Page.evaluate`] -- [`method: BrowserContext.addInitScript`] - -## Multi-factor authentication - -Accounts with multi-factor authentication (MFA) cannot be fully automated, and need -manual intervention. Persistent authentication can be used to partially automate -MFA scenarios. - -### Persistent authentication - -Note that persistent authentication is not suited for CI environments since it -relies on a disk location. User data directories are specific to browser types -and cannot be shared across browser types. - -User data directories can be used with the [`method: BrowserType.launchPersistentContext`] API. - -```js -const { chromium } = require('playwright'); - -const userDataDir = '/path/to/directory'; -const context = await chromium.launchPersistentContext(userDataDir, { headless: false }); -// Execute login steps manually in the browser window -``` - -```java -import com.microsoft.playwright.*; - -public class Example { - public static void main(String[] args) { - try (Playwright playwright = Playwright.create()) { - BrowserType chromium = playwright.chromium(); - Path userDataDir = Paths.get("/path/to/directory"); - BrowserContext context = chromium.launchPersistentContext(userDataDir, - new BrowserType.LaunchPersistentContextOptions().setHeadless(false)); - // Execute login steps manually in the browser window - } - } -} -``` - -```python async -import asyncio -from playwright.async_api import async_playwright - -async def main(): - async with async_playwright() as p: - user_data_dir = '/path/to/directory' - browser = await p.chromium.launch_persistent_context(user_data_dir, headless=False) - # Execute login steps manually in the browser window - -asyncio.run(main()) -``` - -```python sync -from playwright.sync_api import sync_playwright - -with sync_playwright() as p: - user_data_dir = '/path/to/directory' - browser = p.chromium.launch_persistent_context(user_data_dir, headless=False) - # Execute login steps manually in the browser window -``` - -```csharp -using Microsoft.Playwright; - -class Program -{ - public static async Task Main() - { - using var playwright = await Playwright.CreateAsync(); - var chromium = playwright.Chromium; - var context = chromium.LaunchPersistentContextAsync(@"C:\path\to\directory\", new() - { - Headless = false - }); - } -} -``` - -### Lifecycle - -1. Create a user data directory on disk. -2. Launch a persistent context with the user data directory and login the MFA account. -3. Reuse user data directory to run automation scenarios. - -### API reference -- [BrowserContext] -- [`method: BrowserType.launchPersistentContext`] diff --git a/docs/src/test-configuration-js.md b/docs/src/test-configuration-js.md index e6bfe5abac..04b2200d35 100644 --- a/docs/src/test-configuration-js.md +++ b/docs/src/test-configuration-js.md @@ -127,7 +127,7 @@ These are commonly used options for various scenarios. You usually set them glob - `channel` - Browser channel to use. [Learn more](./browsers.md) about different browsers and channels. - `headless` - Whether to run the browser in headless mode. - `viewport` - Viewport used for all pages in the context. -- `storageState` - Populates context with given storage state. Useful for easy authentication, [learn more](./test-auth.md). +- `storageState` - Populates context with given storage state. Useful for easy authentication, [learn more](./auth.md). ```js tab=js-js // @ts-check diff --git a/docs/src/test-pom.md b/docs/src/test-pom-js.md similarity index 53% rename from docs/src/test-pom.md rename to docs/src/test-pom-js.md index a9d1ab0600..9fecb220c7 100644 --- a/docs/src/test-pom.md +++ b/docs/src/test-pom-js.md @@ -3,18 +3,7 @@ id: test-pom title: "Page Object Model" --- -Large test suites can be structured to optimize ease of authoring and maintenance. Page object models are one such approach to structure your test suite. - -## Introduction - -A page object represents a part of your web application. An e-commerce web application might have a home page, a listings page and a checkout page. Each of them can be represented by page object models. - -Page objects **simplify authoring**. They create a higher-level API which suits your application. - -Page objects **simplify maintenance**. They capture element selectors in one place and create reusable code to avoid repetition. - -## Implementation -* langs: js +Page Object Model is a common pattern that introduces abstractions over web app pages to simplify interactions with them in multiple tests. It is best explained by an example. We will create a `PlaywrightDevPage` helper class to encapsulate common operations on the `playwright.dev` page. Internally, it will use the `page` object. @@ -149,141 +138,3 @@ test('should show Page Object Model article', async ({ page }) => { await expect(page.locator('article')).toContainText('Page Object Model is a common pattern'); }); ``` -## Implementation -* langs: csharp, python, java - -Page object models wrap over a Playwright [Page]. - -```java -// models/SearchPage.java -package models; - -import com.microsoft.playwright; - -public class SearchPage { - private final Page page; - private final Locator searchTermInput; - - public SearchPage(Page page) { - this.page = page; - this.searchTermInput = page.locator("[aria-label='Enter your search term']"); - } - - public void navigate() { - page.navigate("https://bing.com"); - } - - public void search(String text) { - searchTermInput.fill(text); - searchTermInput.press("Enter"); - } -} -``` - -```python async -# models/search.py -class SearchPage: - def __init__(self, page): - self.page = page - self.search_term_input = page.locator('[aria-label="Enter your search term"]') - - async def navigate(self): - await self.page.goto("https://bing.com") - - async def search(self, text): - await self.search_term_input.fill(text) - await self.search_term_input.press("Enter") -``` - -```python sync -# models/search.py -class SearchPage: - def __init__(self, page): - self.page = page - self.search_term_input = page.locator('[aria-label="Enter your search term"]') - - def navigate(self): - self.page.goto("https://bing.com") - - def search(self, text): - self.search_term_input.fill(text) - self.search_term_input.press("Enter") -``` - -```csharp -using System.Threading.Tasks; -using Microsoft.Playwright; - -namespace BigEcommerceApp.Tests.Models; - -public class SearchPage -{ - private readonly IPage _page; - private readonly ILocator _searchTermInput; - - public SearchPage(IPage page) - { - _page = page; - _searchTermInput = page.Locator("[aria-label='Enter your search term']"); - } - - public async Task GotoAsync() - { - await _page.GotoAsync("https://bing.com"); - } - - public async Task SearchAsync(string text) - { - await _searchTermInput.FillAsync(text); - await _searchTermInput.PressAsync("Enter"); - } -} -``` - -Page objects can then be used inside a test. - -```java -import models.SearchPage; -import com.microsoft.playwright.*; -... - -// In the test -Page page = browser.newPage(); -SearchPage searchPage = new SearchPage(page); -searchPage.navigate(); -searchPage.search("search query"); -``` - -```python async -# test_search.py -from models.search import SearchPage - -# in the test -page = await browser.new_page() -search_page = SearchPage(page) -await search_page.navigate() -await search_page.search("search query") -``` - -```python sync -# test_search.py -from models.search import SearchPage - -# in the test -page = browser.new_page() -search_page = SearchPage(page) -search_page.navigate() -search_page.search("search query") -``` - -```csharp -using BigEcommerceApp.Tests.Models; - -// in the test -var page = new SearchPage(await browser.NewPageAsync()); -await page.GotoAsync(); -await page.SearchAsync("search query"); -``` - -### API reference -- [Page] \ No newline at end of file diff --git a/docs/src/test-snapshots.md b/docs/src/test-snapshots-js.md similarity index 67% rename from docs/src/test-snapshots.md rename to docs/src/test-snapshots-js.md index aa81e0e86a..39a343b544 100644 --- a/docs/src/test-snapshots.md +++ b/docs/src/test-snapshots-js.md @@ -3,9 +3,6 @@ id: test-snapshots title: "Visual comparisons" --- -## toHaveScreenshot -* langs: js - Playwright Test includes the ability to produce and visually compare screenshots using `await expect(page).toHaveScreenshot()`. On first execution, Playwright test will generate reference screenshots. Subsequent runs will compare against the reference. ```js tab=js-js @@ -140,120 +137,3 @@ test('example test', async ({ page }) => { ``` Snapshots are stored next to the test file, in a separate directory. For example, `my.spec.ts` file will produce and store snapshots in the `my.spec.ts-snapshots` directory. You should commit this directory to your version control (e.g. `git`), and review any changes to it. - -## Screenshots - -Here is a quick way to capture a screenshot and save it into a file: - -```js -await page.screenshot({ path: 'screenshot.png' }); -``` - -```python async -await page.screenshot(path="screenshot.png") -``` - -```python sync -page.screenshot(path="screenshot.png") -``` - -```java -page.screenshot(new Page.ScreenshotOptions() - .setPath(Paths.get("screenshot.png"))) -``` - -```csharp -await Page.ScreenshotAsync(new() -{ - Path = "screenshot.png", -}); -``` - -Screenshots API accepts many parameters for image format, clip area, quality, etc. Make sure to check them out. - - -## Full page screenshots - -Full page screenshot is a screenshot of a full scrollable page, as if you had a very -tall screen and the page could fit it entirely. - -```js -await page.screenshot({ path: 'screenshot.png', fullPage: true }); -``` - -```java -page.screenshot(new Page.ScreenshotOptions() - .setPath(Paths.get("screenshot.png")) - .setFullPage(true)); -``` - -```python async -await page.screenshot(path="screenshot.png", full_page=True) -``` - -```python sync -page.screenshot(path="screenshot.png", full_page=True) -``` - -```csharp -await Page.ScreenshotAsync(new() -{ - Path = "screenshot.png", - FullPage = true, -}); -``` - -## Capture into buffer - -Rather than writing into a file, you can get a buffer with the image and post-process it or pass it to a third party pixel diff facility. - -```js -const buffer = await page.screenshot(); -console.log(buffer.toString('base64')); -``` - -```java -byte[] buffer = page.screenshot(); -System.out.println(Base64.getEncoder().encode(buffer)); -``` - -```python async -# Capture into Image -screenshot_bytes = await page.screenshot() -print(base64.b64encode(screenshot_bytes).decode()) -``` - -```python sync -screenshot_bytes = page.screenshot() -print(base64.b64encode(screenshot_bytes).decode()) -``` - -```csharp -var bytes = await page.ScreenshotAsync(); -Console.WriteLine(Convert.ToBase64String(bytes)); -``` - - -## Element screenshot - -Sometimes it is useful to take a screenshot of a single element. - -```js -await page.locator('.header').screenshot({ path: 'screenshot.png' }); -``` - -```java -page.locator(".header").screenshot(new Locator.ScreenshotOptions().setPath(Paths.get("screenshot.png"))); -``` - -```python async -await page.locator(".header").screenshot(path="screenshot.png") -``` - -```python sync -page.locator(".header").screenshot(path="screenshot.png") -``` - -```csharp -await page.Locator(".header").ScreenshotAsync(new() { Path = "screenshot.png" }); -``` diff --git a/docs/src/testing-library-js.md b/docs/src/testing-library-js.md index 646342b02c..148ac5840b 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](./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. `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. `getByPlaceholderText`: use css alternative `component.locator('[placeholder="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. `getByAltText`: use css alternative `component.locator('[alt="some value"]')` or [role selector](./selectors#role-selector) `component.locator('role=img[name="some value"]')`. 1. `getByTitle`: use css alternative `component.locator('[title="some value"]')` ## Replacing `waitFor` @@ -143,7 +143,7 @@ Once you're on Playwright Test, you get a lot! Also you get all these ✨ awesome tools ✨ that come bundled with Playwright Test: - [Playwright Inspector](./debug.md) -- [Playwright Test Code generation](./test-auth#code-generation) +- [Playwright Test Code generation](./auth#code-generation) - [Playwright Tracing](./trace-viewer) for post-mortem debugging ## Further Reading @@ -153,6 +153,6 @@ Learn more about Playwright Test runner: - [Getting Started](./intro) - [Experimental Component Testing](./test-components) - [Locators](./api/class-locator) -- [Selectors](./locators#selectors) +- [Selectors](./selectors) - [Assertions](./test-assertions) - [Auto-waiting](./actionability) diff --git a/docs/src/why-playwright.md b/docs/src/why-playwright.md index 492e76c032..755f20000f 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](./locators.md#selectors). 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](./selectors.md). 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](./locators.md#selectors), [geolocation, permissions](./emulation.md), web workers and other modern web APIs. +* **Modern web features**. Playwright supports web components through [shadow-piercing selectors](./selectors.md), [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 573c739bed..b3e3aed8c2 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](./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). +[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). ```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 0b85c0a13a..6ed96a4667 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](/locators.md#selectors). +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). ```js tab=js-js // @ts-check @@ -88,7 +88,7 @@ await expect(getStarted).toHaveAttribute('href', '/docs/installation'); await getStarted.click(); ``` -[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). +[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). ```js diff --git a/docs/src/writing-tests-python.md b/docs/src/writing-tests-python.md index ec3721de9e..1fc0deb137 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](./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). +[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). ```python diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts index b32d30a6e4..c85c16b037 100644 --- a/packages/playwright-core/types/types.d.ts +++ b/packages/playwright-core/types/types.d.ts @@ -258,7 +258,7 @@ export interface Page { * * Shortcut for main frame's * [frame.$(selector[, options])](https://playwright.dev/docs/api/class-frame#frame-query-selector). - * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param options */ $(selector: K, options?: { strict: boolean }): Promise | null>; @@ -271,7 +271,7 @@ export interface Page { * * Shortcut for main frame's * [frame.$(selector[, options])](https://playwright.dev/docs/api/class-frame#frame-query-selector). - * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param options */ $(selector: string, options?: { strict: boolean }): Promise | null>; @@ -283,7 +283,7 @@ export interface Page { * return value resolves to `[]`. * * Shortcut for main frame's [frame.$$(selector)](https://playwright.dev/docs/api/class-frame#frame-query-selector-all). - * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details. */ $$(selector: K): Promise[]>; /** @@ -293,7 +293,7 @@ export interface Page { * return value resolves to `[]`. * * Shortcut for main frame's [frame.$$(selector)](https://playwright.dev/docs/api/class-frame#frame-query-selector-all). - * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details. */ $$(selector: string): Promise[]>; @@ -322,7 +322,7 @@ export interface Page { * * Shortcut for main frame's * [frame.$eval(selector, pageFunction[, arg, options])](https://playwright.dev/docs/api/class-frame#frame-eval-on-selector). - * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param pageFunction Function to be evaluated in the page context. * @param arg Optional argument to pass to `pageFunction`. * @param options @@ -353,7 +353,7 @@ export interface Page { * * Shortcut for main frame's * [frame.$eval(selector, pageFunction[, arg, options])](https://playwright.dev/docs/api/class-frame#frame-eval-on-selector). - * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param pageFunction Function to be evaluated in the page context. * @param arg Optional argument to pass to `pageFunction`. * @param options @@ -384,7 +384,7 @@ export interface Page { * * Shortcut for main frame's * [frame.$eval(selector, pageFunction[, arg, options])](https://playwright.dev/docs/api/class-frame#frame-eval-on-selector). - * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param pageFunction Function to be evaluated in the page context. * @param arg Optional argument to pass to `pageFunction`. * @param options @@ -415,7 +415,7 @@ export interface Page { * * Shortcut for main frame's * [frame.$eval(selector, pageFunction[, arg, options])](https://playwright.dev/docs/api/class-frame#frame-eval-on-selector). - * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param pageFunction Function to be evaluated in the page context. * @param arg Optional argument to pass to `pageFunction`. * @param options @@ -440,7 +440,7 @@ export interface Page { * const divCounts = await page.$$eval('div', (divs, min) => divs.length >= min, 10); * ``` * - * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param pageFunction Function to be evaluated in the page context. * @param arg Optional argument to pass to `pageFunction`. */ @@ -463,7 +463,7 @@ export interface Page { * const divCounts = await page.$$eval('div', (divs, min) => divs.length >= min, 10); * ``` * - * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param pageFunction Function to be evaluated in the page context. * @param arg Optional argument to pass to `pageFunction`. */ @@ -486,7 +486,7 @@ export interface Page { * const divCounts = await page.$$eval('div', (divs, min) => divs.length >= min, 10); * ``` * - * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param pageFunction Function to be evaluated in the page context. * @param arg Optional argument to pass to `pageFunction`. */ @@ -509,7 +509,7 @@ export interface Page { * const divCounts = await page.$$eval('div', (divs, min) => divs.length >= min, 10); * ``` * - * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param pageFunction Function to be evaluated in the page context. * @param arg Optional argument to pass to `pageFunction`. */ @@ -616,7 +616,7 @@ export interface Page { * })(); * ``` * - * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param options */ waitForSelector(selector: K, options?: PageWaitForSelectorOptionsNotHidden): Promise>; @@ -648,7 +648,7 @@ export interface Page { * })(); * ``` * - * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param options */ waitForSelector(selector: string, options?: PageWaitForSelectorOptionsNotHidden): Promise>; @@ -680,7 +680,7 @@ export interface Page { * })(); * ``` * - * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param options */ waitForSelector(selector: K, options: PageWaitForSelectorOptions): Promise | null>; @@ -712,7 +712,7 @@ export interface Page { * })(); * ``` * - * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param options */ waitForSelector(selector: string, options: PageWaitForSelectorOptions): Promise>; @@ -1850,7 +1850,7 @@ export interface Page { * zero timeout disables this. * * Shortcut for main frame's [frame.check(selector[, options])](https://playwright.dev/docs/api/class-frame#frame-check). - * @param selector A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param options */ check(selector: string, options?: { @@ -1911,7 +1911,7 @@ export interface Page { * zero timeout disables this. * * Shortcut for main frame's [frame.click(selector[, options])](https://playwright.dev/docs/api/class-frame#frame-click). - * @param selector A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param options */ click(selector: string, options?: { @@ -2032,7 +2032,7 @@ export interface Page { * * Shortcut for main frame's * [frame.dblclick(selector[, options])](https://playwright.dev/docs/api/class-frame#frame-dblclick). - * @param selector A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param options */ dblclick(selector: string, options?: { @@ -2124,7 +2124,7 @@ export interface Page { * await page.dispatchEvent('#source', 'dragstart', { dataTransfer }); * ``` * - * @param selector A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param type DOM event type: `"click"`, `"dragstart"`, etc. * @param eventInit Optional event-specific initialization properties. * @param options @@ -2146,8 +2146,8 @@ export interface Page { }): Promise; /** - * @param source 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](https://playwright.dev/docs/locators#selectors) for more details. - * @param target 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](https://playwright.dev/docs/locators#selectors) for more details. + * @param source 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](https://playwright.dev/docs/selectors) for more details. + * @param target 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](https://playwright.dev/docs/selectors) for more details. * @param options */ dragAndDrop(source: string, target: string, options?: { @@ -2324,7 +2324,7 @@ export interface Page { * * Shortcut for main frame's * [frame.fill(selector, value[, options])](https://playwright.dev/docs/api/class-frame#frame-fill). - * @param selector A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See [working with selectors](https://playwright.dev/docs/locators#selectors) for more details. + * @param selector A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See [working with selectors](https://playwright.dev/docs/selectors) for more details. * @param value Value to fill for the ``, `