translate

a11y-checker


a11y checker

Identifies accessibility issues in HTML markup.

Install


npm install --save a11y-checker

Usage

  • Import a11yChecker

import a11yChecker from 'a11y-checker';
  • Call it after page loads:

a11yChecker();

Live Examples

Contributing

Hey there! Thanks for your interest in helping out. If you happen to
run into any issues, please
open an issue,
and I'll do my best to help out.

To begin contributing, you'll first need to
clone this repository,
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.


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

Docs

Tools

there's a lot of a11y linters and tools that work and maintained better than A11y-Checker.

Tools Description
eslint-jsx Static AST checker for a11y rules on JSX elements.
axe-core Generate a minified, production-ready build.
ally.js JavaScript library to help modern web applications with accessibility concerns
Awesome-a11y-validators List of development Testing and Validators tools.

That's All. Thanks.

Rating

ABOUT

LESS COMMENTS

MESSAGE REVIEW OK

Ok