@vaadin/dialog 25.1.0-alpha9 → 25.1.0-beta1

package/custom-elements.json

@@ -26,6 +26,16 @@
           "description": "",
           "name": "DialogBaseMixin",
           "members": [
+            {
+              "kind": "field",
+              "name": "keepInViewport",
+              "privacy": "public",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Set to true to prevent the dialog from moving outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible, for example\nwhen dragging the dialog or when the viewport is resized. Note that the\ndialog will also adjust any programmatically configured size and position\nso that it stays within the viewport.",
+              "attribute": "keep-in-viewport"
+            },
             {
               "kind": "field",
               "name": "left",
@@ -117,6 +127,14 @@
             }
           ],
           "attributes": [
+            {
+              "name": "keep-in-viewport",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Set to true to prevent the dialog from moving outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible, for example\nwhen dragging the dialog or when the viewport is resized. Note that the\ndialog will also adjust any programmatically configured size and position\nso that it stays within the viewport.",
+              "fieldName": "keepInViewport"
+            },
             {
               "name": "left",
               "type": {
@@ -219,16 +237,6 @@
               },
               "description": "Set to true to enable repositioning the dialog by clicking and dragging.\n\nBy default, only the overlay area can be used to drag the element. But,\na child element can be marked as a draggable area by adding a\n\"`draggable`\" class to it, this will by default make all of its children draggable also.\nIf you want a child element to be draggable\nbut still have its children non-draggable (by default), mark it with\n\"`draggable-leaf-only`\" class name.",
               "attribute": "draggable"
-            },
-            {
-              "kind": "field",
-              "name": "keepInViewport",
-              "privacy": "public",
-              "type": {
-                "text": "boolean"
-              },
-              "description": "Set to true to prevent dragging the dialog outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible during dragging.\nThe dialog may still become partially hidden when the viewport is resized.",
-              "attribute": "keep-in-viewport"
             }
           ],
           "events": [
@@ -253,14 +261,6 @@
               },
               "description": "Set to true to enable repositioning the dialog by clicking and dragging.\n\nBy default, only the overlay area can be used to drag the element. But,\na child element can be marked as a draggable area by adding a\n\"`draggable`\" class to it, this will by default make all of its children draggable also.\nIf you want a child element to be draggable\nbut still have its children non-draggable (by default), mark it with\n\"`draggable-leaf-only`\" class name.",
               "fieldName": "draggable"
-            },
-            {
-              "name": "keep-in-viewport",
-              "type": {
-                "text": "boolean"
-              },
-              "description": "Set to true to prevent dragging the dialog outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible during dragging.\nThe dialog may still become partially hidden when the viewport is resized.",
-              "fieldName": "keepInViewport"
             }
           ],
           "parameters": [
@@ -383,6 +383,16 @@
                 "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
               }
             },
+            {
+              "kind": "field",
+              "name": "keepInViewport",
+              "privacy": "public",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Whether to keep the overlay within the viewport.",
+              "attribute": "keep-in-viewport"
+            },
             {
               "kind": "field",
               "name": "model",
@@ -495,20 +505,14 @@
               "name": "setBounds",
               "parameters": [
                 {
-                  "name": "bounds",
-                  "type": {
-                    "text": "!OverlayBoundsParam"
-                  }
+                  "name": "bounds"
                 },
                 {
                   "name": "absolute",
-                  "default": "true",
-                  "type": {
-                    "text": "boolean"
-                  }
+                  "default": "true"
                 }
               ],
-              "description": "Updates the coordinates of the overlay.",
+              "description": "Override method from OverlayMixin to adjust the position of the overlay if `keepInViewport` is true.",
               "inheritedFrom": {
                 "name": "OverlayMixin",
                 "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
@@ -562,6 +566,14 @@
                 "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
               }
             },
+            {
+              "name": "keep-in-viewport",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Whether to keep the overlay within the viewport.",
+              "fieldName": "keepInViewport"
+            },
             {
               "name": "modeless",
               "type": {
@@ -811,6 +823,20 @@
                 "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
               }
             },
