@airship/tslint-react-a11y

A package to extend your React project with TSLint a11y rules.

Usage no npm install needed!

<script type="module">
  import airshipTslintReactA11y from 'https://cdn.skypack.dev/@airship/tslint-react-a11y';
</script>

README

Airship TSLint React a11y Extension

JSX a11y rules to extend TSLint used by the Airship Builders. This package is designed to extend the functionality of @teamairship/tslint-react-config while leaving the flexibility to leave these rules out when needed.

Installation

yarn add -D @airship/tslint-react-a11y

Usage

In tslint.json

{
  "extends": ["@airship/tslint-react-a11y"],
    "rules": {
    // override tslint-react-a11y rules here
    "react-a11y-lang": false
  }
}

Supported Rules

All rules are enabled by default.

Rule Name Description
react-a11y-accessible-headings Coming soon...
react-a11y-anchors Coming soon...
react-a11y-aria-unsupported-elements Coming soon...
react-a11y-event-has-role Coming soon...
react-a11y-iframes Coming soon...
react-a11y-image-button-has-alt Coming soon...
react-a11y-img-has-alt Coming soon...
react-a11y-input-elements Coming soon...
react-a11y-lang Coming soon...
react-a11y-meta Coming soon...
react-a11y-no-onchange Coming soon...
react-a11y-props Coming soon...
react-a11y-proptypes Coming soon...
react-a11y-required Coming soon...
react-a11y-role Coming soon...
react-a11y-role-has-required-aria-props Coming soon...
react-a11y-role-supports-aria-props Coming soon...
react-a11y-tabindex-no-positive Coming soon...
react-a11y-titles Coming soon...

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/teamairship/tslint-react-a11y. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

This package is available as open source under the terms of the MIT License.

Thanks