Skip to content

Commit

Permalink
Add additional accessibility documentation for Dialog and live regi…
Browse files Browse the repository at this point in the history
…on usage (#702)

* Add a11y note on live region usage and dialogs

* Wording change

* More wording changes
  • Loading branch information
TylerJDev authored Jan 3, 2024
1 parent ad3e690 commit a953ee1
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions content/components/dialog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,12 @@ When a dialog is opened, the first interactive element (typically the close butt
/>
<Caption>When a dialog is closed, focus is returned to the trigger button.</Caption>

### Live region usage
Use extra caution when utilizing a live region that exists outside of the `<Dialog>` component.
This is because some browser and screen reader combinations may ignore the live region entirely if it does not already exist within the dialog.

If you need to use a live region while a dialog is active, place the live region within the dialog, rather than outside of it.

### Known accessibility issues (GitHub staff only)

<AccessibilityLink label="Dialog"/>

0 comments on commit a953ee1

Please sign in to comment.