Skip to content

fix: Popover should stop propagating Escape key event on closing #3032

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 2 commits into from
May 2, 2022
Merged

fix: Popover should stop propagating Escape key event on closing #3032

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
67d063f
fix: Popover should stop propagating Escape key event on closing
bxiao Apr 20, 2022
7e0c755
Merge branch 'master' into fix/popoverEscapeClosePropagation
bxiao May 2, 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
28 changes: 28 additions & 0 deletions components/popover/__tests__/popover.browser-test.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,34 @@ describe('SLDSPopover', function () {
const trigger = wrapper.find(defaultIds.trigger);
trigger.simulate('click');
});

it('stops event propagation after closing on ESC', function (done) {
const mockEvent = {
key: 'Esc',
keyCode: 27,
which: 27,
stopPropagation: sinon.spy(),
};
wrapper = mount(
<DemoComponent
onOpen={() => {
wrapper.update();
const popover = wrapper.find(`#${defaultIds.popover}`);
popover.simulate('keyDown', mockEvent);
}}
onKeyDown={() => {
setTimeout(() => {
expect(mockEvent.stopPropagation.callCount).to.equal(1);
done();
}, 0);
}}
/>,
{ attachTo: mountNode }
);

const trigger = wrapper.find(defaultIds.trigger);
trigger.simulate('click');
});
});
});

Expand Down
3 changes: 3 additions & 0 deletions utilities/keyboard-navigable-dialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import ReactDOM from 'react-dom';

// ### Event Helpers
import KEYS from './key-code';
import EventUtil from './event';

/* eslint-disable react/no-find-dom-node */

Expand All @@ -33,6 +34,7 @@ const internalHandleClick = ({ trigger, eventTarget, handleClick }) => {
};

const KeyboardNavigableDialog = ({
event,
isOpen,
handleClick,
keyCode,
Expand All @@ -44,6 +46,7 @@ const KeyboardNavigableDialog = ({
case KEYS.ESCAPE:
if (isOpen) {
toggleOpen();
EventUtil.trapEvent(event);
}
break;
case KEYS.ENTER:
Expand Down