+            {
+              "kind": "field",
+              "name": "keepInViewport",
+              "privacy": "public",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Whether to keep the overlay within the viewport.",
+              "attribute": "keep-in-viewport",
+              "inheritedFrom": {
+                "name": "DialogOverlayMixin",
+                "module": "src/vaadin-dialog-overlay-mixin.js"
+              }
+            },
             {
               "kind": "field",
               "name": "model",
@@ -923,20 +949,14 @@
               "name": "setBounds",
               "parameters": [
                 {
-                  "name": "bounds",
-                  "type": {
-                    "text": "!OverlayBoundsParam"
-                  }
+                  "name": "bounds"
                 },
                 {
                   "name": "absolute",
-                  "default": "true",
-                  "type": {
-                    "text": "boolean"
-                  }
+                  "default": "true"
                 }
               ],
-              "description": "Updates the coordinates of the overlay.",
+              "description": "Override method from OverlayMixin to adjust the position of the overlay if `keepInViewport` is true.",
               "inheritedFrom": {
                 "name": "OverlayMixin",
                 "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
@@ -1022,6 +1042,18 @@
                 "package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
               }
             },
+            {
+              "name": "keep-in-viewport",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Whether to keep the overlay within the viewport.",
+              "fieldName": "keepInViewport",
+              "inheritedFrom": {
+                "name": "DialogOverlayMixin",
+                "module": "src/vaadin-dialog-overlay-mixin.js"
+              }
+            },
             {
               "name": "modeless",
               "type": {
@@ -1516,11 +1548,11 @@
               "type": {
                 "text": "boolean"
               },
-              "description": "Set to true to prevent dragging the dialog outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible during dragging.\nThe dialog may still become partially hidden when the viewport is resized.",
+              "description": "Set to true to prevent the dialog from moving outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible, for example\nwhen dragging the dialog or when the viewport is resized. Note that the\ndialog will also adjust any programmatically configured size and position\nso that it stays within the viewport.",
               "attribute": "keep-in-viewport",
               "inheritedFrom": {
-                "name": "DialogDraggableMixin",
-                "module": "src/vaadin-dialog-draggable-mixin.js"
+                "name": "DialogBaseMixin",
+                "module": "src/vaadin-dialog-base-mixin.js"
               }
             },
             {
@@ -1855,11 +1887,11 @@
               "type": {
                 "text": "boolean"
               },
-              "description": "Set to true to prevent dragging the dialog outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible during dragging.\nThe dialog may still become partially hidden when the viewport is resized.",
+              "description": "Set to true to prevent the dialog from moving outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible, for example\nwhen dragging the dialog or when the viewport is resized. Note that the\ndialog will also adjust any programmatically configured size and position\nso that it stays within the viewport.",
               "fieldName": "keepInViewport",
               "inheritedFrom": {
-                "name": "DialogDraggableMixin",
-                "module": "src/vaadin-dialog-draggable-mixin.js"
+                "name": "DialogBaseMixin",
+                "module": "src/vaadin-dialog-base-mixin.js"
               }
             },
             {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/dialog",
-  "version": "25.1.0-alpha9",
+  "version": "25.1.0-beta1",
   "publishConfig": {
     "access": "public"
   },
@@ -37,19 +37,19 @@
   ],
   "dependencies": {
     "@open-wc/dedupe-mixin": "^1.3.0",
-    "@vaadin/component-base": "25.1.0-alpha9",
-    "@vaadin/lit-renderer": "25.1.0-alpha9",
-    "@vaadin/overlay": "25.1.0-alpha9",
-    "@vaadin/vaadin-themable-mixin": "25.1.0-alpha9",
+    "@vaadin/component-base": "25.1.0-beta1",
+    "@vaadin/lit-renderer": "25.1.0-beta1",
+    "@vaadin/overlay": "25.1.0-beta1",
+    "@vaadin/vaadin-themable-mixin": "25.1.0-beta1",
     "lit": "^3.0.0"
   },
   "devDependencies": {
-    "@vaadin/a11y-base": "25.1.0-alpha9",
-    "@vaadin/aura": "25.1.0-alpha9",
-    "@vaadin/chai-plugins": "25.1.0-alpha9",
-    "@vaadin/test-runner-commands": "25.1.0-alpha9",
+    "@vaadin/a11y-base": "25.1.0-beta1",
+    "@vaadin/aura": "25.1.0-beta1",
+    "@vaadin/chai-plugins": "25.1.0-beta1",
+    "@vaadin/test-runner-commands": "25.1.0-beta1",
     "@vaadin/testing-helpers": "^2.0.0",
-    "@vaadin/vaadin-lumo-styles": "25.1.0-alpha9",
+    "@vaadin/vaadin-lumo-styles": "25.1.0-beta1",
     "sinon": "^21.0.0"
   },
   "customElements": "custom-elements.json",
@@ -57,5 +57,5 @@
     "web-types.json",
     "web-types.lit.json"
   ],
