microsoft/playwright
1
1
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2024-10-04 16:37:49 +03:00
Code Issues Projects Releases Wiki Activity

chore(docs): revert recent changes temporarily (#16590)

Browse Source
This commit is contained in:
Pavel Feldman 2022-08-16 22:00:54 -07:00 committed by GitHub
parent 8ebf9d7699
commit 3cd8d6e513
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
32 changed files with 2348 additions and 2288 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -375,7 +375,7 @@ Optional event-specific initialization properties.
Returns the return value of [`param: expression`].
The method finds an element matching the specified selector in the `ElementHandle`s subtree and passes it as a first
argument to [`param: expression`]. See [Working with selectors](../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-%%

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

@ -449,7 +449,7 @@ the flaky tests. Use [`method: Locator.evaluate`], other [Locator] helper method
:::
The method finds an element matching the specified selector within the frame and passes it as a first argument to
[`param: expression`]. See [Working with selectors](../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-%%

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

@ -233,7 +233,7 @@ Exposes API that can be used for the Web API testing.
- type: <[Selectors]>
Selectors can be used to install custom selector engines. See
[Working with selectors](../locators.md#selectors) for more information.
[Working with selectors](../selectors.md) for more information.
## property: Playwright.webkit
* since: v1.8

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

@ -1,7 +1,7 @@
# class: Selectors
* since: v1.8
Selectors can be used to install custom selector engines. See [Working with selectors](../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

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

@ -52,19 +52,19 @@ Whether to bypass the [actionability](../actionability.md) checks. Defaults to `
- `selector` <[string]>
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See
[working with selectors](../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">>

392
docs/src/auth.md Normal file
View File

@ -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`].
<!-- TOC -->
## 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<string>("() => 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`]

4
docs/src/browser-contexts.md
View File

@ -1,6 +1,6 @@
---
id: isolation
title: "Isolation"
id: browser-contexts
title: "Browser Contexts"
---
<!-- TOC -->

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

@ -7,13 +7,13 @@ When installing Playwright you are given the option to add a [GitHub Actions](ht
**What you will learn:**
- [How to use GitHub Actions to run your tests](./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)

6
docs/src/debug.md
View File

@ -3,7 +3,7 @@ id: debug
title: "Debugging Tests"
---
The Playwright inspector is a great tool to help with debugging. It opens up a browser window highlighting the selectors as you step through each line of the test. You can also use the explore button to find other available [selectors](./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.
<img width="557" alt="Paused on line" src="https://user-images.githubusercontent.com/883973/108614337-71761580-73ae-11eb-9f61-3d29c52c9520.png"></img>

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

@ -83,7 +83,7 @@ To record a test click on the record icon. This will create a `test-1.spec.ts` f
### Selector Highlighting
As you interact with the page Codegen will generate the test for you in the newly created file in VS Code. When you hover over an element Playwright will highlight the element and show the [selector](./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.
<img width="860" alt="image" src="https://user-images.githubusercontent.com/13063165/182151374-03273172-38cd-4f27-add5-cb3d3cdc7bcd.png" />

1403
docs/src/locators.md
View File

File diff suppressed because it is too large Load Diff

196
docs/src/pom.md Normal file
View File

@ -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.
<!-- TOC -->
## 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]

4
docs/src/protractor-js.md
View File

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

16
docs/src/release-notes-csharp.md
View File

@ -202,7 +202,7 @@ Note that the new methods [`method: Page.routeFromHAR`] and [`method: BrowserCon
await page.Locator("role=button[name='log in']").ClickAsync();
```
Read more in [our documentation](./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

22
docs/src/release-notes-java.md
View File

@ -143,7 +143,7 @@ Note that the new methods [`method: Page.routeFromHAR`] and [`method: BrowserCon
page.locator("role=button[name='log in']").click();
```
Read more in [our documentation](./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.

22
docs/src/release-notes-js.md
View File

@ -342,7 +342,7 @@ WebServer is now considered "ready" if request to the specified port has any of
await page.locator('role=button[name="log in"]').click()
```
Read more in [our documentation](./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.

22
docs/src/release-notes-python.md
View File

@ -188,7 +188,7 @@ Note that the new methods [`method: Page.routeFromHAR`] and [`method: BrowserCon
page.locator("role=button[name='log in']").click()
```
Read more in [our documentation](./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.

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

@ -58,7 +58,7 @@ For more information see [selective unit tests](https://docs.microsoft.com/en-us
## Debugging Tests
Since Playwright runs in .NET, you can debug it with your debugger of choice in e.g. Visual Studio Code or Visual Studio. Playwright comes with the Playwright Inspector which allows you to step through Playwright API calls, see their debug logs and explore [selectors](./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

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

@ -61,7 +61,7 @@ For a better debugging experience check out the [VS Code Extension](./getting-st
## Debugging Tests
Since Playwright runs in Node.js, you can debug it with your debugger of choice e.g. using `console.log` or inside your IDE or directly in VS Code with the [VS Code Extension](./getting-started-vscode.md). Playwright comes with the [Playwright Inspector](./debug.md#playwright-inspector) which allows you to step through Playwright API calls, see their debug logs and explore [selectors](./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:

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

@ -59,7 +59,7 @@ For more information see [Playwright Pytest usage](./test-runners.md) or the Pyt
## Running Tests
Since Playwright runs in Python, you can debug it with your debugger of choice with e.g. the [Python extension](https://code.visualstudio.com/docs/python/python-tutorial) in Visual Studio Code. Playwright comes with the Playwright Inspector which allows you to step through Playwright API calls, see their debug logs and explore [selectors](./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

120
docs/src/screenshots.md Normal file
View File

@ -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.
<!-- TOC -->
## 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" });
```

1389
docs/src/selectors.md Normal file
View File

File diff suppressed because it is too large Load Diff

389
docs/src/test-auth.md → docs/src/test-auth-js.md
View File

@ -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.
<!-- TOC -->
## 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<string>("() => 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`]

2
docs/src/test-configuration-js.md
View File

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

151
docs/src/test-pom.md → docs/src/test-pom-js.md
View File

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

120
docs/src/test-snapshots.md → docs/src/test-snapshots-js.md
View File

@ -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" });
```

12
docs/src/testing-library-js.md
View File

@ -85,11 +85,11 @@ Migration highlights (see inline comments in the Playwright Test code snippet):
All queries like `getBy...`, `findBy...`, `queryBy...` and their multi-element counterparts are replaced with `page.locator('...')`. Locators always auto-wait and retry when needed, so you don't have to worry about choosing the right method. When you want to do a [list operation](./locators#lists), e.g. assert a list of texts, Playwright automatically performs multi-element opertations.
1. `getByRole`: use [role selector](./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)

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

@ -24,13 +24,13 @@ Playwright enables fast, reliable and capable testing and automation across all
* **Fast isolation with browser contexts**. Reuse a single browser instance for multiple isolated execution environments with [browser contexts](./browser-contexts.md).
* **Resilient element selectors**. Playwright can rely on user-facing strings, like text content and accessibility labels to [select elements](./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).

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

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

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

@ -15,7 +15,7 @@ Playwright assertions are created specifically for the dynamic web. Checks are a
## The Example Test
Take a look at the example test included when installing Playwright to see how to write a test using [web first assertions](/test-assertions.md), [locators](/locators.md) and [selectors](/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

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

@ -57,7 +57,7 @@ expect(get_started).to_have_attribute("href", "/docs/installation")
get_started.click()
```
[Selectors](./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

300
packages/playwright-core/types/types.d.ts vendored
View File

File diff suppressed because it is too large Load Diff