@hint/hint-axe
Version:
hint that that checks using axe for accessibility related best practices
63 lines (54 loc) • 4.28 kB
Markdown
<!-- autogenerated by scripts/create/create-docs.js -->
<!-- markdownlint-disable MD013 -->
# Axe: ARIA (`aria`)
`axe/aria` contains accessibility rules
from the axe aria category.
See the ["Can the hint be configured?"][can configure] section of
`hint-axe` for examples of enabling, disabling, and changing the
severity of individual rules.
## Default rules (WCAG 2.1 Level A and Level AA)
* [Elements must only use allowed ARIA attributes][aria-allowed-attr] (aria-allowed-attr)
* [ARIA commands must have an accessible name][aria-command-name] (aria-command-name)
* [aria-hidden='true' must not be present on the document body][aria-hidden-body] (aria-hidden-body)
* [ARIA input fields must have an accessible name][aria-input-field-name] (aria-input-field-name)
* [ARIA meter nodes must have an accessible name][aria-meter-name] (aria-meter-name)
* [ARIA progressbar nodes must have an accessible name][aria-progressbar-name] (aria-progressbar-name)
* [Required ARIA attributes must be provided][aria-required-attr] (aria-required-attr)
* [Certain ARIA roles must contain particular children][aria-required-children] (aria-required-children)
* [Certain ARIA roles must be contained by particular parents][aria-required-parent] (aria-required-parent)
* [aria-roledescription must be on elements with a semantic role][aria-roledescription] (aria-roledescription)
* [ARIA roles used must conform to valid values][aria-roles] (aria-roles)
* [ARIA toggle fields must have an accessible name][aria-toggle-field-name] (aria-toggle-field-name)
* [ARIA tooltip nodes must have an accessible name][aria-tooltip-name] (aria-tooltip-name)
* [ARIA attributes must conform to valid names][aria-valid-attr] (aria-valid-attr)
* [ARIA attributes must conform to valid values][aria-valid-attr-value] (aria-valid-attr-value)
* [Table header text must not be empty][empty-table-header] (empty-table-header)
## Additional rules (off by default)
* [ARIA role should be appropriate for the element][aria-allowed-role] (aria-allowed-role)
* [ARIA dialog and alertdialog nodes should have an accessible name][aria-dialog-name] (aria-dialog-name)
* ["role=text" should have no focusable descendants][aria-text] (aria-text)
* [ARIA treeitem nodes should have an accessible name][aria-treeitem-name] (aria-treeitem-name)
* [Elements of role none or presentation should be flagged][presentation-role-conflict] (presentation-role-conflict)
<!-- Link labels: -->
[can configure]: https://webhint.io/docs/user-guide/hints/hint-axe/#can-the-hint-be-configured
[aria-allowed-attr]: https://dequeuniversity.com/rules/axe/4.4/aria-allowed-attr
[aria-allowed-role]: https://dequeuniversity.com/rules/axe/4.4/aria-allowed-role
[aria-command-name]: https://dequeuniversity.com/rules/axe/4.4/aria-command-name
[aria-dialog-name]: https://dequeuniversity.com/rules/axe/4.4/aria-dialog-name
[aria-hidden-body]: https://dequeuniversity.com/rules/axe/4.4/aria-hidden-body
[aria-input-field-name]: https://dequeuniversity.com/rules/axe/4.4/aria-input-field-name
[aria-meter-name]: https://dequeuniversity.com/rules/axe/4.4/aria-meter-name
[aria-progressbar-name]: https://dequeuniversity.com/rules/axe/4.4/aria-progressbar-name
[aria-required-attr]: https://dequeuniversity.com/rules/axe/4.4/aria-required-attr
[aria-required-children]: https://dequeuniversity.com/rules/axe/4.4/aria-required-children
[aria-required-parent]: https://dequeuniversity.com/rules/axe/4.4/aria-required-parent
[aria-roledescription]: https://dequeuniversity.com/rules/axe/4.4/aria-roledescription
[aria-roles]: https://dequeuniversity.com/rules/axe/4.4/aria-roles
[aria-text]: https://dequeuniversity.com/rules/axe/4.4/aria-text
[aria-toggle-field-name]: https://dequeuniversity.com/rules/axe/4.4/aria-toggle-field-name
[aria-tooltip-name]: https://dequeuniversity.com/rules/axe/4.4/aria-tooltip-name
[aria-treeitem-name]: https://dequeuniversity.com/rules/axe/4.4/aria-treeitem-name
[aria-valid-attr]: https://dequeuniversity.com/rules/axe/4.4/aria-valid-attr
[aria-valid-attr-value]: https://dequeuniversity.com/rules/axe/4.4/aria-valid-attr-value
[empty-table-header]: https://dequeuniversity.com/rules/axe/4.4/empty-table-header
[presentation-role-conflict]: https://dequeuniversity.com/rules/axe/4.4/presentation-role-conflict