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

docs: update snapshot path template description and configuration example for toMatchAriaSnapshot

Browse source
This commit is contained in:
Debbie O'Brien 2025-01-29 20:49:50 +01:00
parent 93d2a0fb7b
commit 93ea8abd91
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/src/aria-snapshots.md
View file

@ -344,12 +344,16 @@ To store your snapshots in a separate file, use the `toMatchAriaSnapshot` method
await expect(page.getByRole('main')).toMatchAriaSnapshot({ name: 'main-snapshot.yml' });
```
By default, snapshots are saved in a directory next to your test file and a `.yml` file is created for each project specified in your Playwright configuration file. You can customize the snapshot path template using the `snapshotPathTemplate` option in the test runner configuration:
By default, snapshots are saved with the following pattern `{snapshotDir}/{testFileDir}/{testFileName}-snapshots/{arg}{ext}`. As snapshots should be the same across browsers, only one snapshot is saved even if testing with multiple browsers. Should you wish, you can customize the snapshot path template using the following configuration:
```js
export default defineConfig({
snapshotPathTemplate: '__snapshots__/{testFilePath}/{arg}{ext}',
});
export default {
expect: {
toMatchAriaSnapshot: {
pathTemplate: '__snapshots__/{testFilePath}/{arg}{ext}',
},
},
};
```
### 3. Using the `Locator.ariaSnapshot` method