Skip to content
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

feat(a11y): remove incorrect expanded attribute on OptionsMenu #1792

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

feat(a11y): remove incorrect expanded attribute on OptionsMenu #1792

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
df88cf2
fix(a11y): remove incorrect expanded attribute on OptionsMenu
scurker Jan 28, 2025
048b247
tests
scurker Jan 28, 2025
e410a5a
fix class
scurker Feb 5, 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: 7 additions & 7 deletions packages/react/src/components/OptionsMenu/OptionsMenu.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,12 +117,10 @@ test('should toggle menu on trigger clicks', async () => {

await user.click(button);
expect(button).toHaveAttribute('aria-expanded', 'true');
expect(screen.getByRole('menu')).toHaveAttribute('aria-expanded', 'true');

await user.click(button);

expect(screen.getByRole('menu')).toHaveClass('OptionsMenu--expanded');
expect(button).toHaveAttribute('aria-expanded', 'false');
expect(screen.getByRole('menu')).toHaveAttribute('aria-expanded', 'false');
expect(screen.getByRole('menu')).not.toHaveClass('OptionsMenu--expanded');
});

test('should click trigger with down key on trigger', () => {
Expand Down Expand Up @@ -188,10 +186,12 @@ test('should close menu when click outside event occurs', async () => {
</>
);

await user.click(screen.getByRole('button', { name: 'trigger' }));
expect(screen.getByRole('menu')).toHaveAttribute('aria-expanded', 'true');
const triggerButton = screen.getByRole('button', { name: 'trigger' });
await user.click(triggerButton);
expect(triggerButton).toHaveAttribute('aria-expanded', 'true');
await user.click(screen.getByRole('button', { name: 'Click me!' }));
expect(screen.getByRole('menu')).toHaveAttribute('aria-expanded', 'false');
expect(triggerButton).toHaveAttribute('aria-expanded', 'false');
expect(screen.getByRole('menu')).not.toHaveClass('OptionsMenu--expanded');
});

test('should return no axe violations when hidden', async () => {
Expand Down
7 changes: 3 additions & 4 deletions packages/react/src/components/OptionsMenu/OptionsMenuList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,10 +142,9 @@ const OptionsMenuList = ({
>
<ul
{...other}
className={classnames('OptionsMenu__list', className)}
/* aria-expanded is not correct usage here, but the pattern library
currently styles the open state of the menu based on this attribute */
aria-expanded={show}
className={classnames('OptionsMenu__list', className, {
'OptionsMenu--expanded': show
})}
role="menu"
onClick={handleClick}
ref={(el) => {
Expand Down
2 changes: 1 addition & 1 deletion packages/styles/options-menu.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
box-shadow: 0 2px 3px 0 rgba(0, 0, 0, 0.15);
}

.OptionsMenu__list[aria-expanded='true'] {
.OptionsMenu__list:is(.OptionsMenu--expanded) {
display: block;
}

Expand Down
Loading