Skip to content

Commit 0e5ddee

Browse files
Update README with Accessibility standards
1 parent cdec5d9 commit 0e5ddee

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![logo](./docs/logo.png)
1+
<img width="1313" height="741" alt="image" src="https://github.com/user-attachments/assets/4063015f-9efb-4814-8af5-585835560869" />![logo](./docs/logo.png)
22

33
# Axe-Playwright
44

@@ -340,6 +340,25 @@ await checkA11y(
340340
},
341341
)
342342
```
343+
344+
### Accesibility Standards
345+
346+
To ensure your tests meet accessibility standards, configure axe-playwright with the following options:
347+
348+
```js
349+
await checkA11y(page, '#storybook-root', {
350+
detailedReport: true,
351+
detailedReportOptions: {
352+
html: true,
353+
},
354+
verbose: false,
355+
axeOptions: {
356+
runOnly: ['wcag21aa', 'wcag22aa', 'best-practice', 'EN-301-549']
357+
}
358+
}, true, 'v2');
359+
```
360+
361+
343362
## Before you Go
344363

345364
If it works for you , leave a [Star](https://github.com/abhinaba-ghosh/axe-playwright)! :star:

0 commit comments

Comments
 (0)