Skip to content

Hamburger menu accessibility #93

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
sakari-malkki merged 11 commits into from
Apr 2, 2025
Merged

Hamburger menu accessibility #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
67b1c8a
Arrow key navigation using roving tabIndex
sakari-malkki Mar 27, 2025
705f03a
Aria labels
sakari-malkki Mar 27, 2025
d8ebc5c
Aria labels and roles to fix nvda functionality
sakari-malkki Mar 31, 2025
cf63b69
Update test snapshots
sakari-malkki Mar 31, 2025
60d40b9
Updated tests
sakari-malkki Mar 31, 2025
4ceede9
Sonar fixes
sakari-malkki Mar 31, 2025
720f214
Test for roving tabIndex functionality
sakari-malkki Mar 31, 2025
03d3686
Refactor creation of menu items for more consistent indeces and lengt…
sakari-malkki Mar 31, 2025
aa4486f
Remove unused import
sakari-malkki Mar 31, 2025
153b33d
Use React.useId to generate unique id's for burger menu components
sakari-malkki Apr 1, 2025
d3040a7
Assigns menu id prefix to aria controls attribute
sakari-malkki Apr 2, 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
2 changes: 2 additions & 0 deletions src/react/components/burgerMenu/__snapshots__/burgerMenu.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ exports[`burgerMenu, rendering tests Should render 1`] = `
class="c0"
>
<button
aria-controls=":r0:-menu"
aria-expanded="false"
aria-haspopup="menu"
aria-label="Kuvion valikko"
class="c1"
>
Expand Down
113 changes: 94 additions & 19 deletions src/react/components/burgerMenu/burgerMenu.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ const mockTableToggle = {
}

describe('burgerMenu, functional tests', () => {
it('Should open the menu with correct menu elements', async () => {
it('Should open the menu with correct elements', async () => {
const view = convertPxGrafResponseToView(HORIZONTAL_BAR_CHART_ASCENDING, {});
render(<BurgerMenu locale="fi" viewData={view} tableToggle={mockTableToggle} accessibilityMode={false} toggleAccessibilityMode={jest.fn()} />);
act(() => {
screen.getByRole('button').click();
});
await waitFor(() => {
expect(screen.getAllByRole('button').length).toEqual(5);
expect(screen.getAllByRole('menuitem').length).toEqual(4);
expect(screen.getByText('Lataa taulukko (csv)')).toBeTruthy();
expect(screen.getByText('Lataa taulukko (xlsx)')).toBeTruthy();
expect(screen.getByText("N\u00E4yt\u00E4 taulukko")).toBeTruthy();
Expand All @@ -51,16 +51,14 @@ describe('burgerMenu, functional tests', () => {
screen.getByRole('button').click();
});
await waitFor(() => {
expect(screen.getAllByRole('button').length).toEqual(7);
expect(screen.getAllByRole('link').length).toEqual(2);
expect(screen.getAllByRole('menuitem').length).toEqual(8);
expect(screen.getByText('Lataa taulukko (csv)')).toBeTruthy();
expect(screen.getByText('Lataa taulukko (xlsx)')).toBeTruthy();
expect(screen.getByText('Foo')).toBeTruthy();
expect(screen.getByText('Bar')).toBeTruthy();
expect(screen.getByText('Baz')).toBeTruthy();
expect(screen.getByText('Ulkoinen linkki')).toBeTruthy();
expect(screen.getByText('Baz2')).toBeTruthy();
expect(screen.getAllByRole('link').length).toBe(2);
expect(screen.getByText("N\u00E4yt\u00E4 taulukko")).toBeTruthy();
expect(screen.getByText("N\u00E4yt\u00E4 kuviossa symbolit")).toBeTruthy();
});
Expand Down Expand Up @@ -102,12 +100,10 @@ describe('burgerMenu, functional tests', () => {
});
await waitFor(() => {
screen.getByText(btnText).click();
expect(mockFunction).toBeCalledTimes(1);
});
await waitFor(() => {
expect(screen.queryByText(btnText)).toBeNull();
expect(screen.queryByLabelText('Kuvion valikko')).not.toBeNull();
});
expect(mockFunction).toBeCalledTimes(1);
expect(screen.queryByText(btnText)).toBeNull();
expect(screen.queryByRole('menu')).toBeNull();
});

it('Should invoke the custom function and close the menu when link is clicked', async () => {
Expand All @@ -120,12 +116,10 @@ describe('burgerMenu, functional tests', () => {
});
await waitFor(() => {
screen.getByText(btnText).click();
expect(mockFunction).toBeCalledTimes(1);
});
await waitFor(() => {
expect(screen.queryByText(btnText)).toBeNull();
expect(screen.queryByLabelText('Kuvion valikko')).not.toBeNull();
});
expect(mockFunction).toBeCalledTimes(1);
expect(screen.queryByText(btnText)).toBeNull();
expect(screen.queryByRole('menu')).toBeNull();
});

it('Should close the menu when ESC is pressed', async () => {
Expand All @@ -134,12 +128,22 @@ describe('burgerMenu, functional tests', () => {
act(() => {
screen.getByRole('button').click();
});
await waitFor(() => {
window.dispatchEvent(new KeyboardEvent('keydown', { key: 'Escape' }));
act(() => {
fireEvent.keyDown(screen.getByRole('button'), { key: 'Escape' });
});
await waitFor(() => {
expect(screen.queryByLabelText('Kuvion valikko')).not.toBeNull();
expect(screen.queryByRole('menu')).toBeNull();
});

it('Should close the menu when TAB is pressed', async () => {
const view = convertPxGrafResponseToView(HORIZONTAL_BAR_CHART_ASCENDING, {});
render(<BurgerMenu locale="fi" viewData={view} />);
act(() => {
screen.getByRole('button').click();
});
act(() => {
fireEvent.keyDown(screen.getByRole('button'), { key: 'Tab' });
});
expect(screen.queryByRole('menu')).toBeNull();
});

it('Should calculate correct export dimensions when aspect ratio is too low', () => {
Expand Down Expand Up @@ -261,4 +265,75 @@ describe('burgerMenu, functional tests', () => {
scale: 1
}, {});
});

it('should change focus and tabIndex when up and down arrows are pressed with the menu open', async () => {
const view = convertPxGrafResponseToView(HORIZONTAL_BAR_CHART_ASCENDING, {});
render(<BurgerMenu locale="fi" viewData={view} menuItemDefinitions={[{ text: 'Item1', onClick: jest.fn() }, { text: 'Item2', onClick: jest.fn() }]} />);
act(() => {
screen.getByRole('button').click();
});
await waitFor(() => {
expect(screen.getByText('Item1').closest('button')?.getAttribute('tabIndex')).toBe('0');
expect(screen.getByText('Item2').closest('button')?.getAttribute('tabIndex')).toBe('-1');
});
act(() => {
fireEvent.keyDown(screen.getByRole('button'), { key: 'ArrowDown' }); // window?
});
await waitFor(() => {
expect(screen.getByText('Item1').closest('button')?.getAttribute('tabIndex')).toBe('-1');
expect(screen.getByText('Item2').closest('button')?.getAttribute('tabIndex')).toBe('0');
});
act(() => {
fireEvent.keyDown(screen.getByRole('button'), { key: 'ArrowUp' }); // window?
});
await waitFor(() => {
expect(screen.getByText('Item1').closest('button')?.getAttribute('tabIndex')).toBe('0');
expect(screen.getByText('Item2').closest('button')?.getAttribute('tabIndex')).toBe('-1');
});
});

it('should cycle the focus of menu items back to start if down arrow is pressed on the last item', async () => {
const view = convertPxGrafResponseToView(HORIZONTAL_BAR_CHART_ASCENDING, {});
render(<BurgerMenu locale="fi" viewData={view}/>);
act(() => {
screen.getByRole('button').click();
});
await waitFor(() => {
expect(screen.getByText('Lataa taulukko (xlsx)').closest('button')?.getAttribute('tabIndex')).toBe('0');
expect(screen.getByText('Lataa taulukko (csv)').closest('button')?.getAttribute('tabIndex')).toBe('-1');
});
act(() => {
fireEvent.keyDown(screen.getByRole('button'), { key: 'ArrowDown' });
});
await waitFor(() => {
expect(screen.getByText('Lataa taulukko (xlsx)').closest('button')?.getAttribute('tabIndex')).toBe('-1');
expect(screen.getByText('Lataa taulukko (csv)').closest('button')?.getAttribute('tabIndex')).toBe('0');
});
act(() => {
fireEvent.keyDown(screen.getByRole('button'), { key: 'ArrowDown' });
});
await waitFor(() => {
expect(screen.getByText('Lataa taulukko (xlsx)').closest('button')?.getAttribute('tabIndex')).toBe('0');
expect(screen.getByText('Lataa taulukko (csv)').closest('button')?.getAttribute('tabIndex')).toBe('-1');
});
});

it('should cycle from first to last item if up arrow is pressed on the first item', async () => {
const view = convertPxGrafResponseToView(HORIZONTAL_BAR_CHART_ASCENDING, {});
render(<BurgerMenu locale="fi" viewData={view} />);
act(() => {
screen.getByRole('button').click();
});
await waitFor(() => {
expect(screen.getByText('Lataa taulukko (xlsx)').closest('button')?.getAttribute('tabIndex')).toBe('0');
expect(screen.getByText('Lataa taulukko (csv)').closest('button')?.getAttribute('tabIndex')).toBe('-1');
});
act(() => {
fireEvent.keyDown(screen.getByRole('button'), { key: 'ArrowUp' });
});
await waitFor(() => {
expect(screen.getByText('Lataa taulukko (xlsx)').closest('button')?.getAttribute('tabIndex')).toBe('-1');
expect(screen.getByText('Lataa taulukko (csv)').closest('button')?.getAttribute('tabIndex')).toBe('0');
});
});
});
Loading
Loading