Skip to content

Allow aria-description to describe Dialog and AlertDialog #3658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+18 −2
Open

Allow aria-description to describe Dialog and AlertDialog #3658

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
945983c
Allow aria-description to describe Dialog and AlertDialog
jannikbertram Aug 21, 2025
b98b854
Add changeset
jannikbertram Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/new-otters-bet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@radix-ui/react-alert-dialog': patch
'@radix-ui/react-dialog': patch
---

Allow aria-description attribute to describe the dialog>wq
7 changes: 6 additions & 1 deletion packages/react/alert-dialog/src/alert-dialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,11 +248,16 @@ const DescriptionWarning: React.FC<DescriptionWarningProps> = ({ contentRef }) =

You can add a description to the \`${CONTENT_NAME}\` by passing a \`${DESCRIPTION_NAME}\` component as a child, which also benefits sighted users by adding visible context to the dialog.

Alternatively, you can use your own component as a description by assigning it an \`id\` and passing the same value to the \`aria-describedby\` prop in \`${CONTENT_NAME}\`. If the description is confusing or duplicative for sighted users, you can use the \`@radix-ui/react-visually-hidden\` primitive as a wrapper around your description component.
Alternatively, you can either use the \`aria-description\` attribute or your own component as a description by assigning it an \`id\` and passing the same value to the \`aria-describedby\` prop in \`${CONTENT_NAME}\`. If the description is confusing or duplicative for sighted users, you can use the \`@radix-ui/react-visually-hidden\` primitive as a wrapper around your description component.

For more information, see https://radix-ui.com/primitives/docs/components/alert-dialog`;

React.useEffect(() => {
if (contentRef.current?.getAttribute('aria-description')) {
// the alert dialog is described by the aria-description attribute
return;
}

const hasDescription = document.getElementById(
contentRef.current?.getAttribute('aria-describedby')!
);
Expand Down
7 changes: 6 additions & 1 deletion packages/react/dialog/src/dialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -533,9 +533,14 @@ type DescriptionWarningProps = {

const DescriptionWarning: React.FC<DescriptionWarningProps> = ({ contentRef, descriptionId }) => {
const descriptionWarningContext = useWarningContext(DESCRIPTION_WARNING_NAME);
const MESSAGE = `Warning: Missing \`Description\` or \`aria-describedby={undefined}\` for {${descriptionWarningContext.contentName}}.`;
const MESSAGE = `Warning: Missing \`Description\` or \`aria-description\` or \`aria-describedby={undefined}\` for {${descriptionWarningContext.contentName}}.`;

React.useEffect(() => {
if (contentRef.current?.getAttribute('aria-description')) {
// the dialog is described by the aria-description attribute
return;
}

const describedById = contentRef.current?.getAttribute('aria-describedby');
// if we have an id and the user hasn't set aria-describedby={undefined}
if (descriptionId && describedById) {
Expand Down