@vaadin/dialog 23.1.0-alpha4 → 23.1.0-beta3

package/lit.d.ts

@@ -0,0 +1 @@
+export * from './src/lit/renderer-directives.js';

package/lit.js

@@ -0,0 +1 @@
+export * from './src/lit/renderer-directives.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/dialog",
-  "version": "23.1.0-alpha4",
+  "version": "23.1.0-beta3",
   "publishConfig": {
     "access": "public"
   },
@@ -22,6 +22,8 @@
   "files": [
     "src",
     "theme",
+    "lit.js",
+    "lit.d.ts",
     "vaadin-*.d.ts",
     "vaadin-*.js"
   ],
@@ -35,18 +37,19 @@
   "dependencies": {
     "@open-wc/dedupe-mixin": "^1.3.0",
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/component-base": "23.1.0-alpha4",
-    "@vaadin/vaadin-lumo-styles": "23.1.0-alpha4",
-    "@vaadin/vaadin-material-styles": "23.1.0-alpha4",
-    "@vaadin/vaadin-overlay": "23.1.0-alpha4",
-    "@vaadin/vaadin-themable-mixin": "23.1.0-alpha4"
+    "@vaadin/component-base": "23.1.0-beta3",
+    "@vaadin/lit-renderer": "23.1.0-beta3",
+    "@vaadin/vaadin-lumo-styles": "23.1.0-beta3",
+    "@vaadin/vaadin-material-styles": "23.1.0-beta3",
+    "@vaadin/vaadin-overlay": "23.1.0-beta3",
+    "@vaadin/vaadin-themable-mixin": "23.1.0-beta3"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
-    "@vaadin/polymer-legacy-adapter": "23.1.0-alpha4",
+    "@vaadin/polymer-legacy-adapter": "23.1.0-beta3",
     "@vaadin/testing-helpers": "^0.3.2",
-    "@vaadin/text-area": "23.1.0-alpha4",
+    "@vaadin/text-area": "23.1.0-beta3",
     "sinon": "^13.0.2"
   },
-  "gitHead": "aacdb7fe09811894751f0378ff7fb66071892c71"
+  "gitHead": "c787ceb8a312f88631c6d429ff320d5f89b1b838"
 }

package/src/lit/renderer-directives.d.ts