-  "gitHead": "ef432311376ba3dac4233cb23d393a49a425e0a4"
+  "gitHead": "0ccf77c385fc6a92ac2a6344ce8804b94956226d"
 }

package/src/styles/vaadin-dialog-overlay-base-styles.js

@@ -124,6 +124,9 @@ const dialogResizableOverlay = css`
 
   :host([has-bounds-set]) [part='overlay'] {
     min-width: 0;
+  }
+
+  :host([has-bounds-set]:not([keep-in-viewport])) [part='overlay'] {
     max-width: none;
     max-height: none;
   }
@@ -138,7 +141,7 @@ const dialogResizableOverlay = css`
   }
 
   [part='header'],
-  :host(:not([has-header])) [part='content'] {
+  :host(:not([has-title], [has-header])) [part='content'] {
     border-top-left-radius: inherit;
     border-top-right-radius: inherit;
   }

package/src/vaadin-dialog-base-mixin.d.ts

@@ -63,4 +63,14 @@ export declare class DialogBaseMixinClass {
    * additional spacing, which can be overridden by the theme.
    */
   left: string;
+
+  /**
+   * Set to true to prevent the dialog from moving outside the viewport bounds.
+   * When enabled, all four edges of the dialog will remain visible, for example
+   * when dragging the dialog or when the viewport is resized. Note that the
+   * dialog will also adjust any programmatically configured size and position
+   * so that it stays within the viewport.
+   * @attr {boolean} keep-in-viewport
+   */
+  keepInViewport: boolean;
 }

package/src/vaadin-dialog-base-mixin.js

@@ -93,6 +93,21 @@ export const DialogBaseMixin = (superClass) =>
         overlayRole: {
           type: String,
         },
+
+        /**
+         * Set to true to prevent the dialog from moving outside the viewport bounds.
+         * When enabled, all four edges of the dialog will remain visible, for example
+         * when dragging the dialog or when the viewport is resized. Note that the
+         * dialog will also adjust any programmatically configured size and position
+         * so that it stays within the viewport.
+         * @attr {boolean} keep-in-viewport
+         * @type {boolean}
+         */
+        keepInViewport: {
+          type: Boolean,
+          value: false,
+          reflectToAttribute: true,
+        },
       };
     }
 

package/src/vaadin-dialog-draggable-mixin.d.ts

@@ -21,12 +21,4 @@ export declare class DialogDraggableMixinClass {
    * "`draggable-leaf-only`" class name.
    */
   draggable: boolean;
-
-  /**
-   * Set to true to prevent dragging the dialog outside the viewport bounds.
-   * When enabled, all four edges of the dialog will remain visible during dragging.
-   * The dialog may still become partially hidden when the viewport is resized.
-   * @attr {boolean} keep-in-viewport
-   */
-  keepInViewport: boolean;
 }

package/src/vaadin-dialog-draggable-mixin.js

@@ -31,19 +31,6 @@ export const DialogDraggableMixin = (superClass) =>
           reflectToAttribute: true,
         },
 
