docs: remove mentions of overlay in dialog and confirm-dialog (#9986)

web-padawan · web-flow · commit 9492abb2e073 · 2025-08-15T13:15:39.000+03:00
diff --git a/packages/confirm-dialog/src/vaadin-confirm-dialog-mixin.d.ts b/packages/confirm-dialog/src/vaadin-confirm-dialog-mixin.d.ts
@@ -36,7 +36,7 @@ export declare function ConfirmDialogMixin<T extends Constructor<HTMLElement>>(
 
 export declare class ConfirmDialogMixinClass {
   /**
-   * Sets the `aria-describedby` attribute of the overlay element.
+   * Sets the `aria-describedby` attribute of the dialog.
    *
    * By default, the text contents of all elements inside the message area
    * are combined into the `aria-description` attribute. However, there are
@@ -49,7 +49,7 @@ export declare class ConfirmDialogMixinClass {
   accessibleDescriptionRef: string | null | undefined;
 
   /**
-   * True if the overlay is currently displayed.
+   * True if the dialog is visible and available for interaction.
    */
   opened: boolean;
 
diff --git a/packages/confirm-dialog/src/vaadin-confirm-dialog-mixin.js b/packages/confirm-dialog/src/vaadin-confirm-dialog-mixin.js
@@ -16,7 +16,7 @@ export const ConfirmDialogMixin = (superClass) =>
     static get properties() {
       return {
         /**
-         * Sets the `aria-describedby` attribute of the overlay element.
+         * Sets the `aria-describedby` attribute of the dialog.
          *
          * By default, the text contents of all elements inside the message area
          * are combined into the `aria-description` attribute. However, there are
@@ -30,7 +30,7 @@ export const ConfirmDialogMixin = (superClass) =>
         },
 
         /**
-         * True if the overlay is currently displayed.
+         * True if the dialog is visible and available for interaction.
          * @type {boolean}
          */
         opened: {
diff --git a/packages/dialog/src/vaadin-dialog-base-mixin.d.ts b/packages/dialog/src/vaadin-dialog-base-mixin.d.ts
@@ -11,7 +11,7 @@ export declare function DialogBaseMixin<T extends Constructor<HTMLElement>>(
 
 export declare class DialogBaseMixinClass {
   /**
-   * True if the overlay is currently displayed.
+   * True if the dialog is visible and available for interaction.
    */
   opened: boolean;
 
@@ -41,22 +41,20 @@ export declare class DialogBaseMixinClass {
   overlayRole: string;
 
   /**
-   * Set the distance of the overlay from the top of its container.
+   * Set the distance of the dialog from the top of the viewport.
    * If a unitless number is provided, pixels are assumed.
    *
-   * Note that the overlay top edge may not be the same as the viewport
-   * top edge (e.g. the Lumo theme defines some spacing to prevent the
-   * overlay from stretching all the way to the top of the viewport).
+   * Note that the dialog uses an internal container that has some
+   * additional spacing, which can be overridden by the theme.
    */
   top: string;
 
   /**
-   * Set the distance of the overlay from the left of its container.
+   * Set the distance of the dialog from the left of the viewport.
    * If a unitless number is provided, pixels are assumed.
    *
-   * Note that the overlay left edge may not be the same as the viewport
-   * left edge (e.g. the Lumo theme defines some spacing to prevent the
-   * overlay from stretching all the way to the left of the viewport).
+   * Note that the dialog uses an internal container that has some
+   * additional spacing, which can be overridden by the theme.
    */
   left: string;
 }
diff --git a/packages/dialog/src/vaadin-dialog-base-mixin.js b/packages/dialog/src/vaadin-dialog-base-mixin.js
@@ -12,7 +12,7 @@ export const DialogBaseMixin = (superClass) =>
     static get properties() {
       return {
         /**
-         * True if the overlay is currently displayed.
+         * True if the dialog is visible and available for interaction.
          * @type {boolean}
          */
         opened: {
@@ -53,24 +53,22 @@ export const DialogBaseMixin = (superClass) =>
         },
 
         /**
-         * Set the distance of the overlay from the top of its container.
+         * Set the distance of the dialog from the top of the viewport.
          * If a unitless number is provided, pixels are assumed.
          *
-         * Note that the overlay top edge may not be the same as the viewport
-         * top edge (e.g. the Lumo theme defines some spacing to prevent the
-         * overlay from stretching all the way to the top of the viewport).
+         * Note that the dialog uses an internal container that has some
+         * additional spacing, which can be overridden by the theme.
          */
         top: {
           type: String,
         },
 
         /**
-         * Set the distance of the overlay from the left of its container.
+         * Set the distance of the dialog from the left of the viewport.
          * If a unitless number is provided, pixels are assumed.
          *
-         * Note that the overlay left edge may not be the same as the viewport
-         * left edge (e.g. the Lumo theme defines some spacing to prevent the
-         * overlay from stretching all the way to the left of the viewport).
+         * Note that the dialog uses an internal container that has some
+         * additional spacing, which can be overridden by the theme.
          */
         left: {
           type: String,
diff --git a/packages/dialog/src/vaadin-dialog-renderer-mixin.d.ts b/packages/dialog/src/vaadin-dialog-renderer-mixin.d.ts
@@ -27,7 +27,7 @@ export declare class DialogRendererMixinClass {
    * and the elements created by the renderer will be placed next to
    * each other, with the title coming first.
    *
-   * When `headerTitle` is set, the attribute `has-title` is added to the overlay element.
+   * When `headerTitle` is set, the attribute `has-title` is set on the dialog.
    * @attr {string} header-title
    */
   headerTitle: string | null | undefined;
@@ -43,7 +43,7 @@ export declare class DialogRendererMixinClass {
    * and the elements created by the renderer will be placed next to
    * each other, with the title coming first.
    *
-   * When `headerRenderer` is set, the attribute `has-header` is added to the overlay element.
+   * When `headerRenderer` is set, the attribute `has-header` is set on the dialog.
    */
   headerRenderer: DialogRenderer | null | undefined;
 
@@ -54,7 +54,7 @@ export declare class DialogRendererMixinClass {
    * - `root` The root container DOM element. Append your content to it.
    * - `dialog` The reference to the `<vaadin-dialog>` element.
    *
-   * When `footerRenderer` is set, the attribute `has-footer` is added to the overlay element.
+   * When `footerRenderer` is set, the attribute `has-footer` is set on the dialog.
    */
   footerRenderer: DialogRenderer | null | undefined;
 
diff --git a/packages/dialog/src/vaadin-dialog-renderer-mixin.js b/packages/dialog/src/vaadin-dialog-renderer-mixin.js
@@ -30,7 +30,7 @@ export const DialogRendererMixin = (superClass) =>
          * and the elements created by the renderer will be placed next to
          * each other, with the title coming first.
          *
-         * When `headerTitle` is set, the attribute `has-title` is added to the overlay element.
+         * When `headerTitle` is set, the attribute `has-title` is set on the dialog.
          * @attr {string} header-title
          */
         headerTitle: String,
@@ -46,7 +46,7 @@ export const DialogRendererMixin = (superClass) =>
          * and the elements created by the renderer will be placed next to
          * each other, with the title coming first.
          *
-         * When `headerRenderer` is set, the attribute `has-header` is added to the overlay element.
+         * When `headerRenderer` is set, the attribute `has-header` is set on the dialog.
          * @type {DialogRenderer | undefined}
          */
         headerRenderer: {
@@ -60,7 +60,7 @@ export const DialogRendererMixin = (superClass) =>
          * - `root` The root container DOM element. Append your content to it.
          * - `dialog` The reference to the `<vaadin-dialog>` element.
          *
-         * When `footerRenderer` is set, the attribute `has-footer` is added to the overlay element.
+         * When `footerRenderer` is set, the attribute `has-footer` is set on the dialog.
          * @type {DialogRenderer | undefined}
          */
         footerRenderer: {
diff --git a/packages/dialog/src/vaadin-dialog-size-mixin.d.ts b/packages/dialog/src/vaadin-dialog-size-mixin.d.ts
@@ -11,13 +11,13 @@ export declare function DialogSizeMixin<T extends Constructor<HTMLElement>>(
 
 export declare class DialogSizeMixinClass {
   /**
-   * Set the width of the overlay.
+   * Set the width of the dialog.
    * If a unitless number is provided, pixels are assumed.
    */
   width: string | null;
 
   /**
-   * Set the height of the overlay.
+   * Set the height of the dialog.
    * If a unitless number is provided, pixels are assumed.
    */
   height: string | null;
diff --git a/packages/dialog/src/vaadin-dialog-size-mixin.js b/packages/dialog/src/vaadin-dialog-size-mixin.js
@@ -12,15 +12,15 @@ export const DialogSizeMixin = (superClass) =>
     static get properties() {
       return {
         /**
-         * Set the width of the overlay.
+         * Set the width of the dialog.
          * If a unitless number is provided, pixels are assumed.
          */
         width: {
           type: String,
         },
 
         /**
-         * Set the height of the overlay.
+         * Set the height of the dialog.
          * If a unitless number is provided, pixels are assumed.
          */
         height: {