@@ -0,0 +1,139 @@
+/**
+ * @license
+ * Copyright (c) 2017 - 2022 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+/* eslint-disable max-classes-per-file */
+import { TemplateResult } from 'lit';
+import { DirectiveResult } from 'lit/directive.js';
+import { LitRendererDirective } from '@vaadin/lit-renderer';
+import { Dialog } from '../vaadin-dialog.js';
+
+export type DialogLitRenderer = (dialog: Dialog) => TemplateResult;
+
+declare abstract class AbstractDialogRendererDirective extends LitRendererDirective<Dialog, DialogLitRenderer> {
+  /**
+   * A property to that the renderer callback will be assigned.
+   */
+  abstract rendererProperty: 'renderer' | 'headerRenderer' | 'footerRenderer';
+
+  /**
+   * Adds the renderer callback to the dialog.
+   */
+  addRenderer(): void;
+
+  /**
+   * Runs the renderer callback on the dialog.
+   */
+  runRenderer(): void;
+
+  /**
+   * Removes the renderer callback from the dialog.
+   */
+  removeRenderer(): void;
+}
+
+export class DialogRendererDirective extends AbstractDialogRendererDirective {
+  rendererProperty: 'renderer';
+}
+
+export class DialogHeaderRendererDirective extends AbstractDialogRendererDirective {
+  rendererProperty: 'headerRenderer';
+}
+
+export class DialogFooterRendererDirective extends AbstractDialogRendererDirective {
+  rendererProperty: 'footerRenderer';
+}
+
+/**
+ * A Lit directive for populating the content of the dialog.
+ *
+ * The directive accepts a renderer callback returning a Lit template and assigns it to the dialog
+ * via the `renderer` property. The renderer is called to populate the content once when assigned
+ * and whenever a single dependency or an array of dependencies changes.
+ * It is not guaranteed that the renderer will be called immediately (synchronously) in both cases.
+ *
+ * Dependencies can be a single value or an array of values.
+ * Values are checked against previous values with strict equality (`===`),
+ * so the check won't detect nested property changes inside objects or arrays.
+ * When dependencies are provided as an array, each item is checked against the previous value
+ * at the same index with strict equality. Nested arrays are also checked only by strict
+ * equality.
+ *
+ * Example of usage:
+ * ```js
+ * `<vaadin-dialog
+ *   ${dialogRenderer((dialog) => html`...`)}
+ * ></vaadin-dialog>`
+ * ```
+ *
+ * @param renderer the renderer callback that returns a Lit template.
+ * @param dependencies a single dependency or an array of dependencies
+ *                     which trigger a re-render when changed.
+ */
+export declare function dialogRenderer(
+  renderer: DialogLitRenderer,
+  dependencies?: unknown,
+): DirectiveResult<typeof DialogRendererDirective>;
+
+/**
+ * A Lit directive for populating the content of the dialog header.
+ *
+ * The directive accepts a renderer callback returning a Lit template and assigns it to the dialog
+ * via the `headerRenderer` property. The renderer is called to populate the content once
+ * when assigned and whenever a single dependency or an array of dependencies changes.
+ * It is not guaranteed that the renderer will be called immediately (synchronously) in both cases.
+ *
+ * Dependencies can be a single value or an array of values.
+ * Values are checked against previous values with strict equality (`===`),
+ * so the check won't detect nested property changes inside objects or arrays.
+ * When dependencies are provided as an array, each item is checked against the previous value
+ * at the same index with strict equality. Nested arrays are also checked only by strict
+ * equality.
+ *
+ * Example of usage:
+ * ```js
+ * `<vaadin-dialog
+ *   ${dialogHeaderRenderer((dialog) => html`...`)}
+ * ></vaadin-dialog>`
+ * ```
+ *
+ * @param renderer the renderer callback.
+ * @param dependencies a single dependency or an array of dependencies
+ *                     which trigger a re-render when changed.
+ */
+export declare function dialogHeaderRenderer(
+  renderer: DialogLitRenderer,
+  dependencies?: unknown,
+): DirectiveResult<typeof DialogHeaderRendererDirective>;
+
+/**
+ * A Lit directive for populating the content of the dialog footer.
+ *
+ * The directive accepts a renderer callback returning a Lit template and assigns it to the dialog
+ * via the `footerRenderer` property. The renderer is called to populate the content once when assigned
+ * and whenever a single dependency or an array of dependencies changes.
+ * It is not guaranteed that the renderer will be called immediately (synchronously) in both cases.
+ *
+ * Dependencies can be a single value or an array of values.
+ * Values are checked against previous values with strict equality (`===`),
+ * so the check won't detect nested property changes inside objects or arrays.
+ * When dependencies are provided as an array, each item is checked against the previous value
+ * at the same index with strict equality. Nested arrays are also checked only by strict
+ * equality.
+ *
+ * Example of usage:
+ * ```js
+ * `<vaadin-dialog
+ *   ${dialogFooterRenderer((dialog) => html`...`)}
+ * ></vaadin-dialog>`
+ * ```
+ *
+ * @param renderer the renderer callback.
+ * @param dependencies a single dependency or an array of dependencies
+ *                     which trigger a re-render when changed.
+ */
+export declare function dialogFooterRenderer(
+  renderer: DialogLitRenderer,
+  dependencies?: unknown,
+): DirectiveResult<typeof DialogFooterRendererDirective>;

package/src/lit/renderer-directives.js

