Skip to content

Files

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Latest commit

May 8, 2025
4e87252 · May 8, 2025

History

History
191 lines (174 loc) · 8.74 KB

File metadata and controls

191 lines (174 loc) · 8.74 KB
sidebar_label title description sidebar_position sidebar_custom_props
Introduction
Accessibility Testing | Cypress Documentation
Cypress Accessibility provides organized, visual, and actionable accessibility reports, based completely on the tests you record to Cypress Cloud, and powered by Axe Core® by Deque Systems.
10
new_label
true

Automated accessibility checks on every test

Cypress Accessibility adds detailed accessibility checks and workflows in Cypress Cloud, with zero impact on test execution.

  • Instantly visualize, triage, and fix accessibility violations without any additional code or configuration.
  • Dive deep into each violation with live, fully-rendered DOM snapshots of your application as it appeared during your tests.
  • Filter out the noise to explore only newly-introduced issues related to specific commits.
  • Track your team's progress over time with historical scores to monitor improvements and identify regressions.

Looking for a general guide for accessibility testing concepts in Cypress App? Go to the accessibility testing guide.

Get Started

You don't need to make any changes to your code or your test setup. If you record test runs to the Cypress Cloud with Test Replay, you're ready to start using Cypress Accessibility. You'll start your free trial with personalized support from our sales team and your existing test data to instantly see full accessibility reports for all your Cypress projects. From there, you can integrate with CI to set your own standards for handling the results.

Get started with Cypress Accessibility ➜

Top Guides

  • Discover how to break down accessibility reports, prioritize fixes, and make impactful progress toward accessible software with Cypress Accessibility.

  • Compare reports in detail to review only _new_ accessibility issues, use our API to react to runs that don't meet your standards, and spot trends with analytics.

  • Learn how to maintain long-term accessibility with Cypress, using continuous feedback and monitoring to prevent regressions and keep your application accessible.

  • Set policies and block pull requests automatically with Cypress Accessibility's Results API, enabling custom CI workflows to enforce accessibility standards and prevent regressions.

  • Get precise, fast, and scoped accessibility feedback during local development by recording Cypress tests directly to Cypress Cloud—bypassing CI pipelines and ensuring accurate insights with minimal effort.

  • Monitor accessibility issues in production by running scheduled Cypress tests against live environments, capturing dynamic content changes, and generating automated reports for a comprehensive accessibility overview.

  • Expand accessibility testing by combining Cypress Accessibility's automated checks with custom assertions tailored to your application, identifying hotspots for deeper manual review, and ensuring long-term quality with a hybrid testing approach.

  • Apply these core principles to maximize the impact of Cypress Accessibility's automation: complement automation with human judgment for deeper insights, manage false positives effectively, and ensure robust assistive technology support.

What to expect

Cypress Accessibility delivers detailed, actionable accessibility reports directly from your tests, powered by the industry-leading Axe Core® library by Deque Systems. These reports require no extra setup and are automatically generated for every unique state reached during your Cypress tests, whether in end-to-end or component testing.

  • No setup: Cypress Accessibility utilizes the same capture protocol as Test Replay (requires Cypress v13+), so no additional code or configuration is needed.
  • No test slowdown or flakiness: Server-side execution ensures no impact on test performance or existing code.
  • Comprehensive reporting: During test execution, unique states—defined by distinct DOM structures—are recorded for end-to-end views and components.
  • DOM snapshots: Each detected violation is accompanied by a full-page, inspectable DOM snapshot, highlighting the exact location and context of the violation.
  • Report generation: Detailed reports are generated, offering sortable and filterable views by page, component, or the entire test run. Rule-based summaries for an aggregated view of accessibility outcomes for the entire run are also available.
  • Run comparison: Compare the results from two runs and see only the new issues. Know before you merge if a code change is going to cause new accessibility problems.
  • Selective element handling: Elements marked as "ignored" in tests are excluded from scoring but remain visible for manual review, ensuring flexibility via configuration.
  • Flexible pipeline integration: The Results API allows you to programmatically control your CI pipeline's behavior based on accessibility outcomes, enabling enforcement of accessibility policies.

Learn more about how it works.

Note: DEQUE, DEQUELABS, AXE®, and AXE-CORE® are trademarks of Deque Systems, Inc. in the US and other countries. These terms are used throughout our documentation to refer to the accessibility testing library used by Cypress Accessibility.