aria-components

AriaComponents

Quickly create accessible interactive components based on the W3C spec and examples

• https://www.w3.org/TR/wai-aria-1.1/
• https://www.w3.org/TR/wai-aria-practices-1.1/examples/

Installation

npm i aria-components

Component documentation:

• Dialog
• Disclosure
• Listbox
• Menu
• MenuBar
• MenuButton
• Popup
• Tablist

Each of the above extends AriaComponent, which provides basic state management and component structure.

Help text elements

Elements used for keyboard navigation description and referenced on the element via aria-labelledby need to exist in the DOM.

The Menu and MenuBar components reference such elements. As a result, authors will need to manually add the elements to their page(s).

Examples can be found in the docs directory:

• docs/_includes/help-text.html
• docs/_includes/help-text.php

See also the Menu and Menubar components' README

Aside from the help text examples above, authors are responsible for adding all necessary aria-labelledby, aria-label and aria-describedby to the revelant elements.

Note:

This package is provided without processing; you'll likely need to run these through Babel to use them in your projects.

Contributing

npm run watch
Run Jest and watch files for changes.

npm run dev
Run Webpack in development mode and Jekyll serve the example page at http://127.0.0.1:8080/AriaComponents/

npm run build
Run Webpack in production mode. This is required prior to merging to ensure assets are ready for GitHub Pages.

Changelog

0.2.0

Changed

• Improves tracking of internal Popup state (#22)

Added

• Roving tabIndex helpers accept an HTMLCollection (#18)
• Merge nested component state with the parent component's state (#19)

Fixed

• Corrects the Popup's focusable elements' initial tabindex (#15)

BREAKING CHANGES

• Moves helper functions to utils/ (#17)
• Deprecates the Menu and MenuBar menu config property in favor of list (#20)
• Deprecates the Tablist tablist config property in favor of tabs (#20)
• Updates the way the componentName and self references are managed (#21)
• Deprecates MenuBar onPopupStateChange and onPopupDestroy callbacks (#22)