Aria Live
Inspect announcements of ARIA live regions
npm install storybook-addon-aria-live
13
Downloads per week

Storybook Addon Aria Live

version

Storybook addon for inspecting ARIA live region announcements

storybook-addon-aria-live is a Storybook addon for inspecting ARIA live region announcements. Internally it is utilizing aria-live-capture for announcement detection.

Test online

Installation

storybook-addon-aria-live should be included in development dependencies.

yarn add --dev storybook-addon-aria-live

In your .storybook/main.js:

module.exports = {
  addons: ['storybook-addon-aria-live'],
};

Use Storybook parameters to set global or story specific options:

In your .storybook/preview.js:

export const parameters = {
  'aria-live': {
    /** Indicates whether live regions inside `ShadowRoot`s should be tracked. Defaults to false. */
    includeShadowDom: true,
  },
};

Development

Project setup is based on storybookjs/addon-kit. See its README for instructions about tooling.