Skip to content

Commit 3411ab4

Browse files
authored
fix: do not update position on scroll events inside the overlay (#4689)
1 parent 619051e commit 3411ab4

2 files changed

Lines changed: 22 additions & 2 deletions

File tree

‎packages/vaadin-overlay/src/vaadin-overlay-position-mixin.js‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ export const PositionMixin = (superClass) =>
9898
constructor() {
9999
super();
100100

101+
this.__onScroll = this.__onScroll.bind(this);
101102
this._updatePosition = this._updatePosition.bind(this);
102103
}
103104

@@ -122,7 +123,7 @@ export const PositionMixin = (superClass) =>
122123

123124
this.__positionTargetAncestorRootNodes = getAncestorRootNodes(this.positionTarget);
124125
this.__positionTargetAncestorRootNodes.forEach((node) => {
125-
node.addEventListener('scroll', this._updatePosition, true);
126+
node.addEventListener('scroll', this.__onScroll, true);
126127
});
127128
}
128129

@@ -132,7 +133,7 @@ export const PositionMixin = (superClass) =>
132133

133134
if (this.__positionTargetAncestorRootNodes) {
134135
this.__positionTargetAncestorRootNodes.forEach((node) => {
135-
node.removeEventListener('scroll', this._updatePosition, true);
136+
node.removeEventListener('scroll', this.__onScroll, true);
136137
});
137138
this.__positionTargetAncestorRootNodes = null;
138139
}
@@ -177,6 +178,14 @@ export const PositionMixin = (superClass) =>
177178
this._updatePosition();
178179
}
179180

181+
/** @private */
182+
__onScroll(e) {
183+
// If the scroll event occurred inside the overlay, ignore it.
184+
if (!this.contains(e.target)) {
185+
this._updatePosition();
186+
}
187+
}
188+
180189
_updatePosition() {
181190
if (!this.positionTarget || !this.opened) {
182191
return;

‎packages/vaadin-overlay/test/position-mixin-listeners.test.js‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,17 @@ describe('position mixin listeners', () => {
9999
scroll(scrollableAncestor);
100100
expect(updatePositionSpy.called).to.be.true;
101101
});
102+
103+
it('should not update position on scroll that occurs inside the overlay', async () => {
104+
overlay.positionTarget = target;
105+
// Wait for the overlay open to finish (invokes _updatePosition once)
106+
await nextFrame();
107+
updatePositionSpy.resetHistory();
108+
109+
// Scroll inside the overlay
110+
scroll(overlay);
111+
expect(updatePositionSpy.called).to.be.false;
112+
});
102113
});
103114

104115
describe('opened', () => {

0 commit comments

Comments
 (0)