https://github.com/giuseppeg/wai-aria-practices-tests
✅ ♿️ A suite of end-to-end tests to check if your application is compliant with the WAI-ARIA authoring practices.
https://github.com/giuseppeg/wai-aria-practices-tests
Last synced: 12 months ago
JSON representation
✅ ♿️ A suite of end-to-end tests to check if your application is compliant with the WAI-ARIA authoring practices.
- Host: GitHub
- URL: https://github.com/giuseppeg/wai-aria-practices-tests
- Owner: giuseppeg
- License: mit
- Created: 2019-06-22T09:44:54.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T00:51:35.000Z (over 3 years ago)
- Last Synced: 2025-08-09T18:52:18.665Z (12 months ago)
- Language: JavaScript
- Homepage:
- Size: 704 KB
- Stars: 16
- Watchers: 2
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# WAI-ARIA Authoring Practices End-to-end tests
A suite of end-to-end tests to check if your application or website is compliant with the [WAI-ARIA authoring practices](https://www.w3.org/TR/wai-aria-practices-1.1).
The tests are written to work with Puppeteer and aim to be plug-n-play, i.e. they can test any application or website (some constraints apply).
This repo provides generic test suites that you can run against your applications of websites to test that behaviors of your widget adhere to the [WAI-ARIA authoring practices](https://www.w3.org/TR/wai-aria-practices-1.1).
Many folks don't spend time on accessibility and I hope that such a tool could encourage them to fix issues in a "test driven development" manner.
Note this is not a static analysis tool that checks for valid HTML [aria] attributes or semantic HTML.
## Proof of concept
Note this is a proof of concept. Your help and validation is very important to move this project forward.
To start off I am going to try to write tests for [modal dialogs](https://www.w3.org/TR/wai-aria-practices-1.1/#dialog_modal). You can find the code for it in `common/dialog/index.js`.
## npm
```
npm i -D wai-aria-practices-tests
```
## Examples
Bootstrap the project:
```
npm i
```
Run the tests with node:
```
npm run example:node
```
Run the tests with Jest:
```
npm run example:jest
```
## How it works
The idea is to write generic test that rely only on accessibility properties like aria-roles and, when necessary accept CSS selectors to retrieve elements.
Each suite in `common` is generic and uses the Node.js `assert` library API to make assertions.
Integrations for jest, AVA etc. would need to map to the `assert` interface. You can see an example in the `examples/jest` suite.
## License
MIT