-        /**
-         * Set to true to prevent dragging the dialog outside the viewport bounds.
-         * When enabled, all four edges of the dialog will remain visible during dragging.
-         * The dialog may still become partially hidden when the viewport is resized.
-         * @attr {boolean} keep-in-viewport
-         * @type {boolean}
-         */
-        keepInViewport: {
-          type: Boolean,
-          value: false,
-          reflectToAttribute: true,
-        },
-
         /** @private */
         _touchDevice: {
           type: Boolean,
@@ -132,16 +119,14 @@ export const DialogDraggableMixin = (superClass) =>
         let left = this._originalBounds.left + (event.pageX - this._originalMouseCoords.left);
 
         if (this.keepInViewport) {
+          // Constrain the dialog position so that it stays within the overlay host bounds,
+          // respecting the `--vaadin-overlay-viewport-inset` (offset from the viewport edges).
           const { width, height } = this._originalBounds;
-          // Get the overlay container's position to account for its offset from the viewport
-          const containerBounds = this.$.overlay.getBoundingClientRect();
-          // Calculate bounds so the dialog's visual edges stay within the viewport
-          const minLeft = -containerBounds.left;
-          const maxLeft = window.innerWidth - containerBounds.left - width;
-          const minTop = -containerBounds.top;
-          const maxTop = window.innerHeight - containerBounds.top - height;
-          left = Math.max(minLeft, Math.min(left, maxLeft));
-          top = Math.max(minTop, Math.min(top, maxTop));
+          const overlayHostBounds = this.$.overlay.getBoundingClientRect();
+          const maxLeft = overlayHostBounds.right - overlayHostBounds.left - width;
+          const maxTop = overlayHostBounds.bottom - overlayHostBounds.top - height;
+          left = Math.max(0, Math.min(left, maxLeft));
+          top = Math.max(0, Math.min(top, maxTop));
         }
 
         this.top = top;

package/src/vaadin-dialog-overlay-mixin.d.ts

@@ -25,6 +25,11 @@ export declare class DialogOverlayMixinClass {
    */
   headerTitle: string;
 
+  /**
+   * Whether to keep the overlay within the viewport.
+   */
+  keepInViewport: boolean;
+
   /**
    * Custom function for rendering the dialog header.
    */

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

@@ -35,6 +35,14 @@ export const DialogOverlayMixin = (superClass) =>
         footerRenderer: {
           type: Object,
         },
+
+        /**
+         * Whether to keep the overlay within the viewport.
+         */
+        keepInViewport: {
+          type: Boolean,
+          reflectToAttribute: true,
+        },
       };
     }
 
@@ -77,6 +85,7 @@ export const DialogOverlayMixin = (superClass) =>
       // Update overflow attribute on resize
       this.__resizeObserver = new ResizeObserver(() => {
         requestAnimationFrame(() => {
+          this.__adjustPosition();
           this.__updateOverflow();
         });
       });
@@ -104,6 +113,20 @@ export const DialogOverlayMixin = (superClass) =>
         setOverlayStateAttribute(this, 'has-footer', currentNodes.length > 0);
         this.__updateOverflow();
       });
+
+      this.__handleWindowResize = this.__handleWindowResize.bind(this);
+    }
+
+    updated(props) {
+      super.updated(props);
+
+      if (props.has('opened') || props.has('keepInViewport')) {
+        if (this.opened && this.keepInViewport) {
+          window.addEventListener('resize', this.__handleWindowResize);
+        } else {
+          window.removeEventListener('resize', this.__handleWindowResize);
+        }
+      }
     }
 
     /** @private */
@@ -233,6 +256,15 @@ export const DialogOverlayMixin = (superClass) =>
       return { top, left, width, height };
     }
 
+    /**
+     * Override method from OverlayMixin to adjust the position of the overlay if `keepInViewport` is true.
+     * @override
+     */
+    setBounds(bounds, absolute = true) {
+      super.setBounds(bounds, absolute);
+      this.__adjustPosition();
+    }
+
     /** @private */
     __updateOverflow() {
       let overflow = '';
@@ -254,4 +286,45 @@ export const DialogOverlayMixin = (superClass) =>
         setOverlayStateAttribute(this, 'overflow', null);
       }
     }
