@vaadin/vaadin-overlay 23.0.8 → 23.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/vaadin-overlay",
-  "version": "23.0.8",
+  "version": "23.0.11",
   "publishConfig": {
     "access": "public"
   },
@@ -35,20 +35,20 @@
   ],
   "dependencies": {
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/component-base": "^23.0.8",
-    "@vaadin/vaadin-lumo-styles": "^23.0.8",
-    "@vaadin/vaadin-material-styles": "^23.0.8",
-    "@vaadin/vaadin-themable-mixin": "^23.0.8"
+    "@vaadin/component-base": "^23.0.11",
+    "@vaadin/vaadin-lumo-styles": "^23.0.11",
+    "@vaadin/vaadin-material-styles": "^23.0.11",
+    "@vaadin/vaadin-themable-mixin": "^23.0.11"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
     "@polymer/iron-overlay-behavior": "^3.0.0",
-    "@vaadin/button": "^23.0.8",
-    "@vaadin/radio-group": "^23.0.8",
+    "@vaadin/button": "^23.0.11",
+    "@vaadin/radio-group": "^23.0.11",
     "@vaadin/testing-helpers": "^0.3.2",
-    "@vaadin/text-field": "^23.0.8",
+    "@vaadin/text-field": "^23.0.11",
     "lit": "^2.0.0",
     "sinon": "^9.2.1"
   },
-  "gitHead": "43fe9d95c8cd745adc7bef214c0097c47f4f83ed"
+  "gitHead": "10838304fe6f5c98b838ec3a90bdcf49cbf4650b"
 }

package/src/vaadin-overlay-position-mixin.js

@@ -3,15 +3,16 @@
  * Copyright (c) 2017 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
+import { getAncestorRootNodes } from '@vaadin/component-base/src/dom-utils.js';
 
 const PROP_NAMES_VERTICAL = {
   start: 'top',
-  end: 'bottom'
+  end: 'bottom',
 };
 
 const PROP_NAMES_HORIZONTAL = {
   start: 'left',
-  end: 'right'
+  end: 'right',
 };
 
 /**
@@ -29,7 +30,7 @@ export const PositionMixin = (superClass) =>
          */
         positionTarget: {
           type: Object,
-          value: null
+          value: null,
         },
 
         /**
@@ -42,7 +43,7 @@ export const PositionMixin = (superClass) =>
          */
         horizontalAlign: {
           type: String,
-          value: 'start'
+          value: 'start',
         },
 
         /**
@@ -54,7 +55,7 @@ export const PositionMixin = (superClass) =>
          */
         verticalAlign: {
           type: String,
-          value: 'top'
+          value: 'top',
         },
 
         /**
@@ -63,7 +64,7 @@ export const PositionMixin = (superClass) =>
          */
         noHorizontalOverlap: {
           type: Boolean,
-          value: false
+          value: false,
         },
 
         /**
@@ -72,33 +73,68 @@ export const PositionMixin = (superClass) =>
          */
         noVerticalOverlap: {
           type: Boolean,
-          value: false
-        }
+          value: false,
+        },
       };
     }
 
     static get observers() {
       return [
-        '__positionSettingsChanged(positionTarget, horizontalAlign, verticalAlign, noHorizontalOverlap, noVerticalOverlap)',
-        '__overlayOpenedChanged(opened)'
+        '__positionSettingsChanged(horizontalAlign, verticalAlign, noHorizontalOverlap, noVerticalOverlap)',
+        '__overlayOpenedChanged(opened, positionTarget)',
       ];
     }
 
     constructor() {
       super();
 
-      this.__boundUpdatePosition = this._updatePosition.bind(this);
+      this._updatePosition = this._updatePosition.bind(this);
     }
 
