Exciting release!Introducing "safe npm". Learn more
Socket
Log inDemoInstall

axe-mode

Package Overview
Dependencies
4
Maintainers
1
Versions
3
Issues
File Explorer

Advanced tools

axe-mode

![npm](https://img.shields.io/npm/v/axe-mode?color=%236469FF)

    0.0.1-alpha.3latest
    npm

Version published
Maintainers
1
Weekly downloads
1,291
increased by79.31%

Weekly downloads

Readme

Source

axe-mode

npm

WIP

This project is an attempt to leverage axe-core in a component to find accessibility violations and provide information on how to resolve them.

Currently, this only works for React.

See it in action on CodeSandbox.

Demo

Usage

Install the library:

yarn add axe-mode -D

or

npm install axe-mode --save-dev

Import the component and wrap it around your application or any other component tree you would like to validate:

import AxeMode from 'axe-mode'; function App() { return ( <AxeMode disabled={process.env.NODE_ENV !== 'development'}> <h1 aria-expanded="123">Hello world!</h1> </AxeMode> ); }

Launch your application as usual. Any violations of accessibility will show up as an overlay. If you wish to interact with your application, overlays can be toggled on/off with Ctrl + I.

Note: Make sure to only run in production by using the disabled prop with your environment variable.

Development

TSDX scaffolds your new library inside /src, and also sets up a Parcel-based playground for it inside /example.

The recommended workflow is to run TSDX in one terminal:

npm start # or yarn start

This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

Then run the example inside another:

cd example npm i # or yarn to install dependencies npm start # or yarn start

The default example imports and live reloads whatever is in /dist, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. No symlinking required, we use Parcel's aliasing.

To do a one-off build, use npm run build or yarn build.

To run tests, use npm test or yarn test.

FAQs

Last updated on 08 Jun 2020

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket
support@socket.devSocket SOC 2 Logo

Product

  • Package Issues
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc