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

@proof-ui/a11y-plugin

Package Overview
Dependencies
Maintainers
3
Versions
52
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@proof-ui/a11y-plugin

Uses [`axe`](https://www.deque.com/axe/) to scan each story against accessibility rules. Violatons are printed to the console, and included in any reports.

  • 0.3.5
  • npm
  • Socket score

Version published
Weekly downloads
250
decreased by-13.49%
Maintainers
3
Weekly downloads
 
Created
Source

@proof-ui/a11y-plugin

Uses axe to scan each story against accessibility rules. Violatons are printed to the console, and included in any reports.

Installation

yarn add -D @proof-ui/a11y-plugin

Usage

// proof.config.js
import A11yPlugin from '@proof-ui/a11y-plugin';

export default {
  plugins: [
    new A11yPlugin({
      // Configuration
    })
  ]
};
# Command Line Usage
proof --a11y

Options

You can configure the A11yPlugin through some options in it's constructor:

PropertyDescriptionTypeDefault
configThe AXE rule configuration to use when testing a storyobject (see axe.Spec)
rootA selector for the root context when checking for violationsstring'#root'

FAQs

Package last updated on 24 Oct 2022

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