-
Notifications
You must be signed in to change notification settings - Fork 638
fix(core): expose aria-expanded and aria-controls on MobileNav toggle #3721
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.
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
bhamodi
wants to merge
1
commit into
facebook:main
Choose a base branch
from
bhamodi:a11y/mobilenav-toggle-expanded
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| '@astryxdesign/core': patch | ||
| --- | ||
|
|
||
| [fix] MobileNav: the toggle button now exposes `aria-expanded` and references the nav drawer via `aria-controls`, so screen-reader users can tell whether the drawer is open and what the button controls. (#3721) | ||
| @bhamodi |
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| // Copyright (c) Meta Platforms, Inc. and affiliates. | ||
|
|
||
| /** | ||
| * @file MobileNavToggle.test.tsx | ||
| * @input Uses vitest, @testing-library/react, AppShell + SideNav | ||
| * @output Unit tests for MobileNavToggle ARIA wiring | ||
| * @position Testing; validates MobileNavToggle.tsx exposes aria-expanded and | ||
| * aria-controls so screen-reader users know the drawer state and target. | ||
| * | ||
| * SYNC: When MobileNavToggle.tsx changes, update tests to match new behavior | ||
| */ | ||
|
|
||
| import { | ||
| describe, | ||
| it, | ||
| expect, | ||
| vi, | ||
| beforeAll, | ||
| beforeEach, | ||
| afterEach, | ||
| } from 'vitest'; | ||
| import {render, screen, fireEvent} from '@testing-library/react'; | ||
| import {AppShell} from '../AppShell/AppShell'; | ||
| import {SideNav, SideNavItem, SideNavSection} from '../SideNav'; | ||
|
|
||
| // jsdom doesn't implement showModal/close on <dialog>, so we mock them | ||
| beforeAll(() => { | ||
| HTMLDialogElement.prototype.showModal = | ||
| HTMLDialogElement.prototype.showModal || | ||
| function (this: HTMLDialogElement) { | ||
| this.setAttribute('open', ''); | ||
| }; | ||
| HTMLDialogElement.prototype.close = | ||
| HTMLDialogElement.prototype.close || | ||
| function (this: HTMLDialogElement) { | ||
| this.removeAttribute('open'); | ||
| }; | ||
| }); | ||
|
|
||
| class MockResizeObserver { | ||
| observe() {} | ||
| unobserve() {} | ||
| disconnect() {} | ||
| } | ||
| vi.stubGlobal('ResizeObserver', MockResizeObserver); | ||
|
|
||
| function createMockMatchMedia(matches: boolean) { | ||
| return { | ||
| matches, | ||
| media: '', | ||
| onchange: null, | ||
| addEventListener: vi.fn(), | ||
| removeEventListener: vi.fn(), | ||
| addListener: vi.fn(), | ||
| removeListener: vi.fn(), | ||
| dispatchEvent: vi.fn(), | ||
| }; | ||
| } | ||
|
|
||
| beforeEach(() => { | ||
| // Below the breakpoint so the mobile nav (and its toggle) render. | ||
| vi.stubGlobal( | ||
| 'matchMedia', | ||
| vi.fn().mockReturnValue(createMockMatchMedia(true)), | ||
| ); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| vi.restoreAllMocks(); | ||
| }); | ||
|
|
||
| function TestShell() { | ||
| return ( | ||
| <AppShell | ||
| sideNav={ | ||
| <SideNav> | ||
| <SideNavSection title="Test" isHeaderHidden> | ||
| <SideNavItem label="Home" /> | ||
| </SideNavSection> | ||
| </SideNav> | ||
| } | ||
| mobileNav={{breakpoint: 'md'}}> | ||
| <div>Content</div> | ||
| </AppShell> | ||
| ); | ||
| } | ||
|
|
||
| describe('MobileNavToggle ARIA wiring', () => { | ||
| it('exposes aria-expanded="false" when the drawer is closed', () => { | ||
| render(<TestShell />); | ||
|
|
||
| const toggle = screen.getByRole('button', {name: /open navigation/i}); | ||
| expect(toggle).toHaveAttribute('aria-expanded', 'false'); | ||
| }); | ||
|
|
||
| it('exposes aria-expanded="true" after opening the drawer', () => { | ||
| render(<TestShell />); | ||
|
|
||
| const toggle = screen.getByRole('button', {name: /open navigation/i}); | ||
| fireEvent.click(toggle); | ||
| expect(toggle).toHaveAttribute('aria-expanded', 'true'); | ||
| }); | ||
|
|
||
| it('references the nav drawer via aria-controls that resolves to the dialog', () => { | ||
| render(<TestShell />); | ||
|
|
||
| const toggle = screen.getByRole('button', {name: /open navigation/i}); | ||
| const controls = toggle.getAttribute('aria-controls'); | ||
| expect(controls).toBeTruthy(); | ||
|
|
||
| const target = document.getElementById(controls!); | ||
| expect(target).not.toBeNull(); | ||
| expect(target).toBe(screen.getAllByRole('dialog', {hidden: true})[0]); | ||
| expect(target?.tagName).toBe('DIALOG'); | ||
| }); | ||
| }); |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since we're adding a new required property this can result in breaking surfaces currently interacting with this context. One way to tell is how we needed to update the tests and example Calais despite them not needing to apply the Aria controls. Curious if you think this is worth the breaking change? Otherwise we could make this optional and remember to apply the ID internally. The accessibility aspect is not fully realized until the toggle for the mobile nav is also consuming this ID.