-    __overlayOpenedChanged(opened) {
-      // Toggle the event listeners that cause the overlay to update its position
-      ['scroll', 'resize'].forEach((eventName) => {
-        if (opened) {
-          window.addEventListener(eventName, this.__boundUpdatePosition);
-        } else {
-          window.removeEventListener(eventName, this.__boundUpdatePosition);
-        }
+    /** @protected */
+    connectedCallback() {
+      super.connectedCallback();
+
+      if (this.opened) {
+        this.__addUpdatePositionEventListeners();
+      }
+    }
+
+    /** @protected */
+    disconnectedCallback() {
+      super.disconnectedCallback();
+      this.__removeUpdatePositionEventListeners();
+    }
+
+    /** @private */
+    __addUpdatePositionEventListeners() {
+      window.addEventListener('resize', this._updatePosition);
+
+      this.__positionTargetAncestorRootNodes = getAncestorRootNodes(this.positionTarget);
+      this.__positionTargetAncestorRootNodes.forEach((node) => {
+        node.addEventListener('scroll', this._updatePosition, true);
       });
+    }
+
+    /** @private */
+    __removeUpdatePositionEventListeners() {
+      window.removeEventListener('resize', this._updatePosition);
+
+      if (this.__positionTargetAncestorRootNodes) {
+        this.__positionTargetAncestorRootNodes.forEach((node) => {
+          node.removeEventListener('scroll', this._updatePosition, true);
+        });
+        this.__positionTargetAncestorRootNodes = null;
+      }
+    }
+
+    /** @private */
+    __overlayOpenedChanged(opened, positionTarget) {
+      this.__removeUpdatePositionEventListeners();
+
+      if (opened && positionTarget) {
+        this.__addUpdatePositionEventListeners();
+      }
 
       if (opened) {
         const computedStyle = getComputedStyle(this);
@@ -150,7 +186,7 @@ export const PositionMixin = (superClass) =>
         this.noVerticalOverlap,
         PROP_NAMES_VERTICAL,
         this,
-        shouldAlignStartVertically
+        shouldAlignStartVertically,
       );
 
       // Obtain horizontal positioning properties
@@ -160,7 +196,7 @@ export const PositionMixin = (superClass) =>
         this.noHorizontalOverlap,
         PROP_NAMES_HORIZONTAL,
         this,
-        shouldAlignStartHorizontally
+        shouldAlignStartHorizontally,
       );
 
       // Apply the positioning properties to the overlay
@@ -189,7 +225,7 @@ export const PositionMixin = (superClass) =>
         this.__margins,
         defaultAlignLeft,
         this.noHorizontalOverlap,
-        PROP_NAMES_HORIZONTAL
+        PROP_NAMES_HORIZONTAL,
       );
     }
 
@@ -209,7 +245,7 @@ export const PositionMixin = (superClass) =>
         this.__margins,
         defaultAlignTop,
         this.noVerticalOverlap,
-        PROP_NAMES_VERTICAL
+        PROP_NAMES_VERTICAL,
       );
     }
 
@@ -245,7 +281,7 @@ export const PositionMixin = (superClass) =>
 
       return {
         [cssPropNameToSet]: currentValue + diff * (shouldAlignStart ? -1 : 1) + 'px',
-        [cssPropNameToClear]: ''
+        [cssPropNameToClear]: '',
       };
     }
   };

package/src/vaadin-overlay.d.ts

@@ -232,13 +232,13 @@ declare class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(HTML
   addEventListener<K extends keyof OverlayEventMap>(
     type: K,
     listener: (this: OverlayElement, ev: OverlayEventMap[K]) => void,
-    options?: boolean | AddEventListenerOptions
+    options?: boolean | AddEventListenerOptions,
   ): void;
 
   removeEventListener<K extends keyof OverlayEventMap>(
     type: K,
     listener: (this: OverlayElement, ev: OverlayEventMap[K]) => void,
-    options?: boolean | EventListenerOptions
+    options?: boolean | EventListenerOptions,
   ): void;
 }
 

package/src/vaadin-overlay.js

@@ -194,7 +194,7 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
         type: Boolean,
         notify: true,
         observer: '_openedChanged',