@@ -0,0 +1,147 @@
+/**
+ * @license
+ * Copyright (c) 2017 - 2022 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+/* eslint-disable max-classes-per-file */
+import { directive } from 'lit/directive.js';
+import { microTask } from '@vaadin/component-base/src/async.js';
+import { Debouncer } from '@vaadin/component-base/src/debounce.js';
+import { LitRendererDirective } from '@vaadin/lit-renderer';
+
+const CONTENT_UPDATE_DEBOUNCER = Symbol('contentUpdateDebouncer');
+
+class AbstractDialogRendererDirective extends LitRendererDirective {
+  /**
+   * A property to that the renderer callback will be assigned.
+   *
+   * @abstract
+   */
+  rendererProperty;
+
+  /**
+   * Adds the renderer callback to the dialog.
+   */
+  addRenderer() {
+    this.element[this.rendererProperty] = (root, dialog) => {
+      this.renderRenderer(root, dialog);
+    };
+  }
+
+  /**
+   * Runs the renderer callback on the dialog.
+   */
+  runRenderer() {
+    this.element[CONTENT_UPDATE_DEBOUNCER] = Debouncer.debounce(
+      this.element[CONTENT_UPDATE_DEBOUNCER],
+      microTask,
+      () => {
+        this.element.requestContentUpdate();
+      },
+    );
+  }
+
+  /**
+   * Removes the renderer callback from the dialog.
+   */
+  removeRenderer() {
+    this.element[this.rendererProperty] = null;
+    delete this.element[CONTENT_UPDATE_DEBOUNCER];
+  }
+}
+
+export class DialogRendererDirective extends AbstractDialogRendererDirective {
+  rendererProperty = 'renderer';
+}
+
+export class DialogHeaderRendererDirective extends AbstractDialogRendererDirective {
+  rendererProperty = 'headerRenderer';
+}
+
+export class DialogFooterRendererDirective extends AbstractDialogRendererDirective {
+  rendererProperty = 'footerRenderer';
+}
+
+/**
+ * A Lit directive for populating the content of the dialog.
+ *
+ * The directive accepts a renderer callback returning a Lit template and assigns it to the dialog
+ * via the `renderer` property. The renderer is called to populate the content once when assigned
+ * and whenever a single dependency or an array of dependencies changes.
+ * It is not guaranteed that the renderer will be called immediately (synchronously) in both cases.
+ *
+ * Dependencies can be a single value or an array of values.
+ * Values are checked against previous values with strict equality (`===`),
+ * so the check won't detect nested property changes inside objects or arrays.
+ * When dependencies are provided as an array, each item is checked against the previous value
+ * at the same index with strict equality. Nested arrays are also checked only by strict
+ * equality.
+ *
+ * Example of usage:
+ * ```js
+ * `<vaadin-dialog
+ *   ${dialogRenderer((dialog) => html`...`)}
+ * ></vaadin-dialog>`
+ * ```
+ *
+ * @param renderer the renderer callback that returns a Lit template.
+ * @param dependencies a single dependency or an array of dependencies
+ *                     which trigger a re-render when changed.
+ */
+export const dialogRenderer = directive(DialogRendererDirective);
+
+/**
+ * A Lit directive for populating the content of the dialog header.
+ *
+ * The directive accepts a renderer callback returning a Lit template and assigns it to the dialog
+ * via the `headerRenderer` property. The renderer is called to populate the content once when assigned
+ * and whenever a single dependency or an array of dependencies changes.
+ * It is not guaranteed that the renderer will be called immediately (synchronously) in both cases.
+ *
+ * Dependencies can be a single value or an array of values.
+ * Values are checked against previous values with strict equality (`===`),
+ * so the check won't detect nested property changes inside objects or arrays.
+ * When dependencies are provided as an array, each item is checked against the previous value
+ * at the same index with strict equality. Nested arrays are also checked only by strict
+ * equality.
+ *
+ * Example of usage:
+ * ```js
+ * `<vaadin-dialog
+ *   ${dialogHeaderRenderer((dialog) => html`...`)}
+ * ></vaadin-dialog>`
+ * ```
+ *
+ * @param renderer the renderer callback.
+ * @param dependencies a single dependency or an array of dependencies
+ *                     which trigger a re-render when changed.
+ */
+export const dialogHeaderRenderer = directive(DialogHeaderRendererDirective);
+
+/**
+ * A Lit directive for populating the content of the dialog footer.
+ *
+ * The directive accepts a renderer callback returning a Lit template and assigns it to the dialog
+ * via the `footerRenderer` property. The renderer is called to populate the content once when assigned
+ * and whenever a single dependency or an array of dependencies changes.
+ * It is not guaranteed that the renderer will be called immediately (synchronously) in both cases.
+ *
+ * Dependencies can be a single value or an array of values.
+ * Values are checked against previous values with strict equality (`===`),
+ * so the check won't detect nested property changes inside objects or arrays.
+ * When dependencies are provided as an array, each item is checked against the previous value
+ * at the same index with strict equality. Nested arrays are also checked only by strict
+ * equality.
+ *
+ * Example of usage:
+ * ```js
+ * `<vaadin-dialog
+ *   ${dialogFooterRenderer((dialog) => html`...`)}
+ * ></vaadin-dialog>`
+ * ```
+ *
+ * @param renderer the renderer callback.
+ * @param dependencies a single dependency or an array of dependencies
+ *                     which trigger a re-render when changed.
+ */
+export const dialogFooterRenderer = directive(DialogFooterRendererDirective);

