@storybook/addon-a11y

  • Version 9.0.11
  • Published
  • 514 kB
  • 2 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?: A11yParameters$1;
        • Accessibility configuration

          See Also

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

        Type Aliases

        type ContextObjectWithoutNode

        type ContextObjectWithoutNode =
        | {
        include: SelectorWithoutNode;
        exclude?: SelectorWithoutNode;
        }
        | {
        exclude: SelectorWithoutNode;
        include?: SelectorWithoutNode;
        };

          type ContextSpecWithoutNode

          type ContextSpecWithoutNode = SelectorWithoutNode | ContextObjectWithoutNode;

            type SelectorWithoutNode

            type SelectorWithoutNode = Omit<Selector, 'Node'> | Omit<SelectorList, 'NodeList'>;

              Package Files (1)

              Dependencies (2)

              Dev Dependencies (9)

              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>