yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: move note (#36432)

Browse Source
This commit is contained in:
Patrik Csak 2025-06-26 09:31:31 -07:00 committed by GitHub
parent 216e6be464
commit 56ccccddb8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/test-snapshots-js.md
View File

@ -50,6 +50,9 @@ The snapshot name `example-test-1-chromium-darwin.png` consists of a few parts:
The snapshot name and path can be configured with [`property: TestConfig.snapshotPathTemplate`] in the playwright config. The snapshot name and path can be configured with [`property: TestConfig.snapshotPathTemplate`] in the playwright config.
> Note that `toHaveScreenshot()` also accepts an array of path segments to the snapshot file such as `expect().toHaveScreenshot(['relative', 'path', 'to', 'snapshot.png'])`.
> However, this path must stay within the snapshots directory for each test file (i.e. `a.spec.js-snapshots`), otherwise it will throw.
## Updating screenshots ## Updating screenshots
Sometimes you need to update the reference screenshot, for example when the page has changed. Do this with the `--update-snapshots` flag. Sometimes you need to update the reference screenshot, for example when the page has changed. Do this with the `--update-snapshots` flag.
@ -58,9 +61,6 @@ Sometimes you need to update the reference screenshot, for example when the page
npx playwright test --update-snapshots npx playwright test --update-snapshots
``` ```
> Note that `snapshotName` also accepts an array of path segments to the snapshot file such as `expect().toHaveScreenshot(['relative', 'path', 'to', 'snapshot.png'])`.
> However, this path must stay within the snapshots directory for each test file (i.e. `a.spec.js-snapshots`), otherwise it will throw.
## Options ## Options
### maxDiffPixels ### maxDiffPixels