Skip to content

Commit c38731d

Browse files
authored
refactor: close popover on global Escape press by default (#7434)
1 parent 04107da commit c38731d

2 files changed

Lines changed: 29 additions & 32 deletions

File tree

‎packages/popover/src/vaadin-popover.js‎

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ class Popover extends PopoverPositionMixin(
4848
type: Boolean,
4949
value: false,
5050
notify: true,
51+
observer: '__openedChanged',
5152
},
5253

5354
/**
@@ -140,6 +141,7 @@ class Popover extends PopoverPositionMixin(
140141
constructor() {
141142
super();
142143
this.__onGlobalClick = this.__onGlobalClick.bind(this);
144+
this.__onGlobalKeyDown = this.__onGlobalKeyDown.bind(this);
143145
this.__onTargetClick = this.__onTargetClick.bind(this);
144146
this.__onTargetKeydown = this.__onTargetKeydown.bind(this);
145147
this.__onTargetFocusIn = this.__onTargetFocusIn.bind(this);
@@ -246,6 +248,15 @@ class Popover extends PopoverPositionMixin(
246248
target.removeEventListener('focusout', this.__onTargetFocusOut);
247249
}
248250

251+
/** @private */
252+
__openedChanged(opened, oldOpened) {
253+
if (opened) {
254+
document.addEventListener('keydown', this.__onGlobalKeyDown, true);
255+
} else if (oldOpened) {
256+
document.removeEventListener('keydown', this.__onGlobalKeyDown, true);
257+
}
258+
}
259+
249260
/**
250261
* Overlay's global outside click listener doesn't work when
251262
* the overlay is modeless, so we use a separate listener.
@@ -273,14 +284,21 @@ class Popover extends PopoverPositionMixin(
273284
}
274285
}
275286

276-
/** @private */
277-
__onTargetKeydown(event) {
278-
if (event.key === 'Escape' && !this.noCloseOnEsc && this.opened && !this.__isManual) {
287+
/**
288+
* Overlay's global Escape press listener doesn't work when
289+
* the overlay is modeless, so we use a separate listener.
290+
* @private
291+
*/
292+
__onGlobalKeyDown(event) {
293+
if (event.key === 'Escape' && !this.modal && !this.noCloseOnEsc && this.opened && !this.__isManual) {
279294
// Prevent closing parent overlay (e.g. dialog)
280295
event.stopPropagation();
281296
this.opened = false;
282297
}
298+
}
283299

300+
/** @private */
301+
__onTargetKeydown(event) {
284302
// Prevent restoring focus after target blur on Tab key
285303
if (event.key === 'Tab' && this.__shouldRestoreFocus) {
286304
this.__shouldRestoreFocus = false;

‎packages/popover/test/basic.test.js‎

Lines changed: 8 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -234,35 +234,13 @@ describe('popover', () => {
234234
await nextRender();
235235
});
236236

237-
it('should not close overlay on global Escape press by default', async () => {
237+
it('should close overlay on global Escape press by default', async () => {
238238
esc(document.body);
239239
await nextRender();
240-
expect(overlay.opened).to.be.true;
241-
});
242-
243-
it('should close overlay on global Escape press when modal is true', async () => {
244-
popover.modal = true;
245-
await nextUpdate(popover);
246-
247-
esc(document.body);
248-
await nextRender();
249-
expect(overlay.opened).to.be.false;
250-
});
251-
252-
it('should close overlay on internal Escape press by default', async () => {
253-
esc(overlay.$.overlay);
254-
await nextRender();
255-
expect(overlay.opened).to.be.false;
256-
});
257-
258-
it('should close overlay on target Escape press by default', async () => {
259-
esc(target);
260-
await nextRender();
261240
expect(overlay.opened).to.be.false;
262241
});
263242

264243
it('should not close on global Escape press if noCloseOnEsc is true', async () => {
265-
popover.modal = true;
266244
popover.noCloseOnEsc = true;
267245
await nextUpdate(popover);
268246

@@ -271,20 +249,21 @@ describe('popover', () => {
271249
expect(overlay.opened).to.be.true;
272250
});
273251

274-
it('should not close overlay on internal Escape if noCloseOnEsc is true', async () => {
275-
popover.noCloseOnEsc = true;
252+
it('should close overlay on global Escape press when modal is true', async () => {
253+
popover.modal = true;
276254
await nextUpdate(popover);
277255

278-
esc(overlay.$.overlay);
256+
esc(document.body);
279257
await nextRender();
280-
expect(overlay.opened).to.be.true;
258+
expect(overlay.opened).to.be.false;
281259
});
282260

283-
it('should not close overlay on target Escape if noCloseOnEsc is true', async () => {
261+
it('should not close on global Escape press if noCloseOnEsc is true when moodal', async () => {
262+
popover.modal = true;
284263
popover.noCloseOnEsc = true;
285264
await nextUpdate(popover);
286265

287-
esc(target);
266+
esc(document.body);
288267
await nextRender();
289268
expect(overlay.opened).to.be.true;
290269
});

0 commit comments

Comments
 (0)