Skip to content

Commit caa9482

Browse files
fix: close tooltip when opening another overlay (#4852) (#4854)
Co-authored-by: Sascha Ißbrücker <sissbruecker@vaadin.com>
1 parent 0863b9b commit caa9482

3 files changed

Lines changed: 110 additions & 1 deletion

File tree

‎integration/tests/component-tooltip.test.js‎

Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { expect } from '@esm-bundle/chai';
2-
import { fixtureSync } from '@vaadin/testing-helpers';
2+
import { fixtureSync, nextRender, tabKeyDown } from '@vaadin/testing-helpers';
33
import '@vaadin/tooltip';
44
import { Button } from '@vaadin/button';
55
import { Checkbox } from '@vaadin/checkbox';
@@ -110,3 +110,71 @@ import { mouseenter, mouseleave } from '@vaadin/tooltip/test/helpers.js';
110110
});
111111
});
112112
});
113+
114+
[
115+
{
116+
tagName: ComboBox.is,
117+
setup: (comboBox) => {
118+
comboBox.items = [1, 2, 3];
119+
},
120+
open: (comboBox) => comboBox.open(),
121+
},
122+
{
123+
tagName: DatePicker.is,
124+
open: (datePicker) => datePicker.open(),
125+
},
126+
// DateTimePicker -> DatePicker
127+
{
128+
tagName: DateTimePicker.is,
129+
open: (dateTimePicker) => dateTimePicker.__datePicker.open(),
130+
},
131+
// DateTimePicker -> TimePicker
132+
{
133+
tagName: DateTimePicker.is,
134+
open: (dateTimePicker) => dateTimePicker.__timePicker.open(),
135+
},
136+
{
137+
tagName: TimePicker.is,
138+
open: (timePicker) => timePicker.open(),
139+
},
140+
{
141+
tagName: Select.is,
142+
setup: (select) => {
143+
select.items = [
144+
{ label: '1', value: 1 },
145+
{ label: '2', value: 2 },
146+
{ label: '3', value: 3 },
147+
];
148+
},
149+
open: (select) => {
150+
select.opened = true;
151+
},
152+
},
153+
].forEach(({ tagName, setup, open }) => {
154+
describe(`${tagName} overlay with slotted tooltip`, () => {
155+
let element, tooltip, tooltipOverlay;
156+
157+
beforeEach(() => {
158+
element = fixtureSync(`
159+
<${tagName}>
160+
<vaadin-tooltip slot="tooltip" text="Tooltip text"></vaadin-tooltip>
161+
</${tagName}>
162+
`);
163+
if (setup) {
164+
setup(element);
165+
}
166+
tooltip = element.querySelector('vaadin-tooltip');
167+
tooltipOverlay = tooltip.shadowRoot.querySelector('vaadin-tooltip-overlay');
168+
});
169+
170+
it(`should close tooltip when opening ${tagName} overlay`, async () => {
171+
tabKeyDown(element);
172+
element.focus();
173+
expect(tooltipOverlay.opened).to.be.true;
174+
175+
open(element);
176+
await nextRender();
177+
expect(tooltipOverlay.opened).to.be.false;
178+
});
179+
});
180+
});

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -472,6 +472,7 @@ class Tooltip extends ThemePropertyMixin(ElementMixin(PolymerElement)) {
472472
this.__onMouseEnter = this.__onMouseEnter.bind(this);
473473
this.__onMouseLeave = this.__onMouseLeave.bind(this);
474474
this.__onKeyDown = this.__onKeyDown.bind(this);
475+
this.__onOverlayOpen = this.__onOverlayOpen.bind(this);
475476

476477
this.__targetVisibilityObserver = new IntersectionObserver(
477478
([entry]) => {
@@ -488,6 +489,8 @@ class Tooltip extends ThemePropertyMixin(ElementMixin(PolymerElement)) {
488489
super.connectedCallback();
489490

490491
this._isConnected = true;
492+
493+
document.body.addEventListener('vaadin-overlay-open', this.__onOverlayOpen);
491494
}
492495

493496
/** @protected */
@@ -498,6 +501,8 @@ class Tooltip extends ThemePropertyMixin(ElementMixin(PolymerElement)) {
498501
this._stateController.close(true);
499502
}
500503
this._isConnected = false;
504+
505+
document.body.removeEventListener('vaadin-overlay-open', this.__onOverlayOpen);
501506
}
502507

503508
/** @private */
@@ -694,6 +699,18 @@ class Tooltip extends ThemePropertyMixin(ElementMixin(PolymerElement)) {
694699
}
695700
}
696701

702+
/** @private */
703+
__onOverlayOpen() {
704+
if (this.manual) {
705+
return;
706+
}
707+
708+
// Close tooltip if another overlay is opened on top of the tooltip's overlay
709+
if (this._overlayElement.opened && !this._overlayElement._last) {
710+
this._stateController.close(true);
711+
}
712+
}
713+
697714
/** @private */
698715
__onTargetVisibilityChange(isVisible) {
699716
const oldHidden = this.__isTargetHidden;

‎packages/tooltip/test/tooltip.test.js‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import {
77
keyboardEventFor,
88
mousedown,
99
nextFrame,
10+
nextRender,
1011
tabKeyDown,
1112
} from '@vaadin/testing-helpers';
1213
import sinon from 'sinon';
@@ -418,6 +419,18 @@ describe('vaadin-tooltip', () => {
418419

419420
expect(overlay.opened).to.be.false;
420421
});
422+
423+
it('should close overlay when another overlay opens', async () => {
424+
tabKeyDown(target);
425+
target.focus();
426+
expect(overlay.opened).to.be.true;
427+
428+
const otherOverlay = fixtureSync('<vaadin-overlay></vaadin-overlay>');
429+
otherOverlay.opened = true;
430+
await nextRender();
431+
432+
expect(overlay.opened).to.be.false;
433+
});
421434
});
422435

423436
describe('inside a scrollable container', () => {
@@ -656,6 +669,17 @@ describe('vaadin-tooltip', () => {
656669
document.body.append(tooltip);
657670
expect(overlay.opened).to.be.true;
658671
});
672+
673+
it('should not close overlay when another overlay opens', async () => {
674+
tooltip.opened = true;
675+
expect(overlay.opened).to.be.true;
676+
677+
const otherOverlay = fixtureSync('<vaadin-overlay></vaadin-overlay>');
678+
otherOverlay.opened = true;
679+
await nextRender();
680+
681+
expect(overlay.opened).to.be.true;
682+
});
659683
});
660684
});
661685

0 commit comments

Comments
 (0)