Skip to content

goodguyry/AriaComponents

Repository files navigation

npm version Build Status

AriaComponents

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

Installation

npm i aria-components

Usage

🌸 See the release/v0.3 branch for docs related to the current version.

Each component accepts an element and an options object.

import Tablist, { AutomaticActivation } from 'aria-components/tablist';

new Tablist(element, { modules: [AutomaticActivation] })

The base class, AriaComponent, provides properties and methods available to all components.

Each component's supplemental documentation can be found in its directory:

Modules

Each component exports modules to add optional features and functionality that, depending on the context, may simplify and/or improve UX.

General module documentation is at src/shared/modules/. Some components have additional documentation within their local modules directory.

References

Contributing

Use npm run dev to run tests and watch files for changes.

Check npm run for more.

About

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

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published