Skip to content

v1.6.0 Initial Release

Choose a tag to compare

View all tags
@janmaarten-a11y janmaarten-a11y released this 19 Sep 18:57
· 35 commits to main since this release
v1.6.0
51b6c38
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

The GitHub Annotation Toolkit is an asset library packed with components to help you organize your design canvas, diagram UI anatomy, and annotate accessibility details. Whether you’re a designer, developer, or product manager, this toolkit meets you where you are—you don’t need to be an accessibility expert. It’s flexible enough to document broad accessibility considerations or dig into the fine details of complex components.

Features:

  • Flow lines and canvas utilities: Organize and label your frames and flows. Convey important details for design status, scope, transitions, interactions, validation states, and focus management.
  • User interactions: Keyboard shortcuts and a complete range of basic, specialized, and advanced touch gestures, mouse actions, device settings, and platform functions.
  • Page structure and landmarks: Create a content outline and make semantic heading levels and landmark regions clear.
  • Lists and tables: Group related items to show clear contextual relationships and outline table structure for more complex data presented with rows and columns.
  • Media: Describe informative and decorative images. You can also embed video and audio.
  • Buttons and links: Clearly label controls that perform actions on a page and those that navigate elsewhere.
  • Form elements: Fill out the hidden semantics of all form fields and controls that accept data input from users.
  • Ordering: Outline the focus order to support keyboard navigation (using tab or arrow keys) as well as any reading order that differs from what is shown.
  • Metadata: Document titles and language annotations to support better SEO and localization.
  • System feedback: Highlight important information, potential issues or errors, successful actions, and live region announcements.
  • Interface guidelines: Diagram component anatomy for guidelines and prototypes.
  • Primer A11y Presets: Bespoke annotations for GitHub's design system components which may be instructive for building preset annotations for other design systems.
  • Accessibility checklists: Interactive lists for designers and engineers to track the progress of a design as teams address key WCAG guidelines and ensure best practices are accounted for early.

But that's not all. This library also supports iOS and Android platforms, allowing you to create accessible mobile apps through clear, structured notes for native elements and screen reader announcements.

Documentation and training

Tell us what you think!

We would love your feedback and contributions to help improve the Annotation Toolkit, including any examples of how you’ve used or customized this library. Just open an issue in the GitHub repository.

Get support

This project uses GitHub issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. To get help, submit bugs, ask questions, or make feature requests, create an Issue in this repository. The Annotation Toolkit is under active development and maintained by GitHub staff. We will do our best to respond to support, feature requests, and community questions in a timely manner.

Assets 3
Loading