Add aria-modal attribute to Dialog (V2) element
#2851
Merged
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
🦋 Changeset detectedLatest commit: d8745e0 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
iansan5653
commented
Feb 1, 2023
| @@ -302,6 +302,7 @@ const _Dialog = React.forwardRef<HTMLDivElement, React.PropsWithChildren<DialogP | |||
| role={role} | |||
| aria-labelledby={dialogLabelId} | |||
| aria-describedby={dialogDescriptionId} | |||
| aria-modal | |||
There was a problem hiding this comment.
I considered adding a prop to allow users to override this, but since we don't allow them to override the focus zone or exit behavior, there is no valid scenario in which this dialog is not modal. And the role prop is restricted to dialog or alertdialog so there is no potential for conflict there.
size-limit report 📦
|
iansan5653
temporarily deployed
to
github-pages
GitHub Actions
Inactive
colebemis
approved these changes
Feb 7, 2023
joshblack
approved these changes
Feb 7, 2023
Merged
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.
Adds the
aria-modalattribute to the container for theDialogV2element. This is required because the dialog always instantiates a focus trap. The only way to interact with the underlying page is to close the dialog:Adding
aria-modalprevents screen readers from continuing past the dialog and starting to read the underlying content, which they will do without the attribute.Closes #2814