package/src/vaadin-dialog.js

@@ -99,7 +99,7 @@ export class DialogOverlay extends OverlayElement {
       memoizedTemplate = super.template.cloneNode(true);
       const contentPart = memoizedTemplate.content.querySelector('[part="content"]');
       const overlayPart = memoizedTemplate.content.querySelector('[part="overlay"]');
-      const resizerContainer = document.createElement('div');
+      const resizerContainer = document.createElement('section');
       resizerContainer.id = 'resizerContainer';
       resizerContainer.classList.add('resizer-container');
       resizerContainer.appendChild(contentPart);
@@ -161,9 +161,6 @@ export class DialogOverlay extends OverlayElement {
   ready() {
     super.ready();
 
-    const uniqueId = (DialogOverlay._uniqueId = 1 + DialogOverlay._uniqueId || 0);
-    this._titleId = `${this.constructor.is}-title-${uniqueId}`;
-
     // Update overflow attribute on resize
     this.__resizeObserver = new ResizeObserver(() => {
       this.__updateOverflow();
@@ -264,18 +261,14 @@ export class DialogOverlay extends OverlayElement {
     if (this.headerTitle) {
       if (!this.headerTitleElement) {
         this.headerTitleElement = document.createElement('span');
-        this.headerTitleElement.id = this._titleId;
         this.headerTitleElement.setAttribute('slot', 'title');
         this.headerTitleElement.classList.add('draggable');
-
-        this.setAttribute('aria-labelledby', this._titleId);
       }
       this.appendChild(this.headerTitleElement);
       this.headerTitleElement.textContent = this.headerTitle;
     } else if (this.headerTitleElement) {
       this.headerTitleElement.remove();
       this.headerTitleElement = null;
-      this.removeAttribute('aria-labelledby');
     }
   }
 
@@ -594,7 +587,7 @@ class Dialog extends ThemePropertyMixin(ElementMixin(DialogDraggableMixin(Dialog
   static get observers() {
     return [
       '_openedChanged(opened)',
-      '_ariaLabelChanged(ariaLabel)',
+      '_ariaLabelChanged(ariaLabel, headerTitle)',
       '_rendererChanged(renderer, headerRenderer, footerRenderer)',
     ];
   }
@@ -648,9 +641,9 @@ class Dialog extends ThemePropertyMixin(ElementMixin(DialogDraggableMixin(Dialog
   }
 
   /** @private */
-  _ariaLabelChanged(ariaLabel) {
-    if (ariaLabel) {
-      this.$.overlay.setAttribute('aria-label', ariaLabel);
+  _ariaLabelChanged(ariaLabel, headerTitle) {
+    if (ariaLabel || headerTitle) {
+      this.$.overlay.setAttribute('aria-label', ariaLabel || headerTitle);
     } else {
       this.$.overlay.removeAttribute('aria-label');
     }