@wedgekit/a11y

Purpose

Wedgekit A11y is meant to provide helpful components and helpers for creating applications that are accessible to all peoples in a consistent and predictable way.

⚠️ Warning: The @wedgekit/a11y API will be substantially rewritten in v5. To avoid unnecessary tech debt, it is not advised to add @wedgekit/a11y to new applications until the release of @wedgekit/[email protected]. This documentation is solely for maintenance purposes only.

Getting Started

In order to use @wedgekit/a11y components your application needs to be wrapped in the A11yProvider. This does not render anything visible; it merely serves to provide context to components deeper within the app.

import { A11yProvider } from '@wedgekit/a11y';

const App = () => (
  <A11yProvider>
    <YourApp />
  </A11yProvider>
);

Modules

@wedgekit/a11y handles two main concerns: a skip navigation bar and a keyboard shortcuts modal

• Skip Navigation
• Keyboard Shortcuts