Skip to content

Ensure enter key closes the menu #50

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
merged 7 commits into from
Dec 19, 2019
Merged

Ensure enter key closes the menu #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ea7a764
Ensure enter key closes the menu
WesCossick Dec 19, 2019
b858613
Tweak the wording of the behavior
WesCossick Dec 19, 2019
d63d8b6
Merge branch 'master' into enter-close-menu
WesCossick Dec 19, 2019
2474e32
Strip out unnecessary code from test component
WesCossick Dec 19, 2019
5c89567
Add test for rerouting enters to clicks
WesCossick Dec 19, 2019
098fbe4
Format the code
WesCossick Dec 19, 2019
de75478
Format the code
WesCossick Dec 19, 2019
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
5 changes: 4 additions & 1 deletion demo/src/app.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,10 @@ const App: React.FC = () => {
<li>The up / down arrow keys allow for navigation through the menu items</li>
<li>Pressing tab will close the menu and move the focus to the next focusable element</li>
<li>Pressing escape will close the menu and return the focus to the button</li>
<li>Pressing enter will trigger that item (whether itʼs a link or has a click handler attached)</li>
<li>
Pressing enter will activate that item and close the menu (whether itʼs a link or has a click handler
attached)
</li>
</ul>
</li>
</ul>
Expand Down
8 changes: 6 additions & 2 deletions src/use-dropdown-menu.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,12 @@ export default function useDropdownMenu(itemCount: number) {
} else if (key === 'Tab') {
setIsOpen(false);
return;
} else if (key === 'Enter' && !e.currentTarget.href) {
e.currentTarget.click();
} else if (key === 'Enter') {
if (!e.currentTarget.href) {
e.currentTarget.click();
}

setIsOpen(false);
return;
}

Expand Down
18 changes: 18 additions & 0 deletions test/puppeteer/demo.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,21 @@ it('leaves the menu open if you click inside of it', async () => {

expect(true).toBe(true);
});

it('reroutes enter presses on menu items as clicks', async () => {
let alertAppeared = false;

await page.click('#menu-button');
await menuOpen();

// eslint-disable-next-line @typescript-eslint/no-misused-promises
page.on('dialog', async dialog => {
alertAppeared = true;
await dialog.dismiss();
});

await page.focus('#menu-item-3');
await keyboard.down('Enter');

expect(alertAppeared).toBe(true);
});
14 changes: 6 additions & 8 deletions test/test-component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,25 @@ const TestComponent: React.FC = () => {

return (
<React.Fragment>
<button type='button' {...buttonProps} id='menu-button' tabIndex={0}>
<button {...buttonProps} id='menu-button'>
Primary
</button>

<div style={{ display: isOpen ? 'block' : 'none' }} role='menu' id='menu'>
<a style={{ display: 'block' }} {...itemProps[0]} onClick={() => null} id='menu-item-1'>
<div role='menu' id='menu'>
<a {...itemProps[0]} onClick={() => null} id='menu-item-1'>
Item 1
</a>

<a style={{ display: 'block' }} href='https://example.com' {...itemProps[1]} id='menu-item-2'>
<a {...itemProps[1]} href='https://example.com' id='menu-item-2'>
Item 2
</a>

<a style={{ display: 'block' }} href='https://example.com' {...itemProps[2]} id='menu-item-3'>
<a {...itemProps[2]} href='https://example.com' id='menu-item-3'>
Item 3
</a>
</div>

<button type='button' id='second-button' tabIndex={0}>
Another Button
</button>
<button id='second-button'>Another Button</button>

<span id='is-open-indicator'>{isOpen ? 'true' : 'false'}</span>
</React.Fragment>
Expand Down