+
+    /** @private */
+    __handleWindowResize() {
+      this.__adjustPosition();
+    }
+
+    /**
+     * Adjusts the position of the overlay to keep it within the viewport if `keepInViewport` is true.
+     * @private
+     */
+    __adjustPosition() {
+      if (!this.opened || !this.keepInViewport) {
+        return;
+      }
+
+      // Centered dialogs do not use absolute positioning and automatically adjust their position / size to fit the viewport
+      const style = getComputedStyle(this.$.overlay);
+      if (style.position !== 'absolute') {
+        return;
+      }
+
+      const overlayHostBounds = this.getBoundingClientRect();
+      const bounds = this.getBounds();
+      // Prefer dimensions from getComputedStyle, as bounding rect is affected
+      // by scale transform applied by opening animation in Lumo
+      const width = parseFloat(style.width) || bounds.width;
+      const height = parseFloat(style.height) || bounds.height;
+
+      const maxLeft = overlayHostBounds.right - overlayHostBounds.left - width;
+      const maxTop = overlayHostBounds.bottom - overlayHostBounds.top - height;
+
+      if (bounds.left > maxLeft || bounds.top > maxTop) {
+        const left = Math.max(0, Math.min(bounds.left, maxLeft));
+        const top = Math.max(0, Math.min(bounds.top, maxTop));
+
+        Object.assign(this.$.overlay.style, {
+          left: `${left}px`,
+          top: `${top}px`,
+        });
+      }
+    }
   };

package/src/vaadin-dialog.js

@@ -148,6 +148,7 @@ class Dialog extends DialogSizeMixin(
         .renderer="${this.renderer}"
         .headerRenderer="${this.headerRenderer}"
         .footerRenderer="${this.footerRenderer}"
+        .keepInViewport="${this.keepInViewport}"
         @opened-changed="${this._onOverlayOpened}"
         @mousedown="${this._bringOverlayToFront}"
         @touchstart="${this._bringOverlayToFront}"

package/web-types.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/dialog",
-  "version": "25.1.0-alpha9",
+  "version": "25.1.0-beta1",
   "description-markup": "markdown",
   "contributions": {
     "html": {
@@ -43,7 +43,7 @@
             },
             {
               "name": "keep-in-viewport",
-              "description": "Set to true to prevent dragging the dialog outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible during dragging.\nThe dialog may still become partially hidden when the viewport is resized.",
+              "description": "Set to true to prevent the dialog from moving outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible, for example\nwhen dragging the dialog or when the viewport is resized. Note that the\ndialog will also adjust any programmatically configured size and position\nso that it stays within the viewport.",
               "value": {
                 "type": [
                   "boolean"
@@ -215,7 +215,7 @@
               },
               {
                 "name": "keepInViewport",
-                "description": "Set to true to prevent dragging the dialog outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible during dragging.\nThe dialog may still become partially hidden when the viewport is resized.",
+                "description": "Set to true to prevent the dialog from moving outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible, for example\nwhen dragging the dialog or when the viewport is resized. Note that the\ndialog will also adjust any programmatically configured size and position\nso that it stays within the viewport.",
                 "value": {
                   "type": [
                     "boolean"

package/web-types.lit.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/dialog",
-  "version": "25.1.0-alpha9",
+  "version": "25.1.0-beta1",
   "description-markup": "markdown",
   "framework": "lit",
   "framework-config": {
@@ -28,7 +28,7 @@
             },
             {
               "name": "?keepInViewport",
-              "description": "Set to true to prevent dragging the dialog outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible during dragging.\nThe dialog may still become partially hidden when the viewport is resized.",
+              "description": "Set to true to prevent the dialog from moving outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible, for example\nwhen dragging the dialog or when the viewport is resized. Note that the\ndialog will also adjust any programmatically configured size and position\nso that it stays within the viewport.",
               "value": {
                 "kind": "expression"
               }