https://github.com/ygev/sketch-accessibility-assistant
Accessibility assistant for all your basic needs. Serves as a linter for compliant color contrast and type based on WCAG 2.1. Thanks to Ale Muñoz for his support and docs!
https://github.com/ygev/sketch-accessibility-assistant
a11y a11y-testing accessibility accessibility-assistant accessibility-testing color-contrast color-contrast-checker font-size sketch sketch-app sketch-assistant sketch-assistants sketch-files
Last synced: 24 days ago
JSON representation
Accessibility assistant for all your basic needs. Serves as a linter for compliant color contrast and type based on WCAG 2.1. Thanks to Ale Muñoz for his support and docs!
- Host: GitHub
- URL: https://github.com/ygev/sketch-accessibility-assistant
- Owner: ygev
- License: mit
- Created: 2020-07-29T23:53:24.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-01-06T12:48:44.000Z (over 2 years ago)
- Last Synced: 2025-03-23T18:50:01.941Z (about 1 month ago)
- Topics: a11y, a11y-testing, accessibility, accessibility-assistant, accessibility-testing, color-contrast, color-contrast-checker, font-size, sketch, sketch-app, sketch-assistant, sketch-assistants, sketch-files
- Language: TypeScript
- Homepage:
- Size: 893 KB
- Stars: 26
- Watchers: 2
- Forks: 3
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Sketch Accessibility Assistant
The Accessibility Assistant ensures that your Sketch elements pass AA+ compliance based on the Web Content Accessibility Guidelines. This is a contribution to the Assistants feature launch for Sketch 68. Unlike an accessibility plugin, an assistant automatically detects accessibility infractions and sends out a notification. If you'd like to learn more about Sketch Assistants and how they differ from Sketch plugins, please [read the documentation on Sketch's website.](https://www.sketch.com/docs/assistants/)
## Rules
- [Shapes must meet AA color contrast compliance.](https://github.com/ygev/sketch-accessibility-assistant/tree/main/src/rules/aa-contrast-shape)
- [Text must meet AA color contrast compliance.](https://github.com/ygev/sketch-accessibility-assistant/tree/main/src/rules/aa-contrast-text)
- [Text must meet AAA color contrast compliance.](https://github.com/ygev/sketch-accessibility-assistant/tree/main/src/rules/aaa-contrast-text)
- [Text must not be justified.](https://github.com/ygev/sketch-accessibility-assistant/tree/main/src/rules/text-not-justified)
## Installation
👉 Click [here](https://add-sketch-assistant.now.sh/api/main?pkg=sketch-accessibility-assistant)
to add to your Sketch document.
> Or, add using a Sketch release variant:
> [Beta](https://add-sketch-assistant.now.sh/api/main?variant=beta&pkg=sketch-accessibility-assistant)
## Known Bugs
- Layers outside the artboard are not detected yet.
- Very sensitive detection of overlap between layer coordinates. Planning to change it to 80%+ overlap, rather than 1%+ to avoid false negatives.