About AtomicA11y
AtomicA11y is a tool built to simplify the process of accessibility testing. It is a generalized fork of Charlie Triplett’s original work at MagentaA11y, which is T-Mobile focused.
We wanted to build an intuitive way for product teams to define “done” in a way that ensures accessible experiences work for everyone.
It uses Jekyll with a custom theme as a CMS and relies on markdown for entry creation.
Disclaimer
- This is not a comprehensive list of all of the WCAG success criteria or techniques required to become WCAG compliant and should not be used as such.
- Adherence to this list also does not guarantee that a digital asset will be free from accessibility issues or complaints.
Using AtomicA11y
Product owners, designers, developers or testers can use the checklist builder to collect testing instructions for web or native app components.
These testing criteria are displayed in markdown format for easy copying/pasting into project management tools like Jira.
Testing instructions includes:
- How to test with keyboard
- How to test with screen reader
- How to test with a screen reader on a mobile device
- Link to the full entry
Many entries contain:
- Video demos with recommended screen reader browser pairings
- Code examples
- Developer notes
- Links to official WCAG and WAI-ARIA documentation
Contribute
AtomicA11y is maintained by Charlie Triplett, continuing his work on MagentaA11y, which was originally built and maintained by the T-Mobile Accessibility Resource Center.
It was originally created by Charlie Triplett, author of The Book on Accessibility.
Here are some ways to contribute:
- Add a concise demo video using a screen reader that’s not yet covered.
- Add an entry for a component that is not included.
- Fix a typo or edit for consistent language.
JSON Integration
You can integrate AtomicA11y acceptance criteria into your own tools using these JSON feeds:
Local installation instructions
A11yEngineer is fork of MagentaA11y, a Jekyll based site hosted by Github Pages. Follow Github’s instructions for installing locally.
- Clone the open source repo from T-Mobile
- Testing your GitHub Pages site locally with Jekyll
- Helpful links for installing Jekyll with Ruby 3.0
- Install Ruby 3.0 · macOS Big Sur or Catalina for Intel or Apple Silicon
- Install Ruby 3.0 · macOS Big Sur or Catalina with Homebrew for Intel or Apple Silicon
- Note: Ruby 3.0 will require WEBrick
- Add
gem "webrick"
to Gemfile
- Add
License
The original MagentaA11y is open sourced by T-Mobile and released under the Apache 2.0 License which allows you to use, modify, and distribute the licensed software, including creating derivative works, without requiring those derivative works to be licensed under the same terms. You can release the modified parts of the code under any license you prefer.