Skip to content

Stop keypresses being caught by other elements when they happen in a CustomSelectControl #30557

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
ciampo merged 10 commits into from
Jan 11, 2022
Merged

Stop keypresses being caught by other elements when they happen in a CustomSelectControl #30557

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0a90dbc
Stop the keydown event from propagating in CustomSelect component
opr Apr 7, 2021
dbaf35c
Stop the synthetic event propagating instead of native
opr Nov 26, 2021
2b1dc16
Move keyDown handler into useCallback and use optional chaining
opr Jan 10, 2022
9b4e029
Add unit tests for CustomSelectControl
opr Jan 10, 2022
371ec1f
Update changelog
opr Jan 10, 2022
0489952
Add inline comment about role and remove unneeded class name
opr Jan 10, 2022
003c5ad
Move mocked function into test
opr Jan 10, 2022
796d5ed
Add correct spacing to changelog
opr Jan 10, 2022
e48dfed
Add options as an array of key value pairs
opr Jan 10, 2022
58a2dca
Use accessible roles instead of looking for elements by className
opr Jan 10, 2022
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
Prev Previous commit
Next Next commit
Move keyDown handler into useCallback and use optional chaining
  • Loading branch information
@opr
opr committed Jan 11, 2022
commit 2b1dc164f22642d83e6fd48f1b1a3d7ff2ed3939
19 changes: 12 additions & 7 deletions packages/components/src/custom-select-control/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import classnames from 'classnames';
*/
import { Icon, check, chevronDown } from '@wordpress/icons';
import { __, sprintf } from '@wordpress/i18n';
import { useCallback } from '@wordpress/element';

/**
* Internal dependencies
*/
Expand Down Expand Up @@ -98,6 +100,15 @@ export default function CustomSelectControl( {
className: 'components-custom-select-control__menu',
'aria-hidden': ! isOpen,
} );

const onKeyDownHandler = useCallback(
( e ) => {
e.stopPropagation();
menuProps?.onKeyDown?.( e );
},
[ menuProps ]
);

// We need this here, because the null active descendant is not fully ARIA compliant.
if (
menuProps[ 'aria-activedescendant' ]?.startsWith( 'downshift-null' )
Expand Down Expand Up @@ -142,13 +153,7 @@ export default function CustomSelectControl( {
/>
</Button>
{ /* eslint-disable-next-line jsx-a11y/no-noninteractive-element-interactions */ }
<ul
{ ...menuProps }
onKeyDown={ ( e ) => {
e.stopPropagation();
menuProps.onKeyDown( e );
} }
>
<ul { ...menuProps } onKeyDown={ onKeyDownHandler }>
{ isOpen &&
items.map( ( item, index ) => (
// eslint-disable-next-line react/jsx-key
Expand Down