Skip to content

MicroFish91/a11y-kit

Repository files navigation

Accessibility Testkit (a11y-kit)

Accessibility Testkit (a11y-kit) is a menu-driven extension that allows users to quickly demo a small subset of VS Code's common UI features with different base configuration sets. a11y-kit's fast feature demo'ing enables the user to quickly check UI configurations for screen reader compliance.

Getting Started

Option 1: Search for and install a11y-kit from VS Code's extension marketplace.

Option 2: Clone the repo, run npm install, hit F5.

Open the command pallette and type in a11y. The menu command should pop up under a11y-kit: ...

Use the a11y-kit menu

Choose a11y-kit: Select UI feature for accessibility testing. Finally, choose the menu item you wish to demo.

Menu Components

Menu components are listed in the components/ directory. Any additions, changes, or enhancements to the components should be made there.

Integrate new components into the menu by calling the addComponent Menu method.

Web Support

a11y-kit also has full support as a web extension. Try it out here.

Screen Readers for Testing

  1. JAWS: Download here.
  2. NVDA: Download here. Shortcut: control + alt + n
  3. Apple Voiceover (Mac OS): Open spotlight search and look for Apple Voiceover, or press Command-F5 to enable. For more information on Apple Voiceover, click here.

Attribution

Icon created by Freepik at Flaticon