@vaadin/vaadin-overlay 21.0.1 → 22.0.0-alpha10

package/package.json

@@ -1,10 +1,29 @@
 {
   "name": "@vaadin/vaadin-overlay",
-  "version": "21.0.1",
+  "version": "22.0.0-alpha10",
+  "publishConfig": {
+    "access": "public"
+  },
   "description": "vaadin-overlay",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vaadin/web-components.git",
+    "directory": "packages/vaadin-overlay"
+  },
+  "author": "Vaadin Ltd",
+  "homepage": "https://vaadin.com/components",
+  "bugs": {
+    "url": "https://github.com/vaadin/vaadin-overlay/issues"
+  },
   "main": "vaadin-overlay.js",
   "module": "vaadin-overlay.js",
-  "repository": "vaadin/vaadin-overlay",
+  "files": [
+    "src",
+    "theme",
+    "vaadin-*.d.ts",
+    "vaadin-*.js"
+  ],
   "keywords": [
     "Vaadin",
     "vaadin-overlay",
@@ -13,37 +32,22 @@
     "web-component",
     "polymer"
   ],
-  "author": "Vaadin Ltd",
-  "license": "Apache-2.0",
-  "bugs": {
-    "url": "https://github.com/vaadin/vaadin-overlay/issues"
-  },
-  "homepage": "https://vaadin.com/components",
-  "files": [
-    "vaadin-*.d.ts",
-    "vaadin-*.js",
-    "src",
-    "theme"
-  ],
   "dependencies": {
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/vaadin-element-mixin": "^21.0.1",
-    "@vaadin/vaadin-lumo-styles": "^21.0.1",
-    "@vaadin/vaadin-material-styles": "^21.0.1",
-    "@vaadin/vaadin-themable-mixin": "^21.0.1"
+    "@vaadin/component-base": "22.0.0-alpha10",
+    "@vaadin/vaadin-lumo-styles": "22.0.0-alpha10",
+    "@vaadin/vaadin-material-styles": "22.0.0-alpha10",
+    "@vaadin/vaadin-themable-mixin": "22.0.0-alpha10"
   },
   "devDependencies": {
-    "@esm-bundle/chai": "^4.1.5",
+    "@esm-bundle/chai": "^4.3.4",
     "@polymer/iron-overlay-behavior": "^3.0.0",
-    "@vaadin/testing-helpers": "^0.2.1",
-    "@vaadin/vaadin-button": "^21.0.1",
-    "@vaadin/vaadin-radio-button": "^21.0.1",
-    "@vaadin/vaadin-text-field": "^21.0.1",
-    "lit": "^2.0.0-rc.1",
+    "@vaadin/button": "22.0.0-alpha10",
+    "@vaadin/radio-group": "22.0.0-alpha10",
+    "@vaadin/testing-helpers": "^0.3.0",
+    "@vaadin/text-field": "22.0.0-alpha10",
+    "lit": "^2.0.0",
     "sinon": "^9.2.1"
   },
-  "publishConfig": {
-    "access": "public"
-  },
-  "gitHead": "91e44dcfa63dc5e30e1e8d18be499b3e1e17b1c4"
+  "gitHead": "6d3055383b9c3c8306ea34c6f2e2087e63c49348"
 }

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

@@ -3,10 +3,21 @@
  * Copyright (c) 2021 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
+
+const PROP_NAMES_VERTICAL = {
+  start: 'top',
+  end: 'bottom'
+};
+
+const PROP_NAMES_HORIZONTAL = {
+  start: 'left',
+  end: 'right'
+};
+
 /**
  * @polymerMixin
  */
-export const _PositionMixin = (superClass) =>
+export const PositionMixin = (superClass) =>
   class PositionMixin extends superClass {
     static get properties() {
       return {
@@ -67,31 +78,45 @@ export const _PositionMixin = (superClass) =>
     }
     static get observers() {
       return [
-        `__positionSettingsChanged(positionTarget, horizontalAlign, verticalAlign,
-      noHorizontalOverlap, noVerticalOverlap)`
+        '__positionSettingsChanged(positionTarget, horizontalAlign, verticalAlign, noHorizontalOverlap, noVerticalOverlap)',
+        '__overlayOpenedChanged(opened)'
       ];
     }
 
     constructor() {
       super();
 
-      const boundUpdatePosition = this._updatePosition.bind(this);
-
-      this.addEventListener('opened-changed', (e) => {
-        const func = e.detail.value ? 'addEventListener' : 'removeEventListener';
-        window[func]('scroll', boundUpdatePosition);
-        window[func]('resize', boundUpdatePosition);
+      this.__boundUpdatePosition = this._updatePosition.bind(this);
+    }
 
-        if (e.detail.value) {
-          this._updatePosition();
+    __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);
         }
       });
-    }
 
