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: 3 months 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 (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-03-31T10:31:34.000Z (3 months ago)
• Last Synced: 2025-04-02T21:40:55.480Z (3 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, [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.

![Sa11y](https://github.com/salesforce/sa11y/workflows/CI/badge.svg)

[![Code Coverage](https://codecov.io/gh/salesforce/sa11y/branch/master/graph/badge.svg)](https://codecov.io/gh/salesforce/sa11y)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat)](https://github.com/semantic-release/semantic-release)

[![License](https://img.shields.io/npm/l/@sa11y/common)](./LICENSE.txt)

[![NPM downloads per month of @sa11y/common package](https://img.shields.io/npm/dm/@sa11y/common)](https://www.npmtrends.com/@sa11y/common)

[![Known Vulnerabilities](https://snyk.io/test/github/salesforce/sa11y/badge.svg?targetFile=package.json)](https://snyk.io/test/github/salesforce/sa11y?targetFile=package.json)

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/salesforce/sa11y/badge)](https://api.securityscorecards.dev/projects/github.com/salesforce/sa11y)

- [Docs](#docs)

  - [References](#references)

- [Packages](#packages)

  - [Jest integration](#jest-integration)

  - [WDIO integration](#wdio-integration)

  - [assertAccessible API](#assertaccessible-api)

  - [a11y results formatter](#a11y-results-formatter)

  - [Preset accessibility rules](#preset-accessibility-rules)

  - [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](#common)

  - [Dependency graph](#dependency-graph)

  - [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)

[![published npm version of @sa11y/jest](https://img.shields.io/npm/v/@sa11y/jest)](https://www.npmjs.com/package/@sa11y/jest)

![node-current (scoped)](https://img.shields.io/node/v/@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

-   To add accessibility testing to your Jest tests use this package

![Screenshot showing Sa11y Jest API usage and a11y errors showing up in VSCode](https://github.com/salesforce/sa11y/blob/media/screenshot/jest.png?raw=true)

### [WDIO integration](./packages/wdio/README.md)

[![published npm version of @sa11y/wdio](https://img.shields.io/npm/v/@sa11y/wdio)](https://www.npmjs.com/package/@sa11y/wdio)

![node-current (scoped)](https://img.shields.io/node/v/@sa11y/wdio)

-   Provides `assertAccessible()`, `assertAccessibleSync()` APIs that can be used with [WebdriverIO](https://webdriver.io/) to check accessibility of web pages rendered in browsers

![Screenshot showing a11y errors from a test using Sa11y WDIO in a terminal](https://github.com/salesforce/sa11y/blob/media/screenshot/wdio.png?raw=true)

### [assertAccessible API](./packages/assert/README.md)

[![published npm version of @sa11y/assert](https://img.shields.io/npm/v/@sa11y/assert)](https://www.npmjs.com/package/@sa11y/assert)

![node-current (scoped)](https://img.shields.io/node/v/@sa11y/assert)

-   Checks DOM or HTML Element for accessibility issues and throws an error if a11y issues are found

-   To add accessibility testing to your Javascript unit tests _not_ using Jest, use this package

### [a11y results formatter](./packages/format/README.md)

[![published npm version of @sa11y/format](https://img.shields.io/npm/v/@sa11y/format)](https://www.npmjs.com/package/@sa11y/format)

![node-current (scoped)](https://img.shields.io/node/v/@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 a11y matcher

-   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)

[![published npm version of @sa11y/preset-rules](https://img.shields.io/npm/v/@sa11y/preset-rules)](https://www.npmjs.com/package/@sa11y/preset-rules)

![node-current (scoped)](https://img.shields.io/node/v/@sa11y/preset-rules)

-   Provides Base, Extended, Full accessibility preset rules as [axe] configuration

-   The Base preset rule is used by default in the Jest a11y matcher and assert Accessible APIs

    -   The APIs can be overridden to use the Extended or Full ruleset as necessary

### [Minified bundle for testing in browser](./packages/browser-lib/README.md)

[![published npm version of @sa11y/browser-lib](https://img.shields.io/npm/v/@sa11y/browser-lib)](https://www.npmjs.com/package/@sa11y/browser-lib)

![node-current (scoped)](https://img.shields.io/node/v/@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

### Internal packages

#### [Test utilities](./packages/test-utils/README.md)

-   Private package providing test utilities for `@sa11y` packages

#### [Integration Tests](./packages/test-integration/README.md)

-   Private package providing integration tests for `@sa11y` packages

#### [Common](./packages/common/README.md)

-   Common utilities, constants, error messages for `@sa11y` packages

### Dependency graph

![Dependency graph of sa11y packages](docs/sa11y_dependency_graph.svg)

---

### Epilogue

A wise person once said…

_"Don't talk to me until I've had coffee and you've run axe"_

![Embroidery that says "Don't talk to me until I've had coffee and you've run axe" in a hoop](https://github.com/salesforce/sa11y/blob/media/axe_embroidery.jpeg?raw=true)

(Image courtesy: [@shleewhite](https://github.com/shleewhite), [@jorycunningham](https://github.com/jorycunningham))

[axe]: https://github.com/dequelabs/axe-core