Salesforce Accessibility Automation Libraries

Salesforce Automated Accessibility Testing Libraries and Tools (@sa11y packages) based on axe-core

• Docs
• Packages
  • Jest integration
  • WDIO integration
  • assertAccessible API
  • a11y results formatter
  • Preset accessibility rules
  • Internal packages
    • Test utilities
    • Integration Tests
    • Common

Docs

• Developer Guidelines
  • Refer to Quick start instructions to get started, if you are a developer looking to Contribute
• Code of Conduct
• Changelog
• LICENSE

Packages

This repo contains packages for automated accessibility testing used by teams in Salesforce. However, they are not specific to Salesforce and can be used to test any UI supported by axe-core for accessibility.

(Image courtesy: @shleewhite, @jorycunningham)

Jest integration

• Provides a toBeAccessible() accessibility matcher for Jest
  • integrates the assertAccessible API with the Jest assertion API
• If you are looking to add accessibility testing to your Jest tests use this package

WDIO integration

• Provides assertAccessible(), assertAccessibleSync() APIs that can be used with WebdriverIO to check accessibility of web pages rendered in browsers

assertAccessible API

• Checks DOM or HTML Element for accessibility issues and throws an error if a11y issues are found
• If you are looking to add accessibility testing to your Javascript unit tests and not using Jest, use this package

a11y results formatter

• Formats raw JSON output of a11y issues from axe into an easy to consume format by consolidating and cross-referencing
• Used by assert Accessible API and Jest a11y matcher
• If you are using axe directly and want to format the results from axe.run use this package

Preset accessibility rules

• Provides Base, Recommended, Full accessibility preset rules as axe configuration
• The Recommended preset rule is used by default in the Jest a11y matcher and assert Accessible APIs
  • The APIs can be overridden to use the Base or Full ruleset as necessary

Internal packages

Test utilities

• Private package providing test utilities for @sa11y packages

Integration Tests

• Private package providing integration tests for @sa11y packages

Common

• Common utilities, constants, error messages for @sa11y packages