-    ready() {
-      super.ready();
+      if (opened) {
+        const computedStyle = getComputedStyle(this);
+        if (!this.__margins) {
+          this.__margins = {};
+          ['top', 'bottom', 'left', 'right'].forEach((propName) => {
+            this.__margins[propName] = parseInt(computedStyle[propName], 10);
+          });
+        }
+        this.setAttribute('dir', computedStyle.direction);
 
-      console.warn('PositionMixin is not considered stable and might change any time');
+        this._updatePosition();
+        // Schedule another position update (to cover virtual keyboard opening for example)
+        requestAnimationFrame(() => this._updatePosition());
+      }
+    }
+
+    get __isRTL() {
+      return this.getAttribute('dir') === 'rtl';
     }
 
     __positionSettingsChanged() {
@@ -99,33 +124,55 @@ export const _PositionMixin = (superClass) =>
     }
 
     _updatePosition() {
-      if (!this.positionTarget) {
+      if (!this.positionTarget || !this.opened) {
         return;
       }
-      const computedStyle = getComputedStyle(this);
-      if (!this.__margins) {
-        this.__margins = {};
-        ['top', 'bottom', 'left', 'right'].forEach((propName) => {
-          this.__margins[propName] = parseInt(computedStyle[propName], 10);
-        });
-      }
-      const rtl = computedStyle.direction === 'rtl';
 
       const targetRect = this.positionTarget.getBoundingClientRect();
 
-      const horizontalProps = this.__calculateHorizontalPosition(targetRect, rtl);
-      const verticalProps = this.__calculateVerticalPosition(targetRect);
+      // Detect the desired alignment and update the layout accordingly
+      const shouldAlignStartVertically = this.__shouldAlignStartVertically(targetRect);
+      this.style.justifyContent = shouldAlignStartVertically ? 'flex-start' : 'flex-end';
 
-      const positionProps = Object.assign({}, horizontalProps, verticalProps);
-      this.__doSetPosition(positionProps, rtl);
-    }
+      const shouldAlignStartHorizontally = this.__shouldAlignStartHorizontally(targetRect, this.__isRTL);
+      const flexStart =
+        (!this.__isRTL && shouldAlignStartHorizontally) || (this.__isRTL && !shouldAlignStartHorizontally);
+      this.style.alignItems = flexStart ? 'flex-start' : 'flex-end';
 
-    __calculateHorizontalPosition(targetRect, rtl) {
-      const propNames = {
-        start: 'left',
-        end: 'right'
-      };
+      // Get the overlay rect after possible overlay alignment changes
+      const overlayRect = this.getBoundingClientRect();
+
+      // Obtain vertical positioning properties
+      const verticalProps = this.__calculatePositionInOneDimension(
+        targetRect,
+        overlayRect,
+        this.noVerticalOverlap,
+        PROP_NAMES_VERTICAL,
+        this,
+        shouldAlignStartVertically
+      );
+
+      // Obtain horizontal positioning properties
+      const horizontalProps = this.__calculatePositionInOneDimension(
+        targetRect,
+        overlayRect,
+        this.noHorizontalOverlap,
+        PROP_NAMES_HORIZONTAL,
+        this,
+        shouldAlignStartHorizontally
+      );
+
+      // Apply the positioning properties to the overlay
+      Object.assign(this.style, verticalProps, horizontalProps);
 
+      this.toggleAttribute('bottom-aligned', !shouldAlignStartVertically);
+      this.toggleAttribute('top-aligned', shouldAlignStartVertically);
+
+      this.toggleAttribute('end-aligned', !flexStart);
+      this.toggleAttribute('start-aligned', flexStart);
+    }
+
+    __shouldAlignStartHorizontally(targetRect, rtl) {
       // Using previous size to fix a case where window resize may cause the overlay to be squeezed
       // smaller than its current space before the fit-calculations.
       const contentWidth = Math.max(this.__oldContentWidth || 0, this.$.overlay.offsetWidth);
@@ -133,25 +180,19 @@ export const _PositionMixin = (superClass) =>
 
       const viewportWidth = Math.min(window.innerWidth, document.documentElement.clientWidth);
       const defaultAlignLeft = (!rtl && this.horizontalAlign === 'start') || (rtl && this.horizontalAlign === 'end');
-      const currentAlignLeft = !!this.style.left;
-      return PositionMixin.__calculatePositionInOneDimension(
+
+      return this.__shouldAlignStart(
         targetRect,
         contentWidth,
         viewportWidth,
         this.__margins,
         defaultAlignLeft,
-        currentAlignLeft,
         this.noHorizontalOverlap,
-        propNames
+        PROP_NAMES_HORIZONTAL
       );
     }
 
-    __calculateVerticalPosition(targetRect) {
-      const propNames = {
-        start: 'top',
-        end: 'bottom'
-      };
-
+    __shouldAlignStartVertically(targetRect) {
       // Using previous size to fix a case where window resize may cause the overlay to be squeezed
       // smaller than its current space before the fit-calculations.
       const contentHeight = Math.max(this.__oldContentHeight || 0, this.$.overlay.offsetHeight);
@@ -159,33 +200,19 @@ export const _PositionMixin = (superClass) =>
 
       const viewportHeight = Math.min(window.innerHeight, document.documentElement.clientHeight);
       const defaultAlignTop = this.verticalAlign === 'top';
-      const currentAlignTop = !!this.style.top;
-      return PositionMixin.__calculatePositionInOneDimension(
+
+      return this.__shouldAlignStart(
         targetRect,
         contentHeight,
         viewportHeight,
         this.__margins,
         defaultAlignTop,
-        currentAlignTop,
         this.noVerticalOverlap,
-        propNames
+        PROP_NAMES_VERTICAL
       );
     }
 
-    /**
-     * Returns an object with CSS position properties to set,
-     * e.g. { top: "100px", bottom: "" }
-     */
-    static __calculatePositionInOneDimension(
-      targetRect,
-      contentSize,
-      viewportSize,
-      margins,
-      defaultAlignStart,
-      currentAlignStart,
-      noOverlap,
-      propNames
-    ) {
+    __shouldAlignStart(targetRect, contentSize, viewportSize, margins, defaultAlignStart, noOverlap, propNames) {
       const spaceForStartAlignment =
         viewportSize - targetRect[noOverlap ? propNames.end : propNames.start] - margins[propNames.end];
       const spaceForEndAlignment = targetRect[noOverlap ? propNames.start : propNames.end] - margins[propNames.start];
@@ -196,28 +223,26 @@ export const _PositionMixin = (superClass) =>
       const shouldGoToDefaultSide =
         spaceForDefaultAlignment > spaceForOtherAlignment || spaceForDefaultAlignment > contentSize;
 
-      const shouldAlignStart = defaultAlignStart === shouldGoToDefaultSide;
+      return defaultAlignStart === shouldGoToDefaultSide;
+    }
 
+    /**
+     * Returns an object with CSS position properties to set,
+     * e.g. { top: "100px", bottom: "" }
+     */
+    __calculatePositionInOneDimension(targetRect, overlayRect, noOverlap, propNames, overlay, shouldAlignStart) {
       const cssPropNameToSet = shouldAlignStart ? propNames.start : propNames.end;
       const cssPropNameToClear = shouldAlignStart ? propNames.end : propNames.start;
 
-      const cssPropValueToSet =
-        (shouldAlignStart
-          ? targetRect[noOverlap ? propNames.end : propNames.start]
-          : viewportSize - targetRect[noOverlap ? propNames.start : propNames.end]) + 'px';
+      const currentValue = parseFloat(overlay.style[cssPropNameToSet] || getComputedStyle(overlay)[cssPropNameToSet]);
 
-      const props = {};
-      props[cssPropNameToSet] = cssPropValueToSet;
-      props[cssPropNameToClear] = '';
-      return props;
-    }
-
-    __doSetPosition(cssProps, rtl) {
-      Object.assign(this.style, cssProps);
-
-      const alignStart = (!rtl && cssProps.left) || (rtl && cssProps.right);
-      this.style.alignItems = alignStart ? 'flex-start' : 'flex-end';
+      const diff =
+        overlayRect[shouldAlignStart ? propNames.start : propNames.end] -
+        targetRect[noOverlap === shouldAlignStart ? propNames.end : propNames.start];
 
-      this.style.justifyContent = cssProps.top ? 'flex-start' : 'flex-end';
+      return {
+        [cssPropNameToSet]: currentValue + diff * (shouldAlignStart ? -1 : 1) + 'px',
+        [cssPropNameToClear]: ''
+      };
     }
   };

package/src/vaadin-overlay.d.ts

@@ -1,8 +1,23 @@
+/**
+ * @license
+ * Copyright (c) 2021 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import { DirMixin } from '@vaadin/component-base/src/dir-mixin.js';
 import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
 
-import { DirMixin } from '@vaadin/vaadin-element-mixin/vaadin-dir-mixin.js';
+export type OverlayRenderer = (root: HTMLElement, owner: HTMLElement, model?: object) => void;
+
+/**
+ * Fired when the `opened` property changes.
+ */
+export type OverlayOpenedChangedEvent = CustomEvent<{ value: boolean }>;
 
-import { OverlayEventMap, OverlayRenderer } from './interfaces';
+export interface OverlayElementEventMap {
+  'opened-changed': OverlayOpenedChangedEvent;
+}
+
+export type OverlayEventMap = HTMLElementEventMap & OverlayElementEventMap;
 
 /**
  * `<vaadin-overlay>` is a Web Component for creating overlays. The content of the overlay
@@ -209,13 +224,6 @@ declare class OverlayElement extends ThemableMixin(DirMixin(HTMLElement)) {
    */
   requestContentUpdate(): void;
 
-  /**
-   * Manually invoke existing renderer.
-   *
-   * @deprecated Since Vaadin 21, `render()` is deprecated. Please use `requestContentUpdate()` instead.
-   */
-  render(): void;
-
   _isFocused(element: Element | null): boolean;
 
   _focusedIndex(elements: Array<Element | null> | null): number;

package/src/vaadin-overlay.js

@@ -7,8 +7,8 @@ import { PolymerElement, html } from '@polymer/polymer/polymer-element.js';
 import { templatize } from '@polymer/polymer/lib/utils/templatize.js';
 import { afterNextRender } from '@polymer/polymer/lib/utils/render-status.js';
 import { FlattenedNodesObserver } from '@polymer/polymer/lib/utils/flattened-nodes-observer.js';
+import { DirMixin } from '@vaadin/component-base/src/dir-mixin.js';
 import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
-import { DirMixin } from '@vaadin/vaadin-element-mixin/vaadin-dir-mixin.js';
 import { FocusablesHelper } from './vaadin-focusables-helper.js';
 
 /**
@@ -457,17 +457,6 @@ class OverlayElement extends ThemableMixin(DirMixin(PolymerElement)) {
     }
   }
 
-  /**
-   * Manually invoke existing renderer.
-   *
-   * @deprecated Since Vaadin 21, `render()` is deprecated. Please use `requestContentUpdate()` instead.
-   */
-  render() {
-    console.warn('WARNING: Since Vaadin 21, render() is deprecated. Please use requestContentUpdate() instead.');
-
-    this.requestContentUpdate();
-  }
-
   /** @private */
   _ironOverlayCanceled(event) {
     event.preventDefault();

package/theme/lumo/vaadin-overlay-styles.js

@@ -1,4 +1,4 @@
-import { registerStyles, css } from '@vaadin/vaadin-themable-mixin/register-styles.js';
-import '@vaadin/vaadin-lumo-styles/mixins/overlay.js';
+import { registerStyles } from '@vaadin/vaadin-themable-mixin/register-styles.js';
+import { overlay } from '@vaadin/vaadin-lumo-styles/mixins/overlay.js';
 
-registerStyles('vaadin-overlay', css``, { include: ['lumo-overlay'], moduleId: 'lumo-vaadin-overlay' });
+registerStyles('vaadin-overlay', overlay, { moduleId: 'lumo-vaadin-overlay' });

package/theme/material/vaadin-overlay-styles.js

@@ -1,4 +1,4 @@
-import { registerStyles, css } from '@vaadin/vaadin-themable-mixin/register-styles.js';
-import '@vaadin/vaadin-material-styles/mixins/overlay.js';
+import { registerStyles } from '@vaadin/vaadin-themable-mixin/register-styles.js';
+import { overlay } from '@vaadin/vaadin-material-styles/mixins/overlay.js';
 
-registerStyles('vaadin-overlay', css``, { include: ['material-overlay'], moduleId: 'material-vaadin-overlay' });
+registerStyles('vaadin-overlay', overlay, { moduleId: 'material-vaadin-overlay' });

package/vaadin-overlay.d.ts

@@ -1,2 +1 @@
 export * from './src/vaadin-overlay.js';
-export * from './src/interfaces';

package/src/interfaces.d.ts

@@ -1,12 +0,0 @@
-export type OverlayRenderer = (root: HTMLElement, owner: HTMLElement, model?: object) => void;
-
-/**
- * Fired when the `opened` property changes.
- */
-export type OverlayOpenedChangedEvent = CustomEvent<{ value: boolean }>;
-
-export interface OverlayElementEventMap {
-  'opened-changed': OverlayOpenedChangedEvent;
-}
-
-export type OverlayEventMap = HTMLElementEventMap & OverlayElementEventMap;