a11y checker
Identifies accessibility issues in HTML markup.
Install
npm install --save a11y-checkerUsage
- Import a11yChecker
import a11yChecker from 'a11y-checker';- Call it after page loads:
a11yChecker();Live Examples
- JS Live Example(link is external)
- JS Code Example(link is external)
- React Live Example(link is external)
- React Code Example(link is external)
- Vue Live Example(link is external)
- Vue Code Example(link is external)
Contributing
Hey there! Thanks for your interest in helping out. If you happen to
run into any issues, please
open an issue(link is external),
and I'll do my best to help out.
To begin contributing, you'll first need to
clone this repository(link is external),
then navigate into the repository's directory.
git clone git@github.com:{{ YOUR_USERNAME }}/a11y-checker.git
cd a11y-checker/
Next, install the dependencies using npm(link is external).
npm install
Great! – you're ready to contribute!
Create git branch
git checkout -b BRANCH_NAME_HERE
Run code locally. To do that, execute the start command:
| commands | Description |
|---|---|
npm start |
Run project locally on port=8080. |
npm build |
Generate a minified, production-ready build. |
Files structure
| Folder | Description |
|---|---|
| src | for development files. |
| head | for check everything happens inside <head> |
| body | for check everything happens inside <body> |
Rules
Tools
there's a lot of a11y linters and tools that work and maintained better than A11y-Checker.
| Tools | Description |
|---|---|
| eslint-jsx(link is external) | Static AST checker for a11y rules on JSX elements. |
| axe-core(link is external) | Generate a minified, production-ready build. |
| ally.js(link is external) | JavaScript library to help modern web applications with accessibility concerns |
| Awesome-a11y-validators(link is external) | List of development Testing and Validators tools. |
That's All. Thanks.
Made by ILUNION for the Prosperity4All project: Ecosystem infrastructure for smart and personalised inclusion and PROSPERITY for ALL stakeholders. This project has received funding from the European Union’s Seventh Programme for research, technological development and demonstration under grant agreement, No 610510.