Skip to content

Commit 9377680

Browse files
docs: Document Storybook a11y addon usage (#1116)
The Storybook Accessibility Addon was already installed and configured in the project. This change adds the missing documentation to `STORYBOOK.md` explaining how to use the addon to identify accessibility issues. A pre-existing issue causes the `build-storybook` command to fail, but this is unrelated to the a11y addon configuration. Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
1 parent 12e9e50 commit 9377680

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

STORYBOOK.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,21 @@ npm run storybook
2828
npm run build-storybook
2929
```
3030

31+
## Accessibility Testing
32+
33+
This project uses the Storybook Accessibility Addon (`@storybook/addon-a11y`) to help identify and fix accessibility issues in components during development.
34+
35+
### How to Use the Addon
36+
37+
1. **Open a Story**: Navigate to any component story in the Storybook UI.
38+
2. **Select the Accessibility Tab**: In the addons panel at the bottom of the screen, click on the "Accessibility" tab.
39+
3. **Review the Results**: The panel will display a list of automated accessibility checks. It highlights:
40+
* **Violations**: Issues that fail accessibility standards (e.g., WCAG). These should be fixed.
41+
* **Passes**: Rules that the component correctly adheres to.
42+
* **Incomplete**: Rules that could not be automatically checked and may require manual verification.
43+
44+
By using this tool, you can catch common problems like incorrect color contrast, missing ARIA attributes, and improper element structures, ensuring our components are usable by as many people as possible.
45+
3146
## Benefits
3247

3348
- **Isolated Development**: Test components without full app context

0 commit comments

Comments
 (0)