Skip to content

feat: add optional ariaLabel prop #532

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

Merged
pradel merged 3 commits into from
Oct 1, 2025
Merged

feat: add optional ariaLabel prop #532

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4ad33d2
feat: add ariaLabel prop
parsasaeedi Sep 19, 2025
23946b4
update docs
parsasaeedi Sep 19, 2025
6dfbe59
Update docs
parsasaeedi Sep 19, 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
14 changes: 14 additions & 0 deletions react-responsive-modal/__tests__/index.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -533,4 +533,18 @@ describe('modal', () => {
expect(document.getElementById(modalId)).toBeInTheDocument();
});
});

describe('prop: ariaLabel', () => {
it('should render modal with aria-label attribute', async () => {
const ariaLabel = 'Custom modal label';
const { getByTestId } = render(
<Modal open onClose={() => null} ariaLabel={ariaLabel}>
<div>modal content</div>
</Modal>,
);

const modal = getByTestId('modal');
expect(modal.getAttribute('aria-label')).toBe(ariaLabel);
});
});
});
6 changes: 6 additions & 0 deletions react-responsive-modal/src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,10 @@ export interface ModalProps {
* Default to 'dialog'.
*/
role?: string;
/**
* ARIA label for modal
*/
ariaLabel?: string;
/**
* ARIA label for modal
*/
Expand Down Expand Up @@ -179,6 +183,7 @@ export const Modal = React.forwardRef(
classNames,
styles,
role = 'dialog',
ariaLabel,
ariaDescribedby,
ariaLabelledby,
containerId,
Expand Down Expand Up @@ -351,6 +356,7 @@ export const Modal = React.forwardRef(
id={modalId}
role={role}
aria-modal="true"
aria-label={ariaLabel}
aria-labelledby={ariaLabelledby}
aria-describedby={ariaDescribedby}
data-testid="modal"
Expand Down
22 changes: 18 additions & 4 deletions website/src/docs/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,18 +155,31 @@ By default, the Modal will be rendered at the end of the html body tag. If you w

## Accessibility

- Use the `aria-labelledby` and `aria-describedby` props to follow the [ARIA best practices](https://www.w3.org/TR/wai-aria-practices/#dialog_modal).
- Follow the [ARIA best practices](https://www.w3.org/TR/wai-aria-practices/#dialog_modal) by using either:
- `ariaLabelledby` and `ariaDescribedby` props to reference visible content, OR
- `ariaLabel` prop for a simple accessible label

```javascript
// Option 1: Using ariaLabelledby and ariaDescribedby
<Modal
open={open}
onClose={onCloseModal}
aria-labelledby="my-modal-title"
aria-describedby="my-modal-description"
ariaLabelledby="my-modal-title"
ariaDescribedby="my-modal-description"
>
<h2 id="my-modal-title">My Title</h2>
<p id="my-modal-description">My Description</p>
</Modal>

// Option 2: Using ariaLabel
<Modal
open={open}
onClose={onCloseModal}
ariaLabel="Modal Title"
>
<h2>Preferences</h2>
<p>Update your settings below</p>
</Modal>
```

- `aria-modal` is set to true automatically.
Expand Down Expand Up @@ -197,7 +210,8 @@ By default, the Modal will be rendered at the end of the html body tag. If you w
| **animationDuration** | `number` | 300 | Animation duration in milliseconds. |
| **role** | `string` | "dialog" | ARIA role for modal |
| **ref** | `React.RefElement<HTMLDivElement>` | undefined | Ref for modal dialog element |
| **ariaLabelledby** | `string` | | ARIA label for modal |
| **ariaLabel** | `string` | | ARIA label for modal |
| **ariaLabelledby** | `string` | | ARIA labelledby for modal |
| **ariaDescribedby** | `string` | | ARIA description for modal |
| **containerId** | `string` | | id attribute for modal container |
| **modalId** | `string` | | id attribute for modal | |
Expand Down