@vaadin/popover 24.5.0-alpha6 → 24.5.0-alpha8

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/popover",
-  "version": "24.5.0-alpha6",
+  "version": "24.5.0-alpha8",
   "publishConfig": {
     "access": "public"
   },
@@ -20,6 +20,8 @@
   "module": "vaadin-popover.js",
   "type": "module",
   "files": [
+    "lit.d.ts",
+    "lit.js",
     "src",
     "theme",
     "vaadin-*.d.ts",
@@ -35,22 +37,23 @@
   ],
   "dependencies": {
     "@open-wc/dedupe-mixin": "^1.3.0",
-    "@vaadin/a11y-base": "24.5.0-alpha6",
-    "@vaadin/component-base": "24.5.0-alpha6",
-    "@vaadin/overlay": "24.5.0-alpha6",
-    "@vaadin/vaadin-lumo-styles": "24.5.0-alpha6",
-    "@vaadin/vaadin-material-styles": "24.5.0-alpha6",
-    "@vaadin/vaadin-themable-mixin": "24.5.0-alpha6",
+    "@vaadin/a11y-base": "24.5.0-alpha8",
+    "@vaadin/component-base": "24.5.0-alpha8",
+    "@vaadin/lit-renderer": "24.5.0-alpha8",
+    "@vaadin/overlay": "24.5.0-alpha8",
+    "@vaadin/vaadin-lumo-styles": "24.5.0-alpha8",
+    "@vaadin/vaadin-material-styles": "24.5.0-alpha8",
+    "@vaadin/vaadin-themable-mixin": "24.5.0-alpha8",
     "lit": "^3.0.0"
   },
   "devDependencies": {
-    "@esm-bundle/chai": "^4.3.4",
-    "@vaadin/testing-helpers": "^0.6.0",
-    "sinon": "^13.0.2"
+    "@vaadin/chai-plugins": "24.5.0-alpha8",
+    "@vaadin/testing-helpers": "^1.0.0",
+    "sinon": "^18.0.0"
   },
   "web-types": [
     "web-types.json",
     "web-types.lit.json"
   ],
-  "gitHead": "c5f541dbe961a994730d4c60472ae957bf6b4c12"
+  "gitHead": "1e227aaa55df3f5dae3d477b9afb5fce4f5ece33"
 }

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

@@ -0,0 +1,58 @@
+/**
+ * @license
+ * Copyright (c) 2024 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import type { DirectiveResult } from 'lit/directive.js';
+import { LitRendererDirective, type LitRendererResult } from '@vaadin/lit-renderer';
+import type { Popover } from '../vaadin-popover.js';
+
+export type PopoverLitRenderer = (popover: Popover) => LitRendererResult;
+
+export class PopoverRendererDirective extends LitRendererDirective<Popover, PopoverLitRenderer> {
+  /**
+   * Adds the renderer callback to the popover.
+   */
+  addRenderer(): void;
+
+  /**
+   * Runs the renderer callback on the popover.
+   */
+  runRenderer(): void;
+
+  /**
+   * Removes the renderer callback from the popover.
+   */
+  removeRenderer(): void;
+}
+
+/**
+ * A Lit directive for populating the content of the `<vaadin-popover-overlay>` element.
+ *
+ * The directive accepts a renderer callback returning a Lit template and assigns it to the popover
+ * via the `renderer` property. The renderer is called once to populate the content 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-popover
+ *   ${popoverRenderer((popover) => html`...`)}
+ * ></vaadin-popover>`
+ * ```
+ *
+ * @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 popoverRenderer(
+  renderer: PopoverLitRenderer,
+  dependencies?: unknown,
+): DirectiveResult<typeof PopoverRendererDirective>;

package/src/lit/renderer-directives.js

@@ -0,0 +1,60 @@
+/**
+ * @license
+ * Copyright (c) 2024 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import { directive } from 'lit/directive.js';
+import { LitRendererDirective } from '@vaadin/lit-renderer';
+
+export class PopoverRendererDirective extends LitRendererDirective {
+  /**
+   * Adds the renderer callback to the popover.
+   */
+  addRenderer() {
+    this.element.renderer = (root, popover) => {
+      this.renderRenderer(root, popover);
+    };
+  }
+
+  /**
+   * Runs the renderer callback on the popover.
+   */
+  runRenderer() {
+    this.element.requestContentUpdate();
+  }
+
+  /**
+   * Removes the renderer callback from the popover.
+   */
+  removeRenderer() {
+    this.element.renderer = null;
+  }
+}
+
+/**
+ * A Lit directive for populating the content of the `<vaadin-popover-overlay>` element.
+ *
+ * The directive accepts a renderer callback returning a Lit template and assigns it to the popover
+ * via the `renderer` property. The renderer is called once to populate the content 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-popover
+ *   ${popoverRenderer((popover) => html`...`)}
+ * ></vaadin-popover>`
+ * ```
+ *
+ * @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 popoverRenderer = directive(PopoverRendererDirective);

package/src/vaadin-popover-overlay.js

@@ -60,10 +60,8 @@ class PopoverOverlay extends PopoverOverlayMixin(DirMixin(ThemableMixin(PolylitM
         [part='overlay']::before {
           position: absolute;
           content: '';
-          top: calc(var(--vaadin-popover-offset-top, 0) * -1);
-          bottom: calc(var(--vaadin-popover-offset-bottom, 0) * -1);
-          inset-inline-start: calc(var(--vaadin-popover-offset-start, 0) * -1);
-          inset-inline-end: calc(var(--vaadin-popover-offset-end, 0) * -1);
+          inset-block: calc(var(--vaadin-popover-offset-top, 0) * -1) calc(var(--vaadin-popover-offset-bottom, 0) * -1);
+          inset-inline: calc(var(--vaadin-popover-offset-start, 0) * -1) calc(var(--vaadin-popover-offset-end, 0) * -1);
           z-index: -1;
           pointer-events: auto;
         }

package/src/vaadin-popover.d.ts

@@ -91,6 +91,12 @@ declare class Popover extends PopoverPositionMixin(
    */
   accessibleNameRef: string | null | undefined;
 
