@storybook/addon-a11y

  • Version 8.6.12
  • Published
  • 445 kB
  • 4 dependencies
  • MIT license

Install

npm i @storybook/addon-a11y
yarn add @storybook/addon-a11y
pnpm add @storybook/addon-a11y

Overview

Test component compliance with web accessibility standards

Index

Variables

variable PARAM_KEY

const PARAM_KEY: string;

    Functions

    function _default

    _default: () => core_dist_types.ProjectAnnotations<core_dist_types.Renderer>;

      Interfaces

      interface A11yParameters

      interface A11yParameters {}

        property a11y

        a11y?: {
        /** Manual configuration for specific elements */
        element?: ElementContext;
        /**
        * Configuration for the accessibility rules
        *
        * @see https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axeconfigure
        */
        config?: Spec;
        /**
        * Options for the accessibility checks To learn more about the available options,
        *
        * @see https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter
        */
        options?: RunOptions;
        /** Remove the addon panel and disable the addon's behavior */
        disable?: boolean;
        };
        • Accessibility configuration

          See Also

          • https://storybook.js.org/docs/writing-tests/accessibility-testing

        interface Setup

        interface Setup {}

          property config

          config: Spec;

            property element

            element?: ElementContext;

              property options

              options: RunOptions;

                Package Files (1)

                Dependencies (4)

                Dev Dependencies (11)

                Peer Dependencies (1)

                Badge

                To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@storybook/addon-a11y.

                • Markdown
                  [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@storybook/addon-a11y)
                • HTML
                  <a href="https://www.jsdocs.io/package/@storybook/addon-a11y"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>