Skip to content

fix(sharing-dialog): add keyboard navigation to autocomplete #1762

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

Open
ericcowan wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(sharing-dialog): add keyboard navigation to autocomplete #1762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 27 additions & 10 deletions components/sharing-dialog/src/autocomplete/autocomplete.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,23 @@ export const Autocomplete = ({
searchResults,
}) => {
const wrapper = useRef(null)
const menuWrapper = useRef(null)
const [menuWidth] = useSize(wrapper)
const { isDisconnected: offline } = useDhis2ConnectionStatus()

const handleInputKeyDown = (_, event) => {
if (event.key !== 'ArrowDown') {
return
}

const menu = menuWrapper.current?.querySelector('[role="menu"]')

if (menu) {
event.preventDefault()
menu.focus()
}
}

return (
<>
<div ref={wrapper}>
Expand All @@ -31,6 +45,7 @@ export const Autocomplete = ({
loading={loading}
placeholder={placeholder}
onChange={({ value }) => onSearch(value)}
onKeyDown={handleInputKeyDown}
value={search}
inputWidth={inputWidth}
disabled={offline}
Expand All @@ -44,16 +59,18 @@ export const Autocomplete = ({
menuRef={wrapper}
dataTest={`${dataTest}-menu`}
>
<Menu>
{searchResults.map((result) => (
<MenuItem
key={result.id}
label={result.displayName}
value={result.id}
onClick={({ value }) => onSelect(value)}
/>
))}
</Menu>
<div ref={menuWrapper}>
<Menu>
{searchResults.map((result) => (
<MenuItem
key={result.id}
label={result.displayName}
value={result.id}
onClick={({ value }) => onSelect(value)}
/>
))}
</Menu>
</div>
</MenuPopup>
)}
</>
Expand Down
41 changes: 41 additions & 0 deletions components/sharing-dialog/src/autocomplete/sharing-autocomplete.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,47 @@ const Wrapper = () => {
}

describe('SharingAutocomplete', () => {
it('supports keyboard navigation and selection from the search input', async () => {
const userDisplayName = 'Some User'
const dataProviderData = {
'sharing/search': jest.fn(() => ({
users: [
{
id: 'user-1',
displayName: userDisplayName,
},
{
id: 'user-2',
displayName: 'Someone Else',
},
],
})),
}
render(
<CustomDataProvider data={dataProviderData}>
<Wrapper />
</CustomDataProvider>
)

await userEvent.type(screen.getByRole('textbox'), 'Som')
const [firstResult, secondResult] = await screen.findAllByRole(
'menuitem'
)

expect(screen.getByRole('textbox')).toHaveFocus()
await userEvent.keyboard('{ArrowDown}')
expect(firstResult.parentElement).toHaveFocus()

await userEvent.keyboard('{ArrowDown}')
expect(secondResult.parentElement).toHaveFocus()

await userEvent.keyboard('{ArrowUp}')
expect(firstResult.parentElement).toHaveFocus()

await userEvent.keyboard('{Enter}')
expect(screen.getByRole('textbox')).toHaveValue(userDisplayName)
})

it('hides autocompletion results after selection', async () => {
const userDisplayName = 'Some User'
const dataProviderData = {
Expand Down