Files
cypress/npm/react/examples/a11y

example: a11y

Testing component accessibility

Usage

  1. Make sure the root project has been built .
# in the root of the project
npm install
npm run build
  1. Run npm install in this folder to symlink the @cypress/react dependency.
# in this folder
npm install
  1. Start Cypress
npm run cy:open
# or just run headless tests
npm test

Example

Testing components following the React accessibility guide using cypress-axe plugin.

See the spec file cypress/component/spec.js. For example, an <input> without a label is caught:

mount(<input type="text" value="John Smith" name="name" />)
cy.checkA11y('input', {
  runOnly: {
    type: 'tag',
    values: ['wcag2a'],
  },
})

Input without a label

You can click on the error to see more details in the DevTools console

Error details