diff --git a/docs/src/best-practices-js.md b/docs/src/best-practices-js.md index 02e43786e0..3694418533 100644 --- a/docs/src/best-practices-js.md +++ b/docs/src/best-practices-js.md @@ -214,7 +214,7 @@ Playwright comes with a range of tooling to help you write tests. - The [VS Code extension](./getting-started-vscode.md) gives you a great developer experience when writing, running, and debugging tests. - The [test generator](./codegen.md) can generate tests and pick locators for you. - The [trace viewer](./trace-viewer.md) gives you a full trace of your tests as a local PWA that can easily be shared. With the trace viewer you can view the timeline, inspect DOM snapshots for each action, view network requests and more. -- The [UI Mode](./test-ui-mode) let's you explore, run and debug tests with a time travel experience complete with watch mode. All test files are loaded into the testing sidebar where you can expand each file and describe block to individually run, view, watch and debug each test. +- The [UI Mode](./test-ui-mode) lets you explore, run and debug tests with a time travel experience complete with watch mode. All test files are loaded into the testing sidebar where you can expand each file and describe block to individually run, view, watch and debug each test. - [Typescript](./test-typescript) in Playwright works out of the box and gives you better IDE integrations. Your IDE will show you everything you can do and highlight when you do something wrong. No TypeScript experience is needed and it is not necessary for your code to be in TypeScript, all you need to do is create your tests with a `.ts` extension. ### Test across all browsers diff --git a/docs/src/codegen.md b/docs/src/codegen.md index b23c023ac2..4b45f12d01 100644 --- a/docs/src/codegen.md +++ b/docs/src/codegen.md @@ -125,14 +125,14 @@ With the test generator you can record: When you have finished interacting with the page, press the **record** button to stop the recording and use the **copy** button to copy the generated code to your editor. -Use the **clear** button to clear the code to start recording again. Once finished close the Playwright inspector window or stop the terminal command. +Use the **clear** button to clear the code to start recording again. Once finished, close the Playwright inspector window or stop the terminal command. ### Generating locators You can generate [locators](/locators.md) with the test generator. * Press the `'Record'` button to stop the recording and the `'Pick Locator'` button will appear. * Click on the `'Pick Locator'` button and then hover over elements in the browser window to see the locator highlighted underneath each element. -* To choose a locator click on the element you would like to locate and the code for that locator will appear in the field next to the Pick Locator button. +* To choose a locator, click on the element you would like to locate and the code for that locator will appear in the field next to the Pick Locator button. * You can then edit the locator in this field to fine tune it or use the copy button to copy it and paste it into your code. ###### @@ -284,7 +284,7 @@ pwsh bin/Debug/netX/playwright.ps1 codegen --color-scheme=dark playwright.dev Record scripts and tests while emulating timezone, language & location using the `--timezone`, `--geolocation` and `--lang` options. Once the page opens: 1. Accept the cookies -1. On the top right click on the locate me button to see geolocation in action. +1. On the top right, click on the locate me button to see geolocation in action. ```bash js npx playwright codegen --timezone="Europe/Rome" --geolocation="41.890221,12.492348" --lang="it-IT" bing.com/maps @@ -375,7 +375,7 @@ Make sure you only use the `auth.json` locally as it contains sensitive informat #### Load authenticated state -Run with `--load-storage` to consume the previously loaded storage from the `auth.json`. This way, all [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies) and [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) will be restored, bringing most web apps to the authenticated state without the need to login again. This means you can can continue generating tests from the logged in state. +Run with `--load-storage` to consume the previously loaded storage from the `auth.json`. This way, all [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies) and [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) will be restored, bringing most web apps to the authenticated state without the need to login again. This means you can continue generating tests from the logged in state. ```bash js npx playwright codegen --load-storage=auth.json github.com/microsoft/playwright diff --git a/docs/src/debug.md b/docs/src/debug.md index bc4b0c1a80..aff5077d3c 100644 --- a/docs/src/debug.md +++ b/docs/src/debug.md @@ -46,7 +46,7 @@ A browser window will open and the test will run and pause at where the breakpoi ### Debug in different Browsers -By default debugging is done using the Chromium profile. You can debug your tests on different browsers by right clicking on the debug icon in the testing sidebar and clicking on the 'Select Default Profile' option from the dropdown. +By default, debugging is done using the Chromium profile. You can debug your tests on different browsers by right clicking on the debug icon in the testing sidebar and clicking on the 'Select Default Profile' option from the dropdown. debugging on specific profile @@ -80,7 +80,7 @@ npx playwright test --debug ``` #### Debug one test on all browsers -To debug one test on a specific line run the test command followed by the name of the test file and the line number of the test you want to debug, followed by the `--debug` flag. This will run a single test in each browser configured in your [`playwright.config`](./test-projects.md#configure-projects-for-multiple-browsers) and open the inspector. +To debug one test on a specific line, run the test command followed by the name of the test file and the line number of the test you want to debug, followed by the `--debug` flag. This will run a single test in each browser configured in your [`playwright.config`](./test-projects.md#configure-projects-for-multiple-browsers) and open the inspector. ```bash npx playwright test example.spec.ts:10 --debug @@ -207,7 +207,7 @@ While running in debug mode you can live edit the locators. Next to the 'Pick Lo ### Picking locators -While debugging you might need to choose a more resilient locator. You can do this by clicking on the **Pick Locator** button and hovering over any element in the browser window. While hovering over an element you will see the code needed to locate this element highlighted below. Clicking an element in the browser will add the locator into the field where you can then either tweak it or copy it into your code. +While debugging, you might need to choose a more resilient locator. You can do this by clicking on the **Pick Locator** button and hovering over any element in the browser window. While hovering over an element you will see the code needed to locate this element highlighted below. Clicking an element in the browser will add the locator into the field where you can then either tweak it or copy it into your code. Picking locators @@ -242,7 +242,7 @@ This will also set the default timeouts of Playwright to 0 (= no timeout). Browser Developer Tools with Playwright object -To debug your tests using the browser developer tools start by setting a breakpoint in your test to pause the execution using the [`method: Page.pause`] method. +To debug your tests using the browser developer tools, start by setting a breakpoint in your test to pause the execution using the [`method: Page.pause`] method. ```js await page.pause(); @@ -264,7 +264,7 @@ page.pause() await page.PauseAsync(); ``` -Once you have set a breakpoint in your test you can then run your test with `PWDEBUG=console`. +Once you have set a breakpoint in your test, you can then run your test with `PWDEBUG=console`. ```bash tab=bash-bash lang=js PWDEBUG=console npx playwright test @@ -327,7 +327,7 @@ $env:PWDEBUG=console dotnet test ``` -Once Playwright launches the browser window you can open the developer tools. +Once Playwright launches the browser window, you can open the developer tools. The `playwright` object will be available in the console panel. #### playwright.$(selector) diff --git a/docs/src/events.md b/docs/src/events.md index 900cde1a95..23d3c90c3e 100644 --- a/docs/src/events.md +++ b/docs/src/events.md @@ -5,7 +5,7 @@ title: "Events" ## Introduction -Playwright allows listening to various types of events happening on the web page, such as network requests, creation of child pages, dedicated workers etc. There are several ways to subscribe to such events such as waiting for events or adding or removing event listeners. +Playwright allows listening to various types of events happening on the web page, such as network requests, creation of child pages, dedicated workers etc. There are several ways to subscribe to such events, such as waiting for events or adding or removing event listeners. ## Waiting for event diff --git a/docs/src/library-js.md b/docs/src/library-js.md index ae3d1916ec..9085290bba 100644 --- a/docs/src/library-js.md +++ b/docs/src/library-js.md @@ -103,7 +103,7 @@ The key differences to note are as follows: | Installation | `npm install playwright` | `npm init playwright@latest` - note `install` vs. `init` | | Install browsers | Install `@playwright/browser-chromium`, `@playwright/browser-firefox` and/or `@playwright/browser-webkit` | `npx playwright install` or `npx playwright install chromium` for a single one | | `import` from | `playwright` | `@playwright/test` | -| Initialization | Explicitly need to:
  1. Pick a browser to use, e.g. `chromium`
  2. Launch browser with [`method: BrowserType.launch`]
  3. Create a context with [`method: Browser.newContext`], and pass any context options explicitly, e.g. `devices['iPhone 11']`
  4. Create a page with [`method: BrowserContext.newPage`]
| An isolated `page` and `context` are provided to each test out-of the box, along with other [built-in fixtures](./test-fixtures.md#built-in-fixtures). No explicit creation. If referenced by the test in it's arguments, the Test Runner will create them for the test. (i.e. lazy-initialization) | +| Initialization | Explicitly need to:
  1. Pick a browser to use, e.g. `chromium`
  2. Launch browser with [`method: BrowserType.launch`]
  3. Create a context with [`method: Browser.newContext`], and pass any context options explicitly, e.g. `devices['iPhone 11']`
  4. Create a page with [`method: BrowserContext.newPage`]
| An isolated `page` and `context` are provided to each test out-of the box, along with other [built-in fixtures](./test-fixtures.md#built-in-fixtures). No explicit creation. If referenced by the test in its arguments, the Test Runner will create them for the test. (i.e. lazy-initialization) | | Assertions | No built-in Web-First Assertions | [Web-First assertions](./test-assertions.md) like: which auto-wait and retry for the condition to be met.| | Cleanup | Explicitly need to:
  1. Close context with [`method: BrowserContext.close`]
  2. Close browser with [`method: Browser.close`]
| No explicit close of [built-in fixtures](./test-fixtures.md#built-in-fixtures); the Test Runner will take care of it. | Running | When using the Library, you run the code as a node script, possibly with some compilation first. | When using the Test Runner, you use the `npx playwright test` command. Along with your [config](./test-configuration.md), the Test Runner handles any compilation and choosing what to run and how to run it. | diff --git a/docs/src/locators.md b/docs/src/locators.md index 052894a172..8ade71efb7 100644 --- a/docs/src/locators.md +++ b/docs/src/locators.md @@ -10,7 +10,7 @@ a way to find element(s) on the page at any moment. ### Quick Guide -These are the recommended built in locators. +These are the recommended built-in locators. - [`method: Page.getByRole`](#locate-by-role) to locate by explicit and implicit accessibility attributes. - [`method: Page.getByText`](#locate-by-text) to locate by text content. @@ -513,7 +513,7 @@ Use this locator when your element has the `title` attribute. ### Locate by test id -Testing by test ids is the most resilient way of testing as even if your text or role of the attribute changes the test will still pass. QA's and developers should define explicit test ids and query them with [`method: Page.getByTestId`]. However testing by test ids is not user facing. If the role or text value is important to you then consider using user facing locators such as [role](#locate-by-role) and [text locators](#locate-by-text). +Testing by test ids is the most resilient way of testing as even if your text or role of the attribute changes, the test will still pass. QA's and developers should define explicit test ids and query them with [`method: Page.getByTestId`]. However testing by test ids is not user facing. If the role or text value is important to you then consider using user facing locators such as [role](#locate-by-role) and [text locators](#locate-by-text). For example, consider the following DOM structure. @@ -1501,7 +1501,7 @@ For example, consider the following DOM structure: ``` -Locate an item by it's test id of "orange" and then click it. +Locate an item by its test id of "orange" and then click it. ```js await page.getByTestId('orange').click(); diff --git a/docs/src/other-locators.md b/docs/src/other-locators.md index c37b97f6e6..b42407231d 100644 --- a/docs/src/other-locators.md +++ b/docs/src/other-locators.md @@ -668,7 +668,7 @@ We recommend [locating by label text](./locators.md#locate-by-label) instead of Targeted input actions in Playwright automatically distinguish between labels and controls, so you can target the label to perform an action on the associated control. -For example, consider the following DOM structure: ``. You can target the label by it's "Password" text using [`method: Page.getByText`]. However, the following actions will be performed on the input instead of the label: +For example, consider the following DOM structure: ``. You can target the label by its "Password" text using [`method: Page.getByText`]. However, the following actions will be performed on the input instead of the label: - [`method: Locator.click`] will click the label and automatically focus the input field; - [`method: Locator.fill`] will fill the input field; - [`method: Locator.inputValue`] will return the value of the input field; diff --git a/docs/src/test-components-js.md b/docs/src/test-components-js.md index 87cf263711..60d920ee73 100644 --- a/docs/src/test-components-js.md +++ b/docs/src/test-components-js.md @@ -458,7 +458,7 @@ test('slot', async ({ mount }) => { ### hooks -You can use `beforeMount` and `afterMount` hooks to configure your app. This lets you setup things like your app router, fake server etc. giving you the flexibility you need. You can also pass custom configuration from the `mount` call from a test, which is accessible from the `hooksConfig` fixture. This includes any config that needs to be run before or after mounting the component. An example of configuring a router is provided below: +You can use `beforeMount` and `afterMount` hooks to configure your app. This lets you set up things like your app router, fake server etc. giving you the flexibility you need. You can also pass custom configuration from the `mount` call from a test, which is accessible from the `hooksConfig` fixture. This includes any config that needs to be run before or after mounting the component. An example of configuring a router is provided below: