Abilyo by WebAbility

Cypress Plugin

Accessibility testing plugin for Cypress test suites.

Install

npm install -D @webability/cypress

Setup

1. Register the plugin

cypress.config.ts
import { webabilityPlugin } from '@webability/cypress'
 
export default defineConfig({
  e2e: {
    setupNodeEvents(on) {
      webabilityPlugin(on)
    }
  }
})

2. Add the custom command

cypress/support/commands.ts
import '@webability/cypress/support'

Usage

describe('Accessibility', () => {
  it('homepage has no critical issues', () => {
    cy.visit('/')
    cy.a11yCheck().then(result => {
      expect(result.summary.critical).to.equal(0)
    })
  })
 
  it('form page is accessible', () => {
    cy.visit('/contact')
    cy.a11yCheck().then(result => {
      expect(result.summary.serious).to.equal(0)
    })
  })
})

Requirements

  • Cypress 12+
  • Node.js 18+

On this page