https://github.com/salesforce/sa11y
Salesforce Automated Accessibility Testing Libraries
https://github.com/salesforce/sa11y
accessibility accessibility-automation accessibility-testing automation axe javascript salesforce test
Last synced: 17 days ago
JSON representation
Salesforce Automated Accessibility Testing Libraries
- Host: GitHub
- URL: https://github.com/salesforce/sa11y
- Owner: salesforce
- License: bsd-3-clause
- Created: 2020-03-12T12:34:10.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-31T10:31:34.000Z (10 months ago)
- Last Synced: 2025-04-02T21:40:55.480Z (10 months ago)
- Topics: accessibility, accessibility-automation, accessibility-testing, automation, axe, javascript, salesforce, test
- Language: TypeScript
- Homepage: https://www.npmjs.com/org/sa11y
- Size: 7.08 MB
- Stars: 95
- Watchers: 11
- Forks: 23
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Salesforce Accessibility Automation Libraries
Automated Accessibility Testing Libraries and Tools ([@sa11y packages](https://www.npmjs.com/org/sa11y)) based on [axe-core][axe] providing support for [Jest](#jest-integration) unit tests, [Vitest](#vitest-integration) unit tests, [WebdriverIO](#wdio-integration) component/integration tests used by teams in Salesforce. However, they are not specific to Salesforce and can be used to test any UI [supported by axe-core](https://github.com/dequelabs/axe-core#supported-browsers) for accessibility. These libraries are designed to be flexible, customizable and reusable to support automated accessibility testing in different testing workflows from unit to integration tests.
[](https://codecov.io/gh/salesforce/sa11y)
[](https://github.com/semantic-release/semantic-release)
[](./LICENSE.txt)
[](https://www.npmtrends.com/@sa11y/common)
[](https://snyk.io/test/github/salesforce/sa11y?targetFile=package.json)
[](https://api.securityscorecards.dev/projects/github.com/salesforce/sa11y)
- [Docs](#docs)
- [References](#references)
- [Packages](#packages)
- [Jest integration](#jest-integration)
- [Vitest integration](#vitest-integration)
- [WDIO integration](#wdio-integration)
- [assertAccessible API](#assertaccessible-api)
- [a11y results formatter](#a11y-results-formatter)
- [Preset accessibility rules](#preset-accessibility-rules)
- [Core accessibility matcher](#core-accessibility-matcher)
- [Minified bundle for testing in browser](#minified-bundle-for-testing-in-browser)
- [Internal packages](#internal-packages)
- [Test utilities](#test-utilities)
- [Integration Tests](#integration-tests)
- [Common utilities](#common-utilities)
- [Epilogue](#epilogue)
## Docs
- [Developer Guidelines](./CONTRIBUTING.md)
- Refer to [Quick start](./CONTRIBUTING.md#quick-start) instructions to get started, if you are a developer looking to Contribute
- [Code of Conduct](./CODE_OF_CONDUCT.md)
- [Changelog](./CHANGELOG.md)
- [LICENSE](./LICENSE.txt)
### References
- [Automated Accessibility Tests with sa11y | Developer Quick Takes - YouTube](https://www.youtube.com/watch?v=ScqZisOBbUM&list=PLgIMQe2PKPSJdFGHjGpjd1FbCsOqq5H8t&index=21)
- [Automated Accessibility Testing with sa11y | Salesforce Developers Blog](https://developer.salesforce.com/blogs/2020/10/automated-accessibility-testing-with-sa11y.html)
- [Get Started with Web Accessibility | Salesforce Trailhead](https://trailhead.salesforce.com/en/content/learn/trails/get-started-with-web-accessibility)
- [Accessibility Overview - Lightning Design System](https://www.lightningdesignsystem.com/accessibility/overview/)
- [LWC Accessibility guide](https://lwc.dev/guide/accessibility)
## Packages
This repo contains the following packages for automated accessibility testing:
### [Jest integration](./packages/jest/README.md)
[](https://www.npmjs.com/package/@sa11y/jest)
- Provides a `toBeAccessible()` accessibility matcher for Jest
- integrates the [assertAccessible API](./packages/assert/README.md) with the [Jest assertion API](https://jestjs.io/docs/en/using-matchers)
- Provides an option to set up the sa11y API to be invoked automatically at the end of each test
- Includes custom results processors for enhanced test reporting and grouping violations by rule
- To add accessibility testing to your Jest tests use this package
### [Vitest integration](./packages/vitest/README.md)
[](https://www.npmjs.com/package/@sa11y/vitest)
- Provides a `toBeAccessible()` accessibility matcher for Vitest
- Integrates the core accessibility checking logic with the [Vitest testing framework](https://vitest.dev/)
- Supports automatic checks and custom results processing for enhanced test reporting
- Built on the same core logic as the Jest integration via [@sa11y/matcher](./packages/matcher/README.md)
- To add accessibility testing to your Vitest tests use this package
### [WDIO integration](./packages/wdio/README.md)
[](https://www.npmjs.com/package/@sa11y/wdio)
- Provides `assertAccessible()`, `assertAccessibleSync()` APIs that can be used with [WebdriverIO](https://webdriver.io/) to check accessibility of web pages rendered in browsers
### [assertAccessible API](./packages/assert/README.md)
[](https://www.npmjs.com/package/@sa11y/assert)
- Checks DOM or HTML Element for accessibility issues and throws an error if a11y issues are found
- Supports both violations and incomplete results reporting
- To add accessibility testing to your Javascript unit tests _not_ using Jest or Vitest, use this package
### [a11y results formatter](./packages/format/README.md)
[](https://www.npmjs.com/package/@sa11y/format)
- 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/Vitest a11y matchers
- Provides exception list filtering and WCAG metadata enhancement
- To use axe directly and want to format the results from `axe.run` use this package
- A new formatter `groupViolationResultsProcessor` also made available to group the a11y violations per jest test case as the existing formatter would generate test failures for each violation
### [Preset accessibility rules](./packages/preset-rules/README.md)
[](https://www.npmjs.com/package/@sa11y/preset-rules)
- Provides Base, Extended, Full accessibility preset rules as [axe] configuration
- The Base preset rule is used by default in the Jest/Vitest a11y matchers and assert Accessible APIs
- The APIs can be overridden to use the Extended or Full ruleset as necessary
- Includes custom rule support and WCAG metadata for enhanced reporting
### [Core accessibility matcher](./packages/matcher/README.md)
[](https://www.npmjs.com/package/@sa11y/matcher)
- Provides the core accessibility checking logic used by Jest and Vitest integrations
- Framework-agnostic programmatic APIs for accessibility testing
- Supports automatic checks, DOM mutation observation, and custom integrations
- Use this package directly for custom test runners or advanced scenarios requiring direct control
### [Minified bundle for testing in browser](./packages/browser-lib/README.md)
[](https://www.npmjs.com/package/@sa11y/browser-lib)
- Provides a minified version of selected `@sa11y` libraries to be injected into a browser (using webdriver) and executed from integration testing workflows.
- Gives WCAG SC for rulesets in addition with [axe] tags
- Supports both Selenium Java and WebdriverIO integration patterns
### Internal packages
#### [Test utilities](./packages/test-utils/README.md)
- Private package providing test utilities, mock data, and common testing patterns for `@sa11y` packages
- Includes DOM fixtures with and without accessibility issues for testing
#### [Integration Tests](./packages/test-integration/README.md)
- Private package providing integration tests for `@sa11y` packages across different environments
- Ensures cross-package compatibility and end-to-end functionality
#### [Common utilities](./packages/common/README.md)
- Common utilities, constants, error messages, and helper functions for `@sa11y` packages
- Provides shared functionality for environment detection, custom rules, and file processing
---
### Epilogue
A wise person once said…
_"Don't talk to me until I've had coffee and you've run axe"_
(Image courtesy: [@shleewhite](https://github.com/shleewhite), [@jorycunningham](https://github.com/jorycunningham))
[axe]: https://github.com/dequelabs/axe-core