Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@storybook/addon-a11y

Package Overview
Dependencies
Maintainers
5
Versions
1917
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@storybook/addon-a11y

Test component compliance with web accessibility standards

  • 7.0.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1.8M
increased by4.81%
Maintainers
5
Weekly downloads
 
Created

What is @storybook/addon-a11y?

The @storybook/addon-a11y package is an addon for Storybook that helps you improve the accessibility of your UI components. It integrates with Storybook to provide automated checks and manual testing tools for accessibility issues, allowing developers to ensure their components are accessible to as many users as possible.

What are @storybook/addon-a11y's main functionalities?

Automated accessibility checks

Automatically run accessibility checks on your components within the Storybook UI. It uses the axe-core library to test each component for accessibility issues and provides a report.

import { withA11y } from '@storybook/addon-a11y';

export default {
  title: 'Button',
  decorators: [withA11y],
};

export const AccessibleButton = () => <button>Click me</button>;
export const InAccessibleButton = () => <button style={{ color: 'white', backgroundColor: 'white' }}>Can't see me</button>;

Manual accessibility testing tools

Provides tools for manual accessibility testing, such as color contrast checkers and keyboard event simulation, to complement the automated checks.

N/A

Customizable rules

Allows customization of the accessibility rules used for testing, enabling or disabling specific rules to tailor the checks to your project's needs.

import { withA11y } from '@storybook/addon-a11y';

export default {
  title: 'Button',
  decorators: [withA11y],
  parameters: {
    a11y: {
      config: {
        rules: [{ id: 'color-contrast', enabled: false }]
      }
    }
  }
};

Other packages similar to @storybook/addon-a11y

Keywords

FAQs

Package last updated on 31 Mar 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc