cypress-axe for accessibility - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is cypress-axe used for in web development?

cypress-axe is a tool that helps automatically check web pages for accessibility issues during Cypress end-to-end tests. It integrates the axe-core accessibility engine with Cypress.

beginner

How do you add cypress-axe to your Cypress test file?

You import it with <code>import 'cypress-axe'</code> at the top of your test file. Then you can use commands like <code>cy.injectAxe()</code> and <code>cy.checkA11y()</code>.

beginner

What does cy.injectAxe() do in a Cypress test?

It injects the axe-core accessibility testing library into the page under test, so you can run accessibility checks on that page.

beginner

What is the purpose of cy.checkA11y() in cypress-axe?

It runs accessibility checks on the page or a specific element and reports any accessibility violations found.

beginner

Why is accessibility testing important in web development?

Accessibility testing ensures that websites can be used by people with disabilities, improving usability for everyone and meeting legal requirements.

Which command injects the axe-core library into the page in cypress-axe?

A cy.injectAxe()

B cy.checkA11y()

C cy.visit()

D cy.runAxe()

cy.injectAxe() adds the axe-core library to the page so accessibility checks can be run.

What does cy.checkA11y() do?

A Clicks a button

B Runs accessibility checks and reports violations

C Loads the web page

D Injects JavaScript into the page

cy.checkA11y() runs accessibility tests and reports any issues found.

Where should you import 'cypress-axe' in your test files?

A In the HTML page

B Inside a test case

C At the top of the test file

D In the Cypress config file

You import 'cypress-axe' at the top of your Cypress test files to use its commands.

Why is accessibility testing done during Cypress tests?

A To speed up page loading

B To test database connections

C To check browser compatibility

D To find and fix accessibility issues early

Accessibility testing during Cypress tests helps catch issues early in development.

Which of these is NOT a benefit of using cypress-axe?

A Manual keyboard navigation testing

B Automated accessibility testing

C Integration with Cypress tests

D Reports accessibility violations

Manual keyboard navigation testing is done by a person, not by cypress-axe.

Explain how you would set up and run an accessibility test using cypress-axe in a Cypress test.

Think about the order of commands and what each does.

Why is it important to include accessibility testing like cypress-axe in your web development workflow?

Consider benefits for users and developers.

Practice

1. What is the main purpose of using cypress-axe in Cypress tests?

easy

A. To generate random test data for forms

B. To speed up the loading time of web pages

C. To style elements dynamically during tests

D. To automatically find accessibility problems on web pages during tests

Solution

1. Step 1: Understand the role of cypress-axe

   cypress-axe is a tool that integrates axe accessibility checks into Cypress tests.

2. Step 2: Identify what it helps with

   It helps find accessibility issues automatically during test runs to improve web accessibility.

3. Final Answer:

   To automatically find accessibility problems on web pages during tests -> Option D

4. Quick Check:

   cypress-axe = accessibility problem detection [OK]

Hint: Remember cypress-axe finds accessibility issues automatically [OK]

Common Mistakes:

• Thinking it speeds up page loading
• Confusing it with styling tools
• Assuming it generates test data

2. Which command correctly injects axe into the page before running accessibility checks in Cypress?

easy

A. cy.runAxe()

B. cy.loadAxe()

C. cy.injectAxe()

D. cy.startAxe()

Solution

1. Step 1: Recall the cypress-axe setup command

   The official command to inject axe into the page is cy.injectAxe().

2. Step 2: Verify other options

   Other options like cy.runAxe(), cy.loadAxe(), and cy.startAxe() are not valid Cypress commands for this purpose.

3. Final Answer:

   cy.injectAxe() -> Option C

4. Quick Check:

   Inject axe = cy.injectAxe() [OK]

Hint: Use cy.injectAxe() to add axe before checks [OK]

Common Mistakes:

• Using cy.runAxe() instead of cy.injectAxe()
• Confusing command names
• Forgetting to inject axe before checking

3. Given the following Cypress test code snippet, what will cy.checkA11y() do?

cy.visit('/home')
cy.injectAxe()
cy.checkA11y()

medium

A. Run accessibility checks on the entire page and report any violations

B. Reload the page and ignore accessibility

C. Only check the header element for accessibility

D. Throw an error because cy.checkA11y() needs arguments

Solution

1. Step 1: Understand the code sequence

   The code visits the page, injects axe, then runs cy.checkA11y() without arguments.

2. Step 2: Know default behavior of cy.checkA11y()

   Without arguments, cy.checkA11y() runs accessibility checks on the whole page and reports violations.

3. Final Answer:

   Run accessibility checks on the entire page and report any violations -> Option A

4. Quick Check:

   cy.checkA11y() default = full page check [OK]

Hint: cy.checkA11y() without args checks whole page [OK]

Common Mistakes:

• Thinking it only checks part of the page
• Assuming it throws error without args
• Confusing it with page reload

4. You wrote this Cypress test:

cy.visit('/dashboard')
cy.checkA11y()

But the accessibility check does not run and no errors appear. What is missing?

medium

A. You forgot to call cy.injectAxe() before cy.checkA11y()

B. You need to add cy.wait() before cy.checkA11y()

C. You must pass a selector to cy.checkA11y()

D. You should use cy.runAxe() instead of cy.checkA11y()

Solution

1. Step 1: Identify missing axe injection

   Before running accessibility checks, axe must be injected with cy.injectAxe().

2. Step 2: Confirm correct command usage

   Without injection, cy.checkA11y() does not run properly and silently fails.

3. Final Answer:

   You forgot to call cy.injectAxe() before cy.checkA11y() -> Option A

4. Quick Check:

   Inject axe first = cy.injectAxe() [OK]

Hint: Always inject axe before checking accessibility [OK]

Common Mistakes:

• Skipping cy.injectAxe()
• Adding unnecessary cy.wait()
• Passing selector when not needed
• Using wrong command cy.runAxe()

5. You want to check accessibility only on the main content area with id main-content. Which code snippet correctly does this using cypress-axe?

hard

A. cy.checkA11y()
cy.injectAxe('#main-content')

B. cy.injectAxe()
cy.checkA11y('#main-content')

C. cy.injectAxe('#main-content')
cy.checkA11y()

D. cy.checkA11y('#main-content')
cy.injectAxe()

Solution

1. Step 1: Inject axe before checking

   First, call cy.injectAxe() without arguments to add axe to the page.

2. Step 2: Run checkA11y with selector

   Then call cy.checkA11y('#main-content') to check accessibility only inside that element.

3. Final Answer:

   cy.injectAxe() followed by cy.checkA11y('#main-content') -> Option B

4. Quick Check:

   Inject first, then check with selector [OK]

Hint: Inject axe first, then check with selector string [OK]

Common Mistakes:

• Calling checkA11y before injectAxe
• Passing selector to injectAxe
• Not injecting axe at all
• Calling injectAxe after checkA11y