https://github.com/ryersondmp/sa11y

Sa11y is an accessibility quality assurance tool that visually highlights common accessibility and usability issues. Geared towards content authors, Sa11y straightforwardly identifies errors or warnings at the source with a simple tooltip on how to fix them.
https://github.com/ryersondmp/sa11y

a11y accessibility accessibility-checker accessibility-testing

Last synced: 6 days ago
JSON representation

Sa11y is an accessibility quality assurance tool that visually highlights common accessibility and usability issues. Geared towards content authors, Sa11y straightforwardly identifies errors or warnings at the source with a simple tooltip on how to fix them.

• Host: GitHub
• URL: https://github.com/ryersondmp/sa11y
• Owner: ryersondmp
• License: other
• Created: 2020-03-09T15:17:49.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2026-04-17T01:47:40.000Z (11 days ago)
• Last Synced: 2026-04-17T03:42:38.068Z (11 days ago)
• Topics: a11y, accessibility, accessibility-checker, accessibility-testing
• Language: JavaScript
• Homepage: https://sa11y.netlify.app
• Size: 15.7 MB
• Stars: 324
• Watchers: 6
• Forks: 47
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
![Sa11y, the accessibility quality assurance tool.](https://ryersondmp.github.io/sa11y/github-banner.png)



[![Over several hundred monthly requests on jsDelivr.](https://data.jsdelivr.com/v1/package/gh/ryersondmp/sa11y/badge?style=rounded)](https://www.jsdelivr.com/package/gh/ryersondmp/sa11y) [![License: GPL v2](https://img.shields.io/badge/License-GPL_v2-blue.svg)](https://github.com/ryersondmp/sa11y/blob/master/LICENSE.md) [![npm version](https://badge.fury.io/js/sa11y.svg)](https://www.npmjs.com/package/sa11y)



Sa11y

Meet Sa11y, the accessibility quality assurance assistant. Sa11y is a customizable, framework-agnostic JavaScript plugin. Sa11y works as a simple in-page checker that visually highlights common accessibility and usability issues. Geared towards content authors, Sa11y straightforwardly identifies errors or warnings at the source with a simple tooltip on how to fix them. Sa11y is not a comprehensive code analysis tool; it exclusively highlights content issues.


* [Project website](https://sa11y.netlify.app/) 🌐

* [Developer documentation](https://sa11y.netlify.app/developers/) 📓

* [Demo](https://ryersondmp.github.io/sa11y/demo/en/) 🚀

* [Report an issue](https://github.com/ryersondmp/sa11y/issues) 🐜

* [Install the WordPress plugin](https://wordpress.org/plugins/sa11y/) 💻

* [WordPress plugin development repo](https://github.com/ryersondmp/sa11y-wp) 🛠

* [Acknowledgements](https://sa11y.netlify.app/acknowledgements/) 👤

## Features

- Over 80 checks that encourage quality accessibility.

- **Automatic:** checks content on page load.

- **Customizable:** JSON-like props to fine tune the experience for content authors.

- **Focus on the issues:** Turn off or hide irrelevant checks.

- **Scalable:** Check every page for accessibility.

- Support for checking items within web components/shadow DOM and headless checks.

- Fully encapsulated user interface with dark mode.

- Offered in various [languages.](https://github.com/ryersondmp/sa11y/tree/master/src/js/lang)

## Install

For setup instructions, including local development, installation, or CDN links, please visit the [developer documentation.](https://sa11y.netlify.app/developers/)

## Contributing

Want to help translate or improve Sa11y? Consider [contributing!](https://github.com/ryersondmp/sa11y/blob/master/CONTRIBUTING.md) Translations may either be contributed back to the repository with a pull request, or translated files can be returned to: [adam.chaboryk@torontomu.ca](mailto:adam.chaboryk@torontomu.ca). When submitting a pull request, please ensure you create your translated file within the `/src/js/lang/` directory.

## Contact

Have a question or any feedback? Email: [adam.chaboryk@torontomu.ca](mailto:adam.chaboryk@torontomu.ca)