+  /**
+   * When true, the popover content automatically receives focus after
+   * it is opened. Modal popovers use this behavior by default.
+   */
+  autofocus: boolean;
+
   /**
    * Height to be set on the overlay content.
    *

package/src/vaadin-popover.js

@@ -6,7 +6,12 @@
 import './vaadin-popover-overlay.js';
 import { html, LitElement } from 'lit';
 import { ifDefined } from 'lit/directives/if-defined.js';
-import { isKeyboardActive } from '@vaadin/a11y-base/src/focus-utils.js';
+import {
+  getDeepActiveElement,
+  getFocusableElements,
+  isElementFocused,
+  isKeyboardActive,
+} from '@vaadin/a11y-base/src/focus-utils.js';
 import { defineCustomElement } from '@vaadin/component-base/src/define.js';
 import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
 import { OverlayClassMixin } from '@vaadin/component-base/src/overlay-class-mixin.js';
@@ -205,6 +210,14 @@ class Popover extends PopoverPositionMixin(
         type: String,
       },
 
+      /**
+       * When true, the popover content automatically receives focus after
+       * it is opened. Modal popovers use this behavior by default.
+       */
+      autofocus: {
+        type: Boolean,
+      },
+
       /**
        * Height to be set on the overlay content.
        *
@@ -380,7 +393,6 @@ class Popover extends PopoverPositionMixin(
     this.__onGlobalClick = this.__onGlobalClick.bind(this);
     this.__onGlobalKeyDown = this.__onGlobalKeyDown.bind(this);
     this.__onTargetClick = this.__onTargetClick.bind(this);
-    this.__onTargetKeydown = this.__onTargetKeydown.bind(this);
     this.__onTargetFocusIn = this.__onTargetFocusIn.bind(this);
     this.__onTargetFocusOut = this.__onTargetFocusOut.bind(this);
     this.__onTargetMouseEnter = this.__onTargetMouseEnter.bind(this);
@@ -421,6 +433,7 @@ class Popover extends PopoverPositionMixin(
         .restoreFocusNode="${this.target}"
         @vaadin-overlay-escape-press="${this.__onEscapePress}"
         @vaadin-overlay-outside-click="${this.__onOutsideClick}"
+        @vaadin-overlay-open="${this.__onOverlayOpened}"
         @vaadin-overlay-closed="${this.__onOverlayClosed}"
       ></vaadin-popover-overlay>
     `;
@@ -470,7 +483,6 @@ class Popover extends PopoverPositionMixin(
    */
   _addTargetListeners(target) {
     target.addEventListener('click', this.__onTargetClick);
-    target.addEventListener('keydown', this.__onTargetKeydown);
     target.addEventListener('mouseenter', this.__onTargetMouseEnter);
     target.addEventListener('mouseleave', this.__onTargetMouseLeave);
     target.addEventListener('focusin', this.__onTargetFocusIn);
@@ -484,7 +496,6 @@ class Popover extends PopoverPositionMixin(
    */
   _removeTargetListeners(target) {
     target.removeEventListener('click', this.__onTargetClick);
-    target.removeEventListener('keydown', this.__onTargetKeydown);
     target.removeEventListener('mouseenter', this.__onTargetMouseEnter);
     target.removeEventListener('mouseleave', this.__onTargetMouseLeave);
     target.removeEventListener('focusin', this.__onTargetFocusIn);
@@ -565,9 +576,13 @@ class Popover extends PopoverPositionMixin(
    * @private
    */
   __onGlobalKeyDown(event) {
+    // Modal popover uses overlay logic for Esc key and focus trap.
+    if (this.modal) {
+      return;
+    }
+
     if (
       event.key === 'Escape' &&
-      !this.modal &&
       !this.noCloseOnEsc &&
       this.opened &&
       !this.__isManual &&
@@ -577,16 +592,84 @@ class Popover extends PopoverPositionMixin(
       event.stopPropagation();
       this._openedStateController.close(true);
     }
+
+    // Include popover content in the Tab order after the target.
+    if (event.key === 'Tab') {
+      if (event.shiftKey) {
+        this.__onGlobalShiftTab(event);
+      } else {
+        this.__onGlobalTab(event);
+      }
+    }
+  }
+
+  /** @private */
+  __onGlobalTab(event) {
+    const overlayPart = this._overlayElement.$.overlay;
+
+    // Move focus to the popover content on target element Tab
+    if (this.target && isElementFocused(this.target)) {
+      event.preventDefault();
+      overlayPart.focus();
+      return;
+    }
+
+    // Move focus to the next element after target on content Tab
+    const lastFocusable = this.__getLastFocusable(overlayPart);
+    if (lastFocusable && isElementFocused(lastFocusable)) {
+      const focusable = this.__getNextBodyFocusable(this.target);
+      if (focusable && focusable !== overlayPart) {
+        event.preventDefault();
+        focusable.focus();
+        return;
+      }
+    }
+
+    // Prevent focusing the popover content on previous element Tab
+    const activeElement = getDeepActiveElement();
+    const nextFocusable = this.__getNextBodyFocusable(activeElement);
+    if (nextFocusable === overlayPart && lastFocusable) {
+      // Move focus to the last overlay focusable and do NOT prevent keydown
+      // to move focus outside the popover content (e.g. to the URL bar).
+      lastFocusable.focus();
+    }
   }
 
   /** @private */
-  __onTargetKeydown(event) {
-    // Prevent restoring focus after target blur on Tab key
-    if (event.key === 'Tab' && this.__shouldRestoreFocus) {
-      this.__shouldRestoreFocus = false;
+  __onGlobalShiftTab(event) {
+    const overlayPart = this._overlayElement.$.overlay;
+
+    // Move focus back to the target on overlay content Shift + Tab
+    if (this.target && isElementFocused(overlayPart)) {
+      event.preventDefault();
+      this.target.focus();
+      return;
+    }
+
+    // Move focus back to the popover on next element Shift + Tab
+    const nextFocusable = this.__getNextBodyFocusable(this.target);
+    if (nextFocusable && isElementFocused(nextFocusable)) {
+      const lastFocusable = this.__getLastFocusable(overlayPart);
+      if (lastFocusable) {
+        event.preventDefault();
+        lastFocusable.focus();
+      }
     }
   }
 
+  /** @private */
+  __getNextBodyFocusable(target) {
+    const focusables = getFocusableElements(document.body);
+    const idx = focusables.findIndex((el) => el === target);
+    return focusables[idx + 1];
+  }
+
+  /** @private */
+  __getLastFocusable(container) {
+    const focusables = getFocusableElements(container);
+    return focusables.pop();
+  }
+
   /** @private */
   __onTargetFocusIn() {
     this.__focusInside = true;
@@ -708,6 +791,13 @@ class Popover extends PopoverPositionMixin(
     this.opened = event.detail.value;
   }
 
+  /** @private */
+  __onOverlayOpened() {
+    if (this.autofocus && !this.modal) {
+      this._overlayElement.$.overlay.focus();
+    }
+  }
+
   /** @private */
   __onOverlayClosed() {
     // Reset restoring focus state after a timeout to make sure focus was restored

package/web-types.json

@@ -1,14 +1,14 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/popover",
-  "version": "24.5.0-alpha6",
+  "version": "24.5.0-alpha8",
   "description-markup": "markdown",
   "contributions": {
     "html": {
       "elements": [
         {
           "name": "vaadin-popover",
-          "description": "`<vaadin-popover>` is a Web Component for creating overlays\nthat are positioned next to specified DOM element (target).\n\nUnlike `<vaadin-tooltip>`, the popover supports rich content\nthat can be provided by using `renderer` function.\n\n### Styling\n\n`<vaadin-popover>` uses `<vaadin-popover-overlay>` internal\nthemable component as the actual visible overlay.\n\nSee [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/24.5.0-alpha6/#/elements/vaadin-overlay) documentation\nfor `<vaadin-popover-overlay>` parts.\n\nIn addition to `<vaadin-overlay>` parts, the following parts are available for styling:\n\nPart name        | Description\n-----------------|-------------------------------------------\n`arrow`          | Optional arrow pointing to the target when using `theme=\"arrow\"`\n\nThe following state attributes are available for styling:\n\nAttribute        | Description\n-----------------|----------------------------------------\n`position`       | Reflects the `position` property value.\n\nNote: the `theme` attribute value set on `<vaadin-popover>` is\npropagated to the internal `<vaadin-popover-overlay>` component.\n\n### Custom CSS Properties\n\nThe following custom CSS properties are available on the `<vaadin-popover>` element:\n\nCustom CSS property              | Description\n---------------------------------|-------------\n`--vaadin-popover-offset-top`    | Used as an offset when the popover is aligned vertically below the target\n`--vaadin-popover-offset-bottom` | Used as an offset when the popover is aligned vertically above the target\n`--vaadin-popover-offset-start`  | Used as an offset when the popover is aligned horizontally after the target\n`--vaadin-popover-offset-end`    | Used as an offset when the popover is aligned horizontally before the target\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
+          "description": "`<vaadin-popover>` is a Web Component for creating overlays\nthat are positioned next to specified DOM element (target).\n\nUnlike `<vaadin-tooltip>`, the popover supports rich content\nthat can be provided by using `renderer` function.\n\n### Styling\n\n`<vaadin-popover>` uses `<vaadin-popover-overlay>` internal\nthemable component as the actual visible overlay.\n\nSee [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/24.5.0-alpha8/#/elements/vaadin-overlay) documentation\nfor `<vaadin-popover-overlay>` parts.\n\nIn addition to `<vaadin-overlay>` parts, the following parts are available for styling:\n\nPart name        | Description\n-----------------|-------------------------------------------\n`arrow`          | Optional arrow pointing to the target when using `theme=\"arrow\"`\n\nThe following state attributes are available for styling:\n\nAttribute        | Description\n-----------------|----------------------------------------\n`position`       | Reflects the `position` property value.\n\nNote: the `theme` attribute value set on `<vaadin-popover>` is\npropagated to the internal `<vaadin-popover-overlay>` component.\n\n### Custom CSS Properties\n\nThe following custom CSS properties are available on the `<vaadin-popover>` element:\n\nCustom CSS property              | Description\n---------------------------------|-------------\n`--vaadin-popover-offset-top`    | Used as an offset when the popover is aligned vertically below the target\n`--vaadin-popover-offset-bottom` | Used as an offset when the popover is aligned vertically above the target\n`--vaadin-popover-offset-start`  | Used as an offset when the popover is aligned horizontally after the target\n`--vaadin-popover-offset-end`    | Used as an offset when the popover is aligned horizontally before the target\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
           "attributes": [
             {
               "name": "position",
@@ -54,6 +54,17 @@
                 ]
               }
             },
+            {
+              "name": "autofocus",
+              "description": "When true, the popover content automatically receives focus after\nit is opened. Modal popovers use this behavior by default.",
+              "value": {
+                "type": [
+                  "boolean",
+                  "null",
+                  "undefined"
+                ]
+              }
+            },
             {
               "name": "content-height",
               "description": "Height to be set on the overlay content.",
@@ -244,6 +255,17 @@
                   ]
                 }
               },
+              {
+                "name": "autofocus",
+                "description": "When true, the popover content automatically receives focus after\nit is opened. Modal popovers use this behavior by default.",
+                "value": {
+                  "type": [
+                    "boolean",
+                    "null",
+                    "undefined"
+                  ]
+                }
+              },
               {
                 "name": "contentHeight",
                 "description": "Height to be set on the overlay content.",

package/web-types.lit.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/popover",
-  "version": "24.5.0-alpha6",
+  "version": "24.5.0-alpha8",
   "description-markup": "markdown",
   "framework": "lit",
   "framework-config": {
@@ -16,9 +16,16 @@
       "elements": [
         {
           "name": "vaadin-popover",
-          "description": "`<vaadin-popover>` is a Web Component for creating overlays\nthat are positioned next to specified DOM element (target).\n\nUnlike `<vaadin-tooltip>`, the popover supports rich content\nthat can be provided by using `renderer` function.\n\n### Styling\n\n`<vaadin-popover>` uses `<vaadin-popover-overlay>` internal\nthemable component as the actual visible overlay.\n\nSee [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/24.5.0-alpha6/#/elements/vaadin-overlay) documentation\nfor `<vaadin-popover-overlay>` parts.\n\nIn addition to `<vaadin-overlay>` parts, the following parts are available for styling:\n\nPart name        | Description\n-----------------|-------------------------------------------\n`arrow`          | Optional arrow pointing to the target when using `theme=\"arrow\"`\n\nThe following state attributes are available for styling:\n\nAttribute        | Description\n-----------------|----------------------------------------\n`position`       | Reflects the `position` property value.\n\nNote: the `theme` attribute value set on `<vaadin-popover>` is\npropagated to the internal `<vaadin-popover-overlay>` component.\n\n### Custom CSS Properties\n\nThe following custom CSS properties are available on the `<vaadin-popover>` element:\n\nCustom CSS property              | Description\n---------------------------------|-------------\n`--vaadin-popover-offset-top`    | Used as an offset when the popover is aligned vertically below the target\n`--vaadin-popover-offset-bottom` | Used as an offset when the popover is aligned vertically above the target\n`--vaadin-popover-offset-start`  | Used as an offset when the popover is aligned horizontally after the target\n`--vaadin-popover-offset-end`    | Used as an offset when the popover is aligned horizontally before the target\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
+          "description": "`<vaadin-popover>` is a Web Component for creating overlays\nthat are positioned next to specified DOM element (target).\n\nUnlike `<vaadin-tooltip>`, the popover supports rich content\nthat can be provided by using `renderer` function.\n\n### Styling\n\n`<vaadin-popover>` uses `<vaadin-popover-overlay>` internal\nthemable component as the actual visible overlay.\n\nSee [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/24.5.0-alpha8/#/elements/vaadin-overlay) documentation\nfor `<vaadin-popover-overlay>` parts.\n\nIn addition to `<vaadin-overlay>` parts, the following parts are available for styling:\n\nPart name        | Description\n-----------------|-------------------------------------------\n`arrow`          | Optional arrow pointing to the target when using `theme=\"arrow\"`\n\nThe following state attributes are available for styling:\n\nAttribute        | Description\n-----------------|----------------------------------------\n`position`       | Reflects the `position` property value.\n\nNote: the `theme` attribute value set on `<vaadin-popover>` is\npropagated to the internal `<vaadin-popover-overlay>` component.\n\n### Custom CSS Properties\n\nThe following custom CSS properties are available on the `<vaadin-popover>` element:\n\nCustom CSS property              | Description\n---------------------------------|-------------\n`--vaadin-popover-offset-top`    | Used as an offset when the popover is aligned vertically below the target\n`--vaadin-popover-offset-bottom` | Used as an offset when the popover is aligned vertically above the target\n`--vaadin-popover-offset-start`  | Used as an offset when the popover is aligned horizontally after the target\n`--vaadin-popover-offset-end`    | Used as an offset when the popover is aligned horizontally before the target\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
           "extension": true,
           "attributes": [
+            {
+              "name": "?autofocus",
+              "description": "When true, the popover content automatically receives focus after\nit is opened. Modal popovers use this behavior by default.",
+              "value": {
+                "kind": "expression"
+              }
+            },
             {
               "name": "?opened",
               "description": "True if the popover overlay is opened, false otherwise.",