Skip to content
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

[material-ui][MenuList] Do not react to an event with modifier key pressed #43505

Merged
merged 2 commits into from
Aug 30, 2024
Merged

[material-ui][MenuList] Do not react to an event with modifier key pressed #43505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
346338c
[material-ui][MenuList] do not react to an event with modifier key pr…
MateuszGroth Aug 28, 2024
04b2979
Merge branch 'master' into menu-prevent-default-with-ctrl-key
ZeeshanTamboli Aug 30, 2024
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
10 changes: 10 additions & 0 deletions packages/mui-material/src/MenuList/MenuList.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,16 @@ const MenuList = React.forwardRef(function MenuList(props, ref) {
const handleKeyDown = (event) => {
const list = listRef.current;
const key = event.key;
const isModifierKeyPressed = event.ctrlKey || event.metaKey || event.altKey;

if (isModifierKeyPressed) {
if (onKeyDown) {
onKeyDown(event);
}

return;
}

/**
* @type {Element} - will always be defined since we are in a keydown handler
* attached to an element. A keydown event is either dispatched to the activeElement
Expand Down
43 changes: 43 additions & 0 deletions packages/mui-material/test/integration/MenuList.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,49 @@ describe('<MenuList> integration', () => {
expect(menuitems[1]).to.have.property('tabIndex', -1);
expect(menuitems[2]).to.have.property('tabIndex', -1);
});

describe('when a modifier key is pressed', () => {
it('should not move the focus', () => {
const { getAllByRole } = render(
<MenuList autoFocusItem>
<MenuItem selected>Menu Item 1</MenuItem>
<MenuItem>Menu Item 2</MenuItem>
<MenuItem>Menu Item 3</MenuItem>
</MenuList>,
);

const menuitems = getAllByRole('menuitem');
fireEvent.keyDown(menuitems[0], { key: 'ArrowDown', ctrlKey: true });
expect(menuitems[0]).toHaveFocus();
expect(menuitems[1]).not.toHaveFocus();

fireEvent.keyDown(menuitems[0], { key: 'ArrowDown', altKey: true });
expect(menuitems[0]).toHaveFocus();
expect(menuitems[1]).not.toHaveFocus();

fireEvent.keyDown(menuitems[0], { key: 'ArrowDown', metaKey: true });
expect(menuitems[0]).toHaveFocus();
expect(menuitems[1]).not.toHaveFocus();
});

it('should call the onKeyDown and not prevent default on the event', () => {
const onKeyDown = spy();
const { getAllByRole } = render(
<MenuList autoFocusItem onKeyDown={onKeyDown}>
<MenuItem selected>Menu Item 1</MenuItem>
<MenuItem>Menu Item 2</MenuItem>
<MenuItem>Menu Item 3</MenuItem>
</MenuList>,
);

const menuitems = getAllByRole('menuitem');
fireEvent.keyDown(menuitems[0], { key: 'ArrowDown', ctrlKey: true });

expect(onKeyDown.callCount).to.equal(1);
expect(onKeyDown.firstCall.args[0]).to.have.property('ctrlKey', true);
expect(onKeyDown.firstCall.args[0]).to.have.property('defaultPrevented', false);
});
});
});

describe('keyboard controls and tabIndex manipulation - preselected item', () => {
Expand Down