-        reflectToAttribute: true
+        reflectToAttribute: true,
       },
 
       /**
@@ -220,7 +220,7 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
        */
       template: {
         type: Object,
-        notify: true
+        notify: true,
       },
 
       /**
@@ -229,7 +229,7 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
        */
       content: {
         type: Object,
-        notify: true
+        notify: true,
       },
 
       /**
@@ -239,7 +239,7 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
       withBackdrop: {
         type: Boolean,
         value: false,
-        reflectToAttribute: true
+        reflectToAttribute: true,
       },
 
       /**
@@ -256,7 +256,7 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
         type: Boolean,
         value: false,
         reflectToAttribute: true,
-        observer: '_modelessChanged'
+        observer: '_modelessChanged',
       },
 
       /**
@@ -267,7 +267,7 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
       hidden: {
         type: Boolean,
         reflectToAttribute: true,
-        observer: '_hiddenChanged'
+        observer: '_hiddenChanged',
       },
 
       /**
@@ -277,7 +277,7 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
        */
       focusTrap: {
         type: Boolean,
-        value: false
+        value: false,
       },
 
       /**
@@ -286,7 +286,7 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
        */
       restoreFocusOnClose: {
         type: Boolean,
-        value: false
+        value: false,
       },
 
       /**
@@ -295,22 +295,22 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
        * @type {HTMLElement}
        */
       restoreFocusNode: {
-        type: HTMLElement
+        type: HTMLElement,
       },
 
       /** @private */
       _mouseDownInside: {
-        type: Boolean
+        type: Boolean,
       },
 
       /** @private */
       _mouseUpInside: {
-        type: Boolean
+        type: Boolean,
       },
 
       /** @private */
       _instance: {
-        type: Object
+        type: Object,
       },
 
       /** @private */
@@ -332,7 +332,7 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
       _oldRenderer: Object,
 
       /** @private */
-      _oldOpened: Boolean
+      _oldOpened: Boolean,
     };
   }
 
@@ -416,7 +416,7 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
     var evt = new CustomEvent('vaadin-overlay-close', {
       bubbles: true,
       cancelable: true,
-      detail: { sourceEvent: sourceEvent }
+      detail: { sourceEvent: sourceEvent },
     });
     this.dispatchEvent(evt);
     if (!evt.defaultPrevented) {
@@ -495,7 +495,7 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
     const evt = new CustomEvent('vaadin-overlay-outside-click', {
       bubbles: true,
       cancelable: true,
-      detail: { sourceEvent: event }
+      detail: { sourceEvent: event },
     });
     this.dispatchEvent(evt);
 
@@ -515,11 +515,16 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
       return;
     }
 
+    // Only close modeless overlay on Esc press when it contains focus
+    if (this.modeless && !event.composedPath().includes(this.$.overlay)) {
+      return;
+    }
+
     if (event.key === 'Escape') {
       const evt = new CustomEvent('vaadin-overlay-escape-press', {
         bubbles: true,
         cancelable: true,
-        detail: { sourceEvent: event }
+        detail: { sourceEvent: event },
       });
       this.dispatchEvent(evt);
 
@@ -559,14 +564,20 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
         this.dispatchEvent(evt);
       });
 
+      document.addEventListener('keydown', this._boundKeydownListener);
+
       if (!this.modeless) {
         this._addGlobalListeners();
       }
     } else if (wasOpened) {
-      this.__focusTrapController.releaseFocus();
+      if (this.focusTrap) {
+        this.__focusTrapController.releaseFocus();
+      }
 
       this._animatedClosing();
 
+      document.removeEventListener('keydown', this._boundKeydownListener);
+
       if (!this.modeless) {
         this._removeGlobalListeners();
       }
@@ -753,7 +764,6 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
     // Firefox leaks click to document on contextmenu even if prevented
     // https://bugzilla.mozilla.org/show_bug.cgi?id=990614
     document.documentElement.addEventListener('click', this._boundOutsideClickListener, true);
-    document.addEventListener('keydown', this._boundKeydownListener);
   }
 
   /** @protected */
@@ -778,7 +788,6 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
     document.removeEventListener('mousedown', this._boundMouseDownListener);
     document.removeEventListener('mouseup', this._boundMouseUpListener);
     document.documentElement.removeEventListener('click', this._boundOutsideClickListener, true);
-    document.removeEventListener('keydown', this._boundKeydownListener);
   }
 
   /** @protected */
@@ -846,7 +855,7 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
           if (this._instance) {
             this._instance.forwardHostProp(prop, value);
           }
-        }
+        },
       });
     }
 
@@ -862,7 +871,7 @@ class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(PolymerEleme
 
       let scopeCssText = Array.from(templateRoot.querySelectorAll('style')).reduce(
         (result, style) => result + style.textContent,
-        ''
+        '',
       );
 
       // The overlay root’s :host styles should not apply inside the overlay