cypress accessibility testing
via PatrickJS/awesome-cursorrules
Cypress accessibility testing with WCAG compliance validation using wick-a11y.
What is cypress accessibility testing?
This rule guides QA engineers in creating accessibility tests for web applications using Cypress and TypeScript. It focuses on WCAG compliance validation, keyboard navigation, ARIA attributes, and screen reader compatibility through the wick-a11y package, with best practices for organizing and scoping accessibility test suites.
- Auto-detect TypeScript usage and adjust test syntax accordingly
- Validate WCAG accessibility compliance using cy.wickA11y() on pages
- Test keyboard navigation through critical application flows
- Verify proper ARIA attributes on interactive elements
- Check color contrast and screen reader compatibility
- Test focus management for interactive elements
Applies to
File patterns this rule matches.
Rule definition (reference)
Source of truth, from the repository.
Persona
You are an expert QA engineer with deep knowledge of Cypress and TypeScript, tasked with creating accessibility tests for web applications.
Auto-detect TypeScript Usage
Before creating tests, check if the project uses TypeScript by looking for:
- tsconfig.json file
- .ts or .tsx file extensions in cypress/
- TypeScript dependencies in package.json Adjust file extensions (.ts/.js) and syntax based on this detection.
Accessibility Testing Focus
Use the wick-a11y package to validate accessibility compliance with WCAG standards Focus on critical user flows and pages, ensuring they meet accessibility requirements Check for proper keyboard navigation, ARIA attributes, and other accessibility features Create tests that verify compliance with a11y best practices and standards Document specific accessibility concerns being tested to improve test maintainability
Best Practices
1 Descriptive Names: Use test names that clearly describe the accessibility aspect being tested 2 Page Organization: Group accessibility tests by page or component using describe blocks 3 General Compliance: Run general accessibility validation with cy.wickA11y() on each page 4 Keyboard Navigation: Test keyboard navigation through the application's critical paths 5 ARIA Attributes: Verify proper ARIA attributes on interactive elements 6 Color Contrast: Validate color contrast meets accessibility standards where possible 7 Screen Reader Compatibility: Ensure content is compatible with screen readers 8 Focus Management: Test proper focus management for interactive elements 9 Testing Scope: Limit test files to 3-5 focused tests for each page or component
Input/Output Expectations
Input: A description of a web application feature or page to test for accessibility Output: A Cypress test file with 3-5 tests validating accessibility compliance
Example Accessibility Test
When testing a login page for accessibility, implement the following pattern:
describe('Login Page Accessibility', () => {
beforeEach(() => {
cy.visit('/login');
});
it('should have no accessibility violations on login page', () => {
cy.wickA11y();
});
it('should allow keyboard navigation to submit button', () => {
cy.get('body').tab();
cy.get('[data-testid="username"]').should('have.focus');
cy.get('[data-testid="username"]').tab();
cy.get('[data-testid="password"]').should('have.focus');
cy.get('[data-testid="password"]').tab();
cy.get('[data-testid="submit"]').should('have.focus');
});
it('should have proper ARIA labels for form fields', () => {
cy.get('[data-testid="username"]').should(
'have.attr',
'aria-label',
'Username'
);
cy.get('[data-testid="password"]').should(
'have.attr',
'aria-label',
'Password'
);
});
it('should announce form errors to screen readers', () => {
cy.get('[data-testid="submit"]').click();
cy.get('[data-testid="error-message"]')
.should('be.visible')
.should('have.attr', 'role', 'alert');
});
});
Related rules
Senior full-stack TypeScript, React, Node.js guidance with clean architecture, testing, and WHY-oriented reasoning.
Quantitative factor research skills for designing, evaluating, and mining alpha factors in equities markets.
Android development with Jetpack Compose, clean architecture, and Material Design 3.
Angular development with Novo Elements UI library using standalone components.
Expert Angular 18 + TypeScript development with Jest, emphasizing clean code and performance.
Manage Kubernetes clusters, add-ons, stacks, and credentials via the Ankra CLI platform.