Add AriaDescription for ContextMenu items #15973
Merged
Conversation
This file contains 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
msft-github-bot
added
the
needs cherry-pick
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 2d8f165:
|
Perf AnalysisNo significant results to display. All results
|
Asset size changes
Baseline commit: d4f609575c9abc89ee66d9fb816be5557adc4093 (build) |
SavannahBourgeois
changed the title
ThomasMichon
requested changes
Nov 20, 2020
packages/office-ui-fabric-react/src/components/ContextualMenu/ContextualMenu.types.ts
Show resolved
Hide resolved
|
@ThomasMichon or @joschect can one of you take a look please? I would love to be able to get this in soon. |
joschect
previously approved these changes
Dec 4, 2020
ThomasMichon
approved these changes
Dec 10, 2020
joschect
approved these changes
Dec 10, 2020
|
Hello @joschect! Because this pull request has the p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (
|
|
🎉 Handy links: |
|
🎉 Handy links: |
ecraig12345
removed
the
needs cherry-pick
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Pull request checklist
$ yarn changeDescription of changes
There are a few props that can be set on items to help give screen reader users more context. One of those is aria-DescribedBy which is a string of IDs that point to elements describing the item. The other is aria-Description which is often set as the description of the element or is placed into a hidden span and the ID of that span is added to the list of IDs in aria-DescribedBy. This second approach is better because it will merge the aria-DescribedBy IDs and concat them to be the aria-Description set on the element so you do not overwrite other aria-DescribedBy elements.
With this change, I add ariaDescribedBy and ariaDescription as options on IContextualMenuItem. If the user passes ariaDescription, we will generate a hidden span with the contents of that prop and set the ID of that span to the list of aria-DescribedBy.
I have added an example of different context menu types with ariaDescriptions and verified they are read out by the screen reader when "Hear advanced detail" is selected.
Focus areas to test
Contextual menus, keytips on contextual menus, screen reader
I already checked in this change for Master, this is adding it to V7 (#15770)