jsDocs.io logo

@storybook/addon-a11y

  • Version 6.5.10
  • Published
  • 192 kB
  • 16 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

Functions

Interfaces

Variables

variable PARAM_KEY

const PARAM_KEY: string;

    variable withA11y

    const withA11y: DecoratorFunction<AnyFramework>;

      Functions

      function highlightObject

      highlightObject: (color: string) => {
          outline: string;
          outlineOffset: number;
          boxShadow: string;
      };

        function highlightStyle

        highlightStyle: (color: string) => string;

          Interfaces

          interface A11yParameters

          interface A11yParameters {}

            property config

            config?: Spec;

              property element

              element?: ElementContext;

                property manual

                manual?: boolean;

                  property options

                  options?: RunOptions;

                    interface Setup

                    interface Setup {}

                      property config

                      config: Spec;

                        property element

                        element?: ElementContext;

                          property options

                          options: RunOptions;

                            Package Files (4)

                            Dependencies (16)

                            Dev Dependencies (2)

                            Peer Dependencies (2)

                            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>