docs: Migrating accessibility guidelines for Expandable & Menu #3600
+169
−63
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 7 commits
October 15, 2025 16:58
Note I removed the Selectable Menu example because it wasn't a keyboard accessible example.
Workday/canvas-kit
|
||||||||||||||||||||||||||||||||||||||||
| Project |
Workday/canvas-kit
|
| Branch Review |
william-docs-expandable-and-menu
|
| Run status |
|
| Run duration | 02m 33s |
| Commit |
|
| Committer | William Stanton |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
1
|
Pending
|
86
|
Skipped
|
0
|
Passing
|
843
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
19.34%
|
|
|---|---|
|
Untested elements
|
1533
|
|
Tested elements
|
365
|
Accessibility
99.31%
|
|
|---|---|
|
Failed rules
|
6 critical
5 serious
0 moderate
2 minor
|
|
Failed elements
|
77
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates accessibility documentation for the Expandable and Menu components from the design site into the Canvas repository, making accessibility a "first class citizen" in Canvas docs. The changes include comprehensive accessibility guidelines, keyboard navigation details, and screen reader experiences.
- Added detailed accessibility sections with WAI-ARIA pattern references for both components
- Updated Avatar examples to use the
isDecorativeprop for proper screen reader behavior - Enhanced HoistedModel example with semantic HTML and ARIA labeling best practices
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| modules/react/menu/stories/Menu.mdx | Added comprehensive accessibility section with navigation, screen reader experience, and contextual accessibility notes throughout examples |
| modules/react/menu/stories/examples/SelectableMenu.tsx | Moved role attribute from Menu.Card to Menu.List and added detailed JSDoc about accessibility limitations |
| modules/react/expandable/stories/Expandable.mdx | Added accessibility section with navigation, screen reader experience, and contextual notes for Avatar decoration and semantic sections |
| modules/react/expandable/stories/examples/Avatar.tsx | Added isDecorative prop to Avatar instances |
| modules/react/expandable/stories/examples/RTL.tsx | Added isDecorative prop to Avatar instances |
| modules/react/expandable/stories/examples/LongTitle.tsx | Added isDecorative prop to Avatar instance |
| modules/react/expandable/stories/examples/HoistedModel.tsx | Enhanced with semantic sections, ARIA labeling, and improved styling approach |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <Expandable> | ||
| <Expandable.Target headingLevel="h4"> | ||
| <Expandable.Avatar name="Avatar" url={testAvatar} /> | ||
| <Expandable.Avatar name="Avatar" isDecorative url={testAvatar} /> |
Contributor
There was a problem hiding this comment.
Do we want to always define isDecorative on the expandable.avatar?
Collaborator
Author
There was a problem hiding this comment.
OK! I did it!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
As part of making accessibility a "first class citizen" in Canvas docs, we will be pulling any technical information for developers off of the design site, and into the Canvas repository.
Expandable and Menu are the next set of components.
Release Category
Documentation
Checklist
ready for reviewhas been added to PRFor the Reviewer
Where Should the Reviewer Start?
modules/react/expandable/stories/Expandable.mdxmodules/react/menu/stories/Menu.mdxI also updated the examples using the new Avatar component and the
isDecorativeprop.Areas for Feedback? (optional)
Testing Manually
Screenshots or GIFs (if applicable)
Thank You Gif (optional)