@vaadin/context-menu 24.0.0-beta1 → 24.0.0-beta3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/context-menu",
-  "version": "24.0.0-beta1",
+  "version": "24.0.0-beta3",
   "publishConfig": {
     "access": "public"
   },
@@ -39,14 +39,14 @@
   "dependencies": {
     "@open-wc/dedupe-mixin": "^1.3.0",
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/component-base": "24.0.0-beta1",
-    "@vaadin/item": "24.0.0-beta1",
-    "@vaadin/list-box": "24.0.0-beta1",
-    "@vaadin/lit-renderer": "24.0.0-beta1",
-    "@vaadin/overlay": "24.0.0-beta1",
-    "@vaadin/vaadin-lumo-styles": "24.0.0-beta1",
-    "@vaadin/vaadin-material-styles": "24.0.0-beta1",
-    "@vaadin/vaadin-themable-mixin": "24.0.0-beta1"
+    "@vaadin/component-base": "24.0.0-beta3",
+    "@vaadin/item": "24.0.0-beta3",
+    "@vaadin/list-box": "24.0.0-beta3",
+    "@vaadin/lit-renderer": "24.0.0-beta3",
+    "@vaadin/overlay": "24.0.0-beta3",
+    "@vaadin/vaadin-lumo-styles": "24.0.0-beta3",
+    "@vaadin/vaadin-material-styles": "24.0.0-beta3",
+    "@vaadin/vaadin-themable-mixin": "24.0.0-beta3"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
@@ -58,5 +58,5 @@
     "web-types.json",
     "web-types.lit.json"
   ],
-  "gitHead": "c5b48921a62482746df8e46994b37e1490fec27e"
+  "gitHead": "4daeac63327393aacd9cfaa5abeb031ea86b14a5"
 }

package/src/vaadin-context-menu.d.ts

@@ -267,6 +267,11 @@ declare class ContextMenu extends OverlayClassMixin(ElementMixin(ThemePropertyMi
    */
   renderer: ContextMenuRenderer | null | undefined;
 
+  /**
+   * When true, the menu overlay is modeless.
+   */
+  protected _modeless: boolean;
+
   /**
    * Requests an update for the content of the menu overlay.
    * While performing the update, it invokes the renderer passed in the `renderer` property.

package/src/vaadin-context-menu.js

@@ -225,12 +225,12 @@ class ContextMenu extends OverlayClassMixin(
         id="overlay"
         on-opened-changed="_onOverlayOpened"
         on-vaadin-overlay-open="_onVaadinOverlayOpen"
+        modeless="[[_modeless]]"
         with-backdrop="[[_phone]]"
         phone$="[[_phone]]"
         model="[[_context]]"
         theme$="[[_theme]]"
-      >
-      </vaadin-context-menu-overlay>
+      ></vaadin-context-menu-overlay>
     `;
   }
 
@@ -309,6 +309,14 @@ class ContextMenu extends OverlayClassMixin(
         type: Function,
       },
 
+      /**
+       * When true, the menu overlay is modeless.
+       * @protected
+       */
+      _modeless: {
+        type: Boolean,
+      },
+
       /** @private */
       _context: Object,
 

package/src/vaadin-contextmenu-items-mixin.js

@@ -6,7 +6,6 @@
 import './vaadin-context-menu-item.js';
 import './vaadin-context-menu-list-box.js';
 import { isTouch } from '@vaadin/component-base/src/browser-utils.js';
-import { Item } from '@vaadin/item/src/vaadin-item.js';
 
 /**
  * @polymerMixin
@@ -159,55 +158,216 @@ export const ItemsMixin = (superClass) =>
     }
 
     /**
-     * @param {!HTMLElement} root
-     * @param {!ContextMenu} menu
-     * @param {!ContextMenuRendererContext} context
-     * @protected
+     * @param {!ContextMenuItem} item
+     * @return {HTMLElement}
+     * @private
      */
-    __itemsRenderer(root, menu, context) {
-      this.__initMenu(root, menu);
+    __createComponent(item) {
+      let component;
 
-      const subMenu = root.querySelector(this.constructor.is);
-      subMenu.closeOn = menu.closeOn;
+      if (item.component instanceof HTMLElement) {
+        component = item.component;
+      } else {
+        component = document.createElement(item.component || `${this._tagNamePrefix}-item`);
+      }
 
-      const listBox = root.querySelector(`${this._tagNamePrefix}-list-box`);
+      // Support menu-bar / context-menu item
+      if (component._hasVaadinItemMixin) {
+        component.setAttribute('role', 'menuitem');
+      }
 
-      listBox.innerHTML = '';
+      if (component.localName === 'hr') {
+        component.setAttribute('role', 'separator');
+      } else {
+        // Accept not `menuitem` elements e.g. `<button>`
+        component.setAttribute('aria-haspopup', 'false');
+      }
 
-      const items = Array.from(context.detail.children || menu.items);
+      this._setMenuItemTheme(component, item, this._theme);
 
-      items.forEach((item) => {
-        let component;
-        if (item.component instanceof HTMLElement) {
-          component = item.component;
-        } else {
-          component = document.createElement(item.component || `${this._tagNamePrefix}-item`);
+      component._item = item;
+
+      if (item.text) {
+        component.textContent = item.text;
+      }
+
+      this.__toggleMenuComponentAttribute(component, 'menu-item-checked', item.checked);
+      this.__toggleMenuComponentAttribute(component, 'disabled', item.disabled);
+
+      if (item.children && item.children.length) {
+        this.__updateExpanded(component, false);
+        component.setAttribute('aria-haspopup', 'true');
+      }
+
+      return component;
+    }
+
+    /** @private */
+    __initListBox() {
+      const listBox = document.createElement(`${this._tagNamePrefix}-list-box`);
+
+      if (this._theme) {
+        listBox.setAttribute('theme', this._theme);
+      }
+
+      listBox.addEventListener('selected-changed', (event) => {
+        const { value } = event.detail;
+        if (typeof value === 'number') {
+          const item = listBox.items[value]._item;
+          if (!item.children) {
+            this.dispatchEvent(new CustomEvent('item-selected', { detail: { value: item } }));
+          }
+          listBox.selected = null;
         }
+      });
+
+      return listBox;
+    }
 
-        if (component instanceof Item) {
-          component.setAttribute('role', 'menuitem');
-        } else if (component.localName === 'hr') {
-          component.setAttribute('role', 'separator');
+    /** @private */
+    __initOverlay() {
+      const overlay = this.$.overlay;
+
+      overlay.$.backdrop.addEventListener('click', () => {
+        this.close();
+      });
+
+      // Open a submenu on click event when a touch device is used.
+      // On desktop, a submenu opens on hover.
+      overlay.addEventListener(isTouch ? 'click' : 'mouseover', (event) => {
+        this.__showSubMenu(event);
+      });
+
+      overlay.addEventListener('keydown', (event) => {
+        const { key } = event;
+        const isRTL = this.__isRTL;
+
+        const isArrowRight = key === 'ArrowRight';
+        const isArrowLeft = key === 'ArrowLeft';
+
+        if ((!isRTL && isArrowRight) || (isRTL && isArrowLeft) || key === 'Enter' || key === ' ') {
+          // Open a sub-menu
+          this.__showSubMenu(event);
+        } else if ((!isRTL && isArrowLeft) || (isRTL && isArrowRight)) {
+          // Close the menu
+          this.close();
+          this.listenOn.focus();
+        } else if (key === 'Escape' || key === 'Tab') {
+          // Close all menus
+          this.dispatchEvent(new CustomEvent('close-all-menus'));
         }
+      });
+    }
+
+    /** @private */
+    __initSubMenu() {
+      const subMenu = document.createElement(this.constructor.is);
 
-        this._setMenuItemTheme(component, item, this._theme);
+      subMenu._modeless = true;
+      subMenu.openOn = 'opensubmenu';
 
-        component._item = item;
+      // Sub-menu doesn't have a target to wrap,
+      // so there is no need to keep it visible.
+      subMenu.setAttribute('hidden', '');
 
-        if (item.text) {
-          component.textContent = item.text;
+      // Close sub-menu when the parent menu closes.
+      this.addEventListener('opened-changed', (event) => {
+        if (!event.detail.value) {
+          this._subMenu.close();
         }
+      });
 
-        this.__toggleMenuComponentAttribute(component, 'menu-item-checked', item.checked);
-        this.__toggleMenuComponentAttribute(component, 'disabled', item.disabled);
+      // Forward event to the parent menu element.
+      subMenu.addEventListener('close-all-menus', () => {
+        this.dispatchEvent(new CustomEvent('close-all-menus'));
+      });
 
-        component.setAttribute('aria-haspopup', 'false');
-        if (item.children && item.children.length) {
-          component.setAttribute('aria-haspopup', 'true');
-          component.setAttribute('aria-expanded', 'false');
-          component.removeAttribute('expanded');
+      // Forward event to the parent menu element.
+      subMenu.addEventListener('item-selected', (event) => {
+        const { detail } = event;
+        this.dispatchEvent(new CustomEvent('item-selected', { detail }));
+      });
+
+      // Listen to the forwarded event from sub-menu.
+      this.addEventListener('close-all-menus', () => {
+        this.close();
+      });
+
+      // Listen to the forwarded event from sub-menu.
+      this.addEventListener('item-selected', () => {
+        this.close();
+      });
+
+      // Mark parent item as collapsed when closing.
+      subMenu.addEventListener('opened-changed', (event) => {
+        if (!event.detail.value) {
+          const expandedItem = this._listBox.querySelector('[expanded]');
+          if (expandedItem) {
+            this.__updateExpanded(expandedItem, false);
+          }
         }
+      });
+
+      return subMenu;
+    }
+
+    /** @private */
+    __showSubMenu(event, item = event.composedPath().find((node) => node.localName === `${this._tagNamePrefix}-item`)) {
+      // Delay enabling the mouseover listener to avoid it from triggering on parent menu open
+      if (!this.__openListenerActive) {
+        return;
+      }
+
+      // Don't open sub-menus while the menu is still opening
+      if (this.$.overlay.hasAttribute('opening')) {
+        requestAnimationFrame(() => {
+          this.__showSubMenu(event, item);
+        });
+
+        return;
+      }
 
+      const subMenu = this._subMenu;
+
+      if (item) {
+        const { children } = item._item;
+
+        if (subMenu.items !== children) {
+          subMenu.close();
+        }
+        if (!this.opened) {
+          return;
+        }
+
+        if (children && children.length) {
+          this.__updateExpanded(item, true);
+
+          // Forward parent overlay class
+          const { overlayClass } = this;
+          this.__openSubMenu(subMenu, item, overlayClass);
+        } else {
+          subMenu.listenOn.focus();
+        }
+      }
+    }
+
+    /**
+     * @param {!HTMLElement} root
+     * @param {!ContextMenu} menu
+     * @param {!ContextMenuRendererContext} context
+     * @protected
+     */
+    __itemsRenderer(root, menu, { detail }) {
+      this.__initMenu(root, menu);
+
+      const subMenu = root.querySelector(this.constructor.is);
+      subMenu.closeOn = menu.closeOn;
+
+      const listBox = root.querySelector(`${this._tagNamePrefix}-list-box`);
+      listBox.innerHTML = '';
+
+      [...(detail.children || menu.items)].forEach((item) => {
+        const component = this.__createComponent(item);
         listBox.appendChild(component);
       });
     }
@@ -223,11 +383,7 @@ export const ItemsMixin = (superClass) =>
         theme = Array.isArray(item.theme) ? item.theme.join(' ') : item.theme;
       }
 
-      if (theme) {
-        component.setAttribute('theme', theme);
-      } else {
-        component.removeAttribute('theme');
-      }
+      this.__updateTheme(component, theme);
     }
 
     /** @private */
@@ -243,122 +399,39 @@ export const ItemsMixin = (superClass) =>
 
     /** @private */
     __initMenu(root, menu) {
+      // NOTE: in this method, `menu` and `this` reference the same element,
+      // so we can use either of those. Original implementation used `menu`.
       if (!root.firstElementChild) {
-        const listBox = document.createElement(`${this._tagNamePrefix}-list-box`);
-        root.appendChild(listBox);
+        this.__initOverlay();
 
-        if (this._theme) {
-          listBox.setAttribute('theme', this._theme);
-        }
-        requestAnimationFrame(() => listBox.setAttribute('role', 'menu'));
+        const listBox = this.__initListBox();
+        this._listBox = listBox;
+        root.appendChild(listBox);
 
-        const subMenu = document.createElement(this.constructor.is);
-        subMenu.setAttribute('hidden', '');
+        const subMenu = this.__initSubMenu();
+        this._subMenu = subMenu;
         root.appendChild(subMenu);
-        subMenu.$.overlay.modeless = true;
-        subMenu.openOn = 'opensubmenu';
-
-        menu.addEventListener('opened-changed', (e) => !e.detail.value && subMenu.close());
-        subMenu.addEventListener('opened-changed', (e) => {
-          if (!e.detail.value) {
-            const expandedItem = listBox.querySelector('[expanded]');
-            if (expandedItem) {
-              expandedItem.setAttribute('aria-expanded', 'false');
-              expandedItem.removeAttribute('expanded');
-            }
-          }
-        });
-
-        listBox.addEventListener('selected-changed', (e) => {
-          if (typeof e.detail.value === 'number') {
-            const item = e.target.items[e.detail.value]._item;
-            if (!item.children) {
-              const detail = { value: item };
-              menu.dispatchEvent(new CustomEvent('item-selected', { detail }));
-            }
-            listBox.selected = null;
-          }
-        });
-
-        subMenu.addEventListener('item-selected', (e) => {
-          menu.dispatchEvent(new CustomEvent('item-selected', { detail: e.detail }));
-        });
-
-        subMenu.addEventListener('close-all-menus', () => {
-          menu.dispatchEvent(new CustomEvent('close-all-menus'));
-        });
-        menu.addEventListener('close-all-menus', menu.close);
-        menu.addEventListener('item-selected', menu.close);
-        menu.$.overlay.$.backdrop.addEventListener('click', () => menu.close());
-
-        menu.$.overlay.addEventListener('keydown', (e) => {
-          const isRTL = this.__isRTL;
-          if ((!isRTL && e.keyCode === 37) || (isRTL && e.keyCode === 39)) {
-            menu.close();
-            menu.listenOn.focus();
-          } else if (e.key === 'Escape' || e.key === 'Tab') {
-            menu.dispatchEvent(new CustomEvent('close-all-menus'));
-          }
-        });
 
         requestAnimationFrame(() => {
           this.__openListenerActive = true;
         });
-        const openSubMenu = (
-          e,
-          itemElement = e.composedPath().find((e) => e.localName === `${this._tagNamePrefix}-item`),
-        ) => {
-          // Delay enabling the mouseover listener to avoid it from triggering on parent menu open
-          if (!this.__openListenerActive) {
-            return;
-          }
-
-          // Don't open sub-menus while the menu is still opening
-          if (menu.$.overlay.hasAttribute('opening')) {
-            requestAnimationFrame(() => openSubMenu(e, itemElement));
-            return;
-          }
-
-          if (itemElement) {
-            if (subMenu.items !== itemElement._item.children) {
-              subMenu.close();
-            }
-            if (!menu.opened) {
-              return;
-            }
-            if (itemElement._item.children && itemElement._item.children.length) {
-              itemElement.setAttribute('aria-expanded', 'true');
-              itemElement.setAttribute('expanded', '');
-
-              // Forward parent overlay class
-              const { overlayClass } = menu;
-              this.__openSubMenu(subMenu, itemElement, overlayClass);
-            } else {
-              subMenu.listenOn.focus();
-            }
-          }
-        };
-
-        // Open a submenu on click event when a touch device is used.
-        // On desktop, a submenu opens on hover.
-        menu.$.overlay.addEventListener(isTouch ? 'click' : 'mouseover', openSubMenu);
+      } else {
+        this.__updateTheme(this._listBox, this._theme);
+      }
+    }
 
-        menu.$.overlay.addEventListener('keydown', (e) => {
-          const isRTL = this.__isRTL;
-          const shouldOpenSubMenu =
-            (!isRTL && e.keyCode === 39) || (isRTL && e.keyCode === 37) || e.keyCode === 13 || e.keyCode === 32;
+    /** @private */
+    __updateExpanded(component, expanded) {
+      component.setAttribute('aria-expanded', expanded.toString());
+      component.toggleAttribute('expanded', expanded);
+    }
 
-          if (shouldOpenSubMenu) {
-            openSubMenu(e);
-          }
-        });
+    /** @private */
+    __updateTheme(component, theme) {
+      if (theme) {
+        component.setAttribute('theme', theme);
       } else {
-        const listBox = root.querySelector(`${this._tagNamePrefix}-list-box`);
-        if (this._theme) {
-          listBox.setAttribute('theme', this._theme);
-        } else {
-          listBox.removeAttribute('theme');
-        }
+        component.removeAttribute('theme');
       }
     }
   };

package/web-types.json

@@ -1,14 +1,14 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/context-menu",
-  "version": "24.0.0-alpha12",
+  "version": "24.0.0-beta3",
   "description-markup": "markdown",
   "contributions": {
     "html": {
       "elements": [
         {
           "name": "vaadin-context-menu",
-          "description": "`<vaadin-context-menu>` is a Web Component for creating context menus.\n\n### Items\n\nItems is a higher level convenience API for defining a (hierarchical) menu structure for the component.\nIf a menu item has a non-empty `children` set, a sub-menu with the child items is opened\nnext to the parent menu on mouseover, tap or a right arrow keypress.\n\nWhen an item is selected, `<vaadin-context-menu>` dispatches an \"item-selected\" event\nwith the selected item as `event.detail.value` property.\n\n```javascript\ncontextMenu.items = [\n  {text: 'Menu Item 1', theme: 'primary', children:\n    [\n      {text: 'Menu Item 1-1', checked: true},\n      {text: 'Menu Item 1-2'}\n    ]\n  },\n  {component: 'hr'},\n  {text: 'Menu Item 2', children:\n    [\n      {text: 'Menu Item 2-1'},\n      {text: 'Menu Item 2-2', disabled: true}\n    ]\n  },\n  {text: 'Menu Item 3', disabled: true}\n];\n\ncontextMenu.addEventListener('item-selected', e => {\n  const item = e.detail.value;\n  console.log(`${item.text} selected`);\n});\n```\n\n**NOTE:** when the `items` array is defined, the renderer cannot be used.\n\n### Rendering\n\nThe content of the menu can be populated by using the renderer callback function.\n\nThe renderer function provides `root`, `contextMenu`, `model` arguments when applicable.\nGenerate DOM content by using `model` object properties if needed, append it to the `root`\nelement and control the state of the host element by accessing `contextMenu`. Before generating\nnew content, the renderer function should check if there is already content in `root` for reusing it.\n\n```html\n<vaadin-context-menu id=\"contextMenu\">\n <p>This paragraph has a context menu.</p>\n</vaadin-context-menu>\n```\n```js\nconst contextMenu = document.querySelector('#contextMenu');\ncontextMenu.renderer = (root, contextMenu, context) => {\n  let listBox = root.firstElementChild;\n  if (!listBox) {\n    listBox = document.createElement('vaadin-list-box');\n    root.appendChild(listBox);\n  }\n\n  let item = listBox.querySelector('vaadin-item');\n  if (!item) {\n    item = document.createElement('vaadin-item');\n    listBox.appendChild(item);\n  }\n  item.textContent = 'Content of the selector: ' + context.target.textContent;\n};\n```\n\nYou can access the menu context inside the renderer using\n`context.target` and `context.detail`.\n\nRenderer is called on the opening of the context-menu and each time the related context is updated.\nDOM generated during the renderer call can be reused\nin the next renderer call and will be provided with the `root` argument.\nOn first call it will be empty.\n\n### “vaadin-contextmenu” Gesture Event\n\n`vaadin-contextmenu` is a gesture event (a custom event),\nwhich is dispatched after either `contextmenu` or long touch events.\nThis enables support for both mouse and touch environments in a uniform way.\n\n`<vaadin-context-menu>` opens the menu overlay on the `vaadin-contextmenu`\nevent by default.\n\n### Menu Listener\n\nBy default, the `<vaadin-context-menu>` element listens for the menu opening\nevent on itself. In case if you do not want to wrap the target, you can listen for\nevents on an element outside the `<vaadin-context-menu>` by setting the\n`listenOn` property:\n\n```html\n<vaadin-context-menu id=\"contextMenu\"></vaadin-context-menu>\n\n<div id=\"menuListener\">The element that listens for the contextmenu event.</div>\n```\n```javascript\nconst contextMenu = document.querySelector('#contextMenu');\ncontextMenu.listenOn = document.querySelector('#menuListener');\n```\n\n### Filtering Menu Targets\n\nBy default, the listener element and all its descendants open the context\nmenu. You can filter the menu targets to a smaller set of elements inside\nthe listener element by setting the `selector` property.\n\nIn the following example, only the elements matching `.has-menu` will open the context menu:\n\n```html\n<vaadin-context-menu selector=\".has-menu\">\n  <p class=\"has-menu\">This paragraph opens the context menu</p>\n  <p>This paragraph does not open the context menu</p>\n</vaadin-context-menu>\n```\n\n### Menu Context\n\nThe following properties are available in the `context` argument:\n\n- `target` is the menu opening event target, which is the element that\nthe user has called the context menu for\n- `detail` is the menu opening event detail\n\nIn the following example, the menu item text is composed with the contents\nof the element that opened the menu:\n\n```html\n<vaadin-context-menu selector=\"li\" id=\"contextMenu\">\n  <ul>\n    <li>Foo</li>\n    <li>Bar</li>\n    <li>Baz</li>\n  </ul>\n</vaadin-context-menu>\n```\n```js\nconst contextMenu = document.querySelector('#contextMenu');\ncontextMenu.renderer = (root, contextMenu, context) => {\n  let listBox = root.firstElementChild;\n  if (!listBox) {\n    listBox = document.createElement('vaadin-list-box');\n    root.appendChild(listBox);\n  }\n\n  let item = listBox.querySelector('vaadin-item');\n  if (!item) {\n    item = document.createElement('vaadin-item');\n    listBox.appendChild(item);\n  }\n  item.textContent = 'The menu target: ' + context.target.textContent;\n};\n```\n\n### Styling\n\n`<vaadin-context-menu>` uses `<vaadin-context-menu-overlay>` internal\nthemable component as the actual visible context menu overlay.\n\nSee [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha12/#/elements/vaadin-overlay)\ndocumentation for `<vaadin-context-menu-overlay>` stylable parts.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.\n\n### Internal components\n\nWhen using `items` API, in addition `<vaadin-context-menu-overlay>`, the following\ninternal components are themable:\n\n- `<vaadin-context-menu-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha12/#/elements/vaadin-item).\n- `<vaadin-context-menu-list-box>` - has the same API as [`<vaadin-list-box>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha12/#/elements/vaadin-list-box).\n\nNote: the `theme` attribute value set on `<vaadin-context-menu>` is\npropagated to the internal components listed above.",
+          "description": "`<vaadin-context-menu>` is a Web Component for creating context menus.\n\n### Items\n\nItems is a higher level convenience API for defining a (hierarchical) menu structure for the component.\nIf a menu item has a non-empty `children` set, a sub-menu with the child items is opened\nnext to the parent menu on mouseover, tap or a right arrow keypress.\n\nWhen an item is selected, `<vaadin-context-menu>` dispatches an \"item-selected\" event\nwith the selected item as `event.detail.value` property.\n\n```javascript\ncontextMenu.items = [\n  { text: 'Menu Item 1', theme: 'primary', children:\n    [\n      { text: 'Menu Item 1-1', checked: true },\n      { text: 'Menu Item 1-2' }\n    ]\n  },\n  { component: 'hr' },\n  { text: 'Menu Item 2', children:\n    [\n      { text: 'Menu Item 2-1' },\n      { text: 'Menu Item 2-2', disabled: true }\n    ]\n  },\n  { text: 'Menu Item 3', disabled: true }\n];\n\ncontextMenu.addEventListener('item-selected', e => {\n  const item = e.detail.value;\n  console.log(`${item.text} selected`);\n});\n```\n\n**NOTE:** when the `items` array is defined, the renderer cannot be used.\n\n### Rendering\n\nThe content of the menu can be populated by using the renderer callback function.\n\nThe renderer function provides `root`, `contextMenu`, `model` arguments when applicable.\nGenerate DOM content by using `model` object properties if needed, append it to the `root`\nelement and control the state of the host element by accessing `contextMenu`. Before generating\nnew content, the renderer function should check if there is already content in `root` for reusing it.\n\n```html\n<vaadin-context-menu id=\"contextMenu\">\n <p>This paragraph has a context menu.</p>\n</vaadin-context-menu>\n```\n```js\nconst contextMenu = document.querySelector('#contextMenu');\ncontextMenu.renderer = (root, contextMenu, context) => {\n  let listBox = root.firstElementChild;\n  if (!listBox) {\n    listBox = document.createElement('vaadin-list-box');\n    root.appendChild(listBox);\n  }\n\n  let item = listBox.querySelector('vaadin-item');\n  if (!item) {\n    item = document.createElement('vaadin-item');\n    listBox.appendChild(item);\n  }\n  item.textContent = 'Content of the selector: ' + context.target.textContent;\n};\n```\n\nYou can access the menu context inside the renderer using\n`context.target` and `context.detail`.\n\nRenderer is called on the opening of the context-menu and each time the related context is updated.\nDOM generated during the renderer call can be reused\nin the next renderer call and will be provided with the `root` argument.\nOn first call it will be empty.\n\n### `vaadin-contextmenu` Gesture Event\n\n`vaadin-contextmenu` is a gesture event (a custom event),\nwhich is dispatched after either `contextmenu` or long touch events.\nThis enables support for both mouse and touch environments in a uniform way.\n\n`<vaadin-context-menu>` opens the menu overlay on the `vaadin-contextmenu`\nevent by default.\n\n### Menu Listener\n\nBy default, the `<vaadin-context-menu>` element listens for the menu opening\nevent on itself. In case if you do not want to wrap the target, you can listen for\nevents on an element outside the `<vaadin-context-menu>` by setting the\n`listenOn` property:\n\n```html\n<vaadin-context-menu id=\"contextMenu\"></vaadin-context-menu>\n\n<div id=\"menuListener\">The element that listens for the contextmenu event.</div>\n```\n```javascript\nconst contextMenu = document.querySelector('#contextMenu');\ncontextMenu.listenOn = document.querySelector('#menuListener');\n```\n\n### Filtering Menu Targets\n\nBy default, the listener element and all its descendants open the context\nmenu. You can filter the menu targets to a smaller set of elements inside\nthe listener element by setting the `selector` property.\n\nIn the following example, only the elements matching `.has-menu` will open the context menu:\n\n```html\n<vaadin-context-menu selector=\".has-menu\">\n  <p class=\"has-menu\">This paragraph opens the context menu</p>\n  <p>This paragraph does not open the context menu</p>\n</vaadin-context-menu>\n```\n\n### Menu Context\n\nThe following properties are available in the `context` argument:\n\n- `target` is the menu opening event target, which is the element that\nthe user has called the context menu for\n- `detail` is the menu opening event detail\n\nIn the following example, the menu item text is composed with the contents\nof the element that opened the menu:\n\n```html\n<vaadin-context-menu selector=\"li\" id=\"contextMenu\">\n  <ul>\n    <li>Foo</li>\n    <li>Bar</li>\n    <li>Baz</li>\n  </ul>\n</vaadin-context-menu>\n```\n```js\nconst contextMenu = document.querySelector('#contextMenu');\ncontextMenu.renderer = (root, contextMenu, context) => {\n  let listBox = root.firstElementChild;\n  if (!listBox) {\n    listBox = document.createElement('vaadin-list-box');\n    root.appendChild(listBox);\n  }\n\n  let item = listBox.querySelector('vaadin-item');\n  if (!item) {\n    item = document.createElement('vaadin-item');\n    listBox.appendChild(item);\n  }\n  item.textContent = 'The menu target: ' + context.target.textContent;\n};\n```\n\n### Styling\n\n`<vaadin-context-menu>` uses `<vaadin-context-menu-overlay>` internal\nthemable component as the actual visible context menu overlay.\n\nSee [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-beta3/#/elements/vaadin-overlay)\ndocumentation for `<vaadin-context-menu-overlay>` stylable parts.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.\n\n### Internal components\n\nWhen using `items` API, in addition `<vaadin-context-menu-overlay>`, the following\ninternal components are themable:\n\n- `<vaadin-context-menu-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-beta3/#/elements/vaadin-item).\n- `<vaadin-context-menu-list-box>` - has the same API as [`<vaadin-list-box>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-beta3/#/elements/vaadin-list-box).\n\nNote: the `theme` attribute value set on `<vaadin-context-menu>` is\npropagated to the internal components listed above.",
           "attributes": [
             {
               "name": "overlay-class",
@@ -77,7 +77,7 @@
               },
               {
                 "name": "items",
-                "description": "Defines a (hierarchical) menu structure for the component.\nIf a menu item has a non-empty `children` set, a sub-menu with the child items is opened\nnext to the parent menu on mouseover, tap or a right arrow keypress.\n\nThe items API can't be used together with a renderer!\n\n#### Example\n\n```javascript\ncontextMenu.items = [\n  {text: 'Menu Item 1', theme: 'primary', children:\n    [\n      {text: 'Menu Item 1-1', checked: true},\n      {text: 'Menu Item 1-2'}\n    ]\n  },\n  {component: 'hr'},\n  {text: 'Menu Item 2', children:\n    [\n      {text: 'Menu Item 2-1'},\n      {text: 'Menu Item 2-2', disabled: true}\n    ]\n  },\n  {text: 'Menu Item 3', disabled: true}\n];\n```",
+                "description": "Defines a (hierarchical) menu structure for the component.\nIf a menu item has a non-empty `children` set, a sub-menu with the child items is opened\nnext to the parent menu on mouseover, tap or a right arrow keypress.\n\nThe items API can't be used together with a renderer!\n\n#### Example\n\n```javascript\ncontextMenu.items = [\n  { text: 'Menu Item 1', theme: 'primary', children:\n    [\n      { text: 'Menu Item 1-1', checked: true },\n      { text: 'Menu Item 1-2' }\n    ]\n  },\n  { component: 'hr' },\n  { text: 'Menu Item 2', children:\n    [\n      { text: 'Menu Item 2-1' },\n      { text: 'Menu Item 2-2', disabled: true }\n    ]\n  },\n  { text: 'Menu Item 3', disabled: true }\n];\n```",
                 "value": {
                   "type": [
                     "Array.<ContextMenuItem>",

package/web-types.lit.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/context-menu",
-  "version": "24.0.0-alpha12",
+  "version": "24.0.0-beta3",
   "description-markup": "markdown",
   "framework": "lit",
   "framework-config": {
@@ -16,7 +16,7 @@
       "elements": [
         {
           "name": "vaadin-context-menu",
-          "description": "`<vaadin-context-menu>` is a Web Component for creating context menus.\n\n### Items\n\nItems is a higher level convenience API for defining a (hierarchical) menu structure for the component.\nIf a menu item has a non-empty `children` set, a sub-menu with the child items is opened\nnext to the parent menu on mouseover, tap or a right arrow keypress.\n\nWhen an item is selected, `<vaadin-context-menu>` dispatches an \"item-selected\" event\nwith the selected item as `event.detail.value` property.\n\n```javascript\ncontextMenu.items = [\n  {text: 'Menu Item 1', theme: 'primary', children:\n    [\n      {text: 'Menu Item 1-1', checked: true},\n      {text: 'Menu Item 1-2'}\n    ]\n  },\n  {component: 'hr'},\n  {text: 'Menu Item 2', children:\n    [\n      {text: 'Menu Item 2-1'},\n      {text: 'Menu Item 2-2', disabled: true}\n    ]\n  },\n  {text: 'Menu Item 3', disabled: true}\n];\n\ncontextMenu.addEventListener('item-selected', e => {\n  const item = e.detail.value;\n  console.log(`${item.text} selected`);\n});\n```\n\n**NOTE:** when the `items` array is defined, the renderer cannot be used.\n\n### Rendering\n\nThe content of the menu can be populated by using the renderer callback function.\n\nThe renderer function provides `root`, `contextMenu`, `model` arguments when applicable.\nGenerate DOM content by using `model` object properties if needed, append it to the `root`\nelement and control the state of the host element by accessing `contextMenu`. Before generating\nnew content, the renderer function should check if there is already content in `root` for reusing it.\n\n```html\n<vaadin-context-menu id=\"contextMenu\">\n <p>This paragraph has a context menu.</p>\n</vaadin-context-menu>\n```\n```js\nconst contextMenu = document.querySelector('#contextMenu');\ncontextMenu.renderer = (root, contextMenu, context) => {\n  let listBox = root.firstElementChild;\n  if (!listBox) {\n    listBox = document.createElement('vaadin-list-box');\n    root.appendChild(listBox);\n  }\n\n  let item = listBox.querySelector('vaadin-item');\n  if (!item) {\n    item = document.createElement('vaadin-item');\n    listBox.appendChild(item);\n  }\n  item.textContent = 'Content of the selector: ' + context.target.textContent;\n};\n```\n\nYou can access the menu context inside the renderer using\n`context.target` and `context.detail`.\n\nRenderer is called on the opening of the context-menu and each time the related context is updated.\nDOM generated during the renderer call can be reused\nin the next renderer call and will be provided with the `root` argument.\nOn first call it will be empty.\n\n### “vaadin-contextmenu” Gesture Event\n\n`vaadin-contextmenu` is a gesture event (a custom event),\nwhich is dispatched after either `contextmenu` or long touch events.\nThis enables support for both mouse and touch environments in a uniform way.\n\n`<vaadin-context-menu>` opens the menu overlay on the `vaadin-contextmenu`\nevent by default.\n\n### Menu Listener\n\nBy default, the `<vaadin-context-menu>` element listens for the menu opening\nevent on itself. In case if you do not want to wrap the target, you can listen for\nevents on an element outside the `<vaadin-context-menu>` by setting the\n`listenOn` property:\n\n```html\n<vaadin-context-menu id=\"contextMenu\"></vaadin-context-menu>\n\n<div id=\"menuListener\">The element that listens for the contextmenu event.</div>\n```\n```javascript\nconst contextMenu = document.querySelector('#contextMenu');\ncontextMenu.listenOn = document.querySelector('#menuListener');\n```\n\n### Filtering Menu Targets\n\nBy default, the listener element and all its descendants open the context\nmenu. You can filter the menu targets to a smaller set of elements inside\nthe listener element by setting the `selector` property.\n\nIn the following example, only the elements matching `.has-menu` will open the context menu:\n\n```html\n<vaadin-context-menu selector=\".has-menu\">\n  <p class=\"has-menu\">This paragraph opens the context menu</p>\n  <p>This paragraph does not open the context menu</p>\n</vaadin-context-menu>\n```\n\n### Menu Context\n\nThe following properties are available in the `context` argument:\n\n- `target` is the menu opening event target, which is the element that\nthe user has called the context menu for\n- `detail` is the menu opening event detail\n\nIn the following example, the menu item text is composed with the contents\nof the element that opened the menu:\n\n```html\n<vaadin-context-menu selector=\"li\" id=\"contextMenu\">\n  <ul>\n    <li>Foo</li>\n    <li>Bar</li>\n    <li>Baz</li>\n  </ul>\n</vaadin-context-menu>\n```\n```js\nconst contextMenu = document.querySelector('#contextMenu');\ncontextMenu.renderer = (root, contextMenu, context) => {\n  let listBox = root.firstElementChild;\n  if (!listBox) {\n    listBox = document.createElement('vaadin-list-box');\n    root.appendChild(listBox);\n  }\n\n  let item = listBox.querySelector('vaadin-item');\n  if (!item) {\n    item = document.createElement('vaadin-item');\n    listBox.appendChild(item);\n  }\n  item.textContent = 'The menu target: ' + context.target.textContent;\n};\n```\n\n### Styling\n\n`<vaadin-context-menu>` uses `<vaadin-context-menu-overlay>` internal\nthemable component as the actual visible context menu overlay.\n\nSee [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha12/#/elements/vaadin-overlay)\ndocumentation for `<vaadin-context-menu-overlay>` stylable parts.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.\n\n### Internal components\n\nWhen using `items` API, in addition `<vaadin-context-menu-overlay>`, the following\ninternal components are themable:\n\n- `<vaadin-context-menu-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha12/#/elements/vaadin-item).\n- `<vaadin-context-menu-list-box>` - has the same API as [`<vaadin-list-box>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha12/#/elements/vaadin-list-box).\n\nNote: the `theme` attribute value set on `<vaadin-context-menu>` is\npropagated to the internal components listed above.",
+          "description": "`<vaadin-context-menu>` is a Web Component for creating context menus.\n\n### Items\n\nItems is a higher level convenience API for defining a (hierarchical) menu structure for the component.\nIf a menu item has a non-empty `children` set, a sub-menu with the child items is opened\nnext to the parent menu on mouseover, tap or a right arrow keypress.\n\nWhen an item is selected, `<vaadin-context-menu>` dispatches an \"item-selected\" event\nwith the selected item as `event.detail.value` property.\n\n```javascript\ncontextMenu.items = [\n  { text: 'Menu Item 1', theme: 'primary', children:\n    [\n      { text: 'Menu Item 1-1', checked: true },\n      { text: 'Menu Item 1-2' }\n    ]\n  },\n  { component: 'hr' },\n  { text: 'Menu Item 2', children:\n    [\n      { text: 'Menu Item 2-1' },\n      { text: 'Menu Item 2-2', disabled: true }\n    ]\n  },\n  { text: 'Menu Item 3', disabled: true }\n];\n\ncontextMenu.addEventListener('item-selected', e => {\n  const item = e.detail.value;\n  console.log(`${item.text} selected`);\n});\n```\n\n**NOTE:** when the `items` array is defined, the renderer cannot be used.\n\n### Rendering\n\nThe content of the menu can be populated by using the renderer callback function.\n\nThe renderer function provides `root`, `contextMenu`, `model` arguments when applicable.\nGenerate DOM content by using `model` object properties if needed, append it to the `root`\nelement and control the state of the host element by accessing `contextMenu`. Before generating\nnew content, the renderer function should check if there is already content in `root` for reusing it.\n\n```html\n<vaadin-context-menu id=\"contextMenu\">\n <p>This paragraph has a context menu.</p>\n</vaadin-context-menu>\n```\n```js\nconst contextMenu = document.querySelector('#contextMenu');\ncontextMenu.renderer = (root, contextMenu, context) => {\n  let listBox = root.firstElementChild;\n  if (!listBox) {\n    listBox = document.createElement('vaadin-list-box');\n    root.appendChild(listBox);\n  }\n\n  let item = listBox.querySelector('vaadin-item');\n  if (!item) {\n    item = document.createElement('vaadin-item');\n    listBox.appendChild(item);\n  }\n  item.textContent = 'Content of the selector: ' + context.target.textContent;\n};\n```\n\nYou can access the menu context inside the renderer using\n`context.target` and `context.detail`.\n\nRenderer is called on the opening of the context-menu and each time the related context is updated.\nDOM generated during the renderer call can be reused\nin the next renderer call and will be provided with the `root` argument.\nOn first call it will be empty.\n\n### `vaadin-contextmenu` Gesture Event\n\n`vaadin-contextmenu` is a gesture event (a custom event),\nwhich is dispatched after either `contextmenu` or long touch events.\nThis enables support for both mouse and touch environments in a uniform way.\n\n`<vaadin-context-menu>` opens the menu overlay on the `vaadin-contextmenu`\nevent by default.\n\n### Menu Listener\n\nBy default, the `<vaadin-context-menu>` element listens for the menu opening\nevent on itself. In case if you do not want to wrap the target, you can listen for\nevents on an element outside the `<vaadin-context-menu>` by setting the\n`listenOn` property:\n\n```html\n<vaadin-context-menu id=\"contextMenu\"></vaadin-context-menu>\n\n<div id=\"menuListener\">The element that listens for the contextmenu event.</div>\n```\n```javascript\nconst contextMenu = document.querySelector('#contextMenu');\ncontextMenu.listenOn = document.querySelector('#menuListener');\n```\n\n### Filtering Menu Targets\n\nBy default, the listener element and all its descendants open the context\nmenu. You can filter the menu targets to a smaller set of elements inside\nthe listener element by setting the `selector` property.\n\nIn the following example, only the elements matching `.has-menu` will open the context menu:\n\n```html\n<vaadin-context-menu selector=\".has-menu\">\n  <p class=\"has-menu\">This paragraph opens the context menu</p>\n  <p>This paragraph does not open the context menu</p>\n</vaadin-context-menu>\n```\n\n### Menu Context\n\nThe following properties are available in the `context` argument:\n\n- `target` is the menu opening event target, which is the element that\nthe user has called the context menu for\n- `detail` is the menu opening event detail\n\nIn the following example, the menu item text is composed with the contents\nof the element that opened the menu:\n\n```html\n<vaadin-context-menu selector=\"li\" id=\"contextMenu\">\n  <ul>\n    <li>Foo</li>\n    <li>Bar</li>\n    <li>Baz</li>\n  </ul>\n</vaadin-context-menu>\n```\n```js\nconst contextMenu = document.querySelector('#contextMenu');\ncontextMenu.renderer = (root, contextMenu, context) => {\n  let listBox = root.firstElementChild;\n  if (!listBox) {\n    listBox = document.createElement('vaadin-list-box');\n    root.appendChild(listBox);\n  }\n\n  let item = listBox.querySelector('vaadin-item');\n  if (!item) {\n    item = document.createElement('vaadin-item');\n    listBox.appendChild(item);\n  }\n  item.textContent = 'The menu target: ' + context.target.textContent;\n};\n```\n\n### Styling\n\n`<vaadin-context-menu>` uses `<vaadin-context-menu-overlay>` internal\nthemable component as the actual visible context menu overlay.\n\nSee [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-beta3/#/elements/vaadin-overlay)\ndocumentation for `<vaadin-context-menu-overlay>` stylable parts.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.\n\n### Internal components\n\nWhen using `items` API, in addition `<vaadin-context-menu-overlay>`, the following\ninternal components are themable:\n\n- `<vaadin-context-menu-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-beta3/#/elements/vaadin-item).\n- `<vaadin-context-menu-list-box>` - has the same API as [`<vaadin-list-box>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-beta3/#/elements/vaadin-list-box).\n\nNote: the `theme` attribute value set on `<vaadin-context-menu>` is\npropagated to the internal components listed above.",
           "extension": true,
           "attributes": [
             {
@@ -28,7 +28,7 @@
             },
             {
               "name": ".items",
-              "description": "Defines a (hierarchical) menu structure for the component.\nIf a menu item has a non-empty `children` set, a sub-menu with the child items is opened\nnext to the parent menu on mouseover, tap or a right arrow keypress.\n\nThe items API can't be used together with a renderer!\n\n#### Example\n\n```javascript\ncontextMenu.items = [\n  {text: 'Menu Item 1', theme: 'primary', children:\n    [\n      {text: 'Menu Item 1-1', checked: true},\n      {text: 'Menu Item 1-2'}\n    ]\n  },\n  {component: 'hr'},\n  {text: 'Menu Item 2', children:\n    [\n      {text: 'Menu Item 2-1'},\n      {text: 'Menu Item 2-2', disabled: true}\n    ]\n  },\n  {text: 'Menu Item 3', disabled: true}\n];\n```",
+              "description": "Defines a (hierarchical) menu structure for the component.\nIf a menu item has a non-empty `children` set, a sub-menu with the child items is opened\nnext to the parent menu on mouseover, tap or a right arrow keypress.\n\nThe items API can't be used together with a renderer!\n\n#### Example\n\n```javascript\ncontextMenu.items = [\n  { text: 'Menu Item 1', theme: 'primary', children:\n    [\n      { text: 'Menu Item 1-1', checked: true },\n      { text: 'Menu Item 1-2' }\n    ]\n  },\n  { component: 'hr' },\n  { text: 'Menu Item 2', children:\n    [\n      { text: 'Menu Item 2-1' },\n      { text: 'Menu Item 2-2', disabled: true }\n    ]\n  },\n  { text: 'Menu Item 3', disabled: true }\n];\n```",
               "value": {
                 "kind": "expression"
               }