@vaadin/menu-bar 24.8.4 → 25.0.0-alpha10

package/src/vaadin-menu-bar-mixin.js

@@ -11,7 +11,6 @@ import { FocusMixin } from '@vaadin/a11y-base/src/focus-mixin.js';
 import { isElementFocused, isKeyboardActive } from '@vaadin/a11y-base/src/focus-utils.js';
 import { KeyboardDirectionMixin } from '@vaadin/a11y-base/src/keyboard-direction-mixin.js';
 import { microTask } from '@vaadin/component-base/src/async.js';
-import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
 import { Debouncer } from '@vaadin/component-base/src/debounce.js';
 import { I18nMixin } from '@vaadin/component-base/src/i18n-mixin.js';
 import { ResizeMixin } from '@vaadin/component-base/src/resize-mixin.js';
@@ -58,7 +57,6 @@ const DEFAULT_I18N = {
 
 /**
  * @polymerMixin
- * @mixes ControllerMixin
  * @mixes DisabledMixin
  * @mixes FocusMixin
  * @mixes I18nMixin
@@ -68,7 +66,7 @@ const DEFAULT_I18N = {
 export const MenuBarMixin = (superClass) =>
   class MenuBarMixinClass extends I18nMixin(
     DEFAULT_I18N,
-    KeyboardDirectionMixin(ResizeMixin(FocusMixin(DisabledMixin(ControllerMixin(superClass))))),
+    KeyboardDirectionMixin(ResizeMixin(FocusMixin(DisabledMixin(superClass)))),
   ) {
     static get properties() {
       return {
@@ -193,41 +191,9 @@ export const MenuBarMixin = (superClass) =>
           type: Boolean,
           sync: true,
         },
-
-        /**
-         * @type {boolean}
-         * @protected
-         */
-        _hasOverflow: {
-          type: Boolean,
-          value: false,
-          sync: true,
-        },
-
-        /** @protected */
-        _overflow: {
-          type: Object,
-        },
-
-        /** @protected */
-        _container: {
-          type: Object,
-          sync: true,
-        },
       };
     }
 
-    static get observers() {
-      return [
-        '_themeChanged(_theme, _overflow, _container)',
-        '__hasOverflowChanged(_hasOverflow, _overflow)',
-        '__i18nChanged(__effectiveI18n, _overflow)',
-        '__updateButtons(items, disabled, _overflow, _container)',
-        '_reverseCollapseChanged(reverseCollapse, _overflow, _container)',
-        '_tabNavigationChanged(tabNavigation, _overflow, _container)',
-      ];
-    }
-
     /**
      * The object used to localize this component. To change the default
      * localization, replace this with an object that provides all properties, or
@@ -309,8 +275,15 @@ export const MenuBarMixin = (superClass) =>
     }
 
     /** @private */
-    get _subMenu() {
-      return this.shadowRoot.querySelector('vaadin-menu-bar-submenu');
+    get _hasOverflow() {
+      return this._overflow && !this._overflow.hasAttribute('hidden');
+    }
+
+    /** @private */
+    set _hasOverflow(hasOverflow) {
+      if (this._overflow) {
+        this._overflow.toggleAttribute('hidden', !hasOverflow);
+      }
     }
 
     /** @protected */
@@ -319,6 +292,20 @@ export const MenuBarMixin = (superClass) =>
 
       this.setAttribute('role', 'menubar');
 
+      this._subMenuController = new SlotController(this, 'submenu', 'vaadin-menu-bar-submenu', {
+        initializer: (menu) => {
+          menu.setAttribute('is-root', '');
+
+          menu.addEventListener('item-selected', this.__onItemSelected.bind(this));
+          menu.addEventListener('close-all-menus', this.__onEscapeClose.bind(this));
+
+          const overlay = menu._overlayElement;
+          overlay._contentRoot.addEventListener('keydown', this.__boundOnContextMenuKeydown);
+
+          this._subMenu = menu;
+        },
+      });
+
       this._overflowController = new SlotController(this, 'overflow', 'vaadin-menu-bar-button', {
         initializer: (btn) => {
           btn.setAttribute('hidden', '');
@@ -335,21 +322,51 @@ export const MenuBarMixin = (superClass) =>
           this._overflow = btn;
         },
       });
+
+      this.addController(this._subMenuController);
       this.addController(this._overflowController);
 
       this.addEventListener('mousedown', () => this._hideTooltip(true));
       this.addEventListener('mouseleave', () => this._hideTooltip());
 
-      this._subMenu.addEventListener('item-selected', this.__onItemSelected.bind(this));
-      this._subMenu.addEventListener('close-all-menus', this.__onEscapeClose.bind(this));
+      this._container = this.shadowRoot.querySelector('[part="container"]');
+    }
 
-      const overlay = this._subMenu._overlayElement;
-      overlay.addEventListener('keydown', this.__boundOnContextMenuKeydown);
+    /** @protected */
+    updated(props) {
+      super.updated(props);
+
+      if (props.has('items') || props.has('_theme') || props.has('disabled')) {
+        this.__renderButtons(this.items);
+      }
 
-      const container = this.shadowRoot.querySelector('[part="container"]');
-      container.addEventListener('click', this.__onButtonClick.bind(this));
-      container.addEventListener('mouseover', (e) => this._onMouseOver(e));
-      this._container = container;
+      if (props.has('items') || props.has('_theme') || props.has('reverseCollapse')) {
+        this.__scheduleOverflow();
+      }
+
+      if (props.has('items')) {
+        this.__updateSubMenu();
+      }
+
+      if (props.has('overlayClass')) {
+        this._subMenu.overlayClass = this.overlayClass;
+      }
+
+      if (props.has('_theme')) {
+        this._themeChanged(this._theme);
+      }
+
+      if (props.has('disabled')) {
+        this._overflow.toggleAttribute('disabled', this.disabled);
+      }
+
+      if (props.has('tabNavigation')) {
+        this._tabNavigationChanged(this.tabNavigation);
+      }
+
+      if (props.has('__effectiveI18n')) {
+        this.__i18nChanged(this.__effectiveI18n);
+      }
     }
 
     /**
@@ -381,81 +398,34 @@ export const MenuBarMixin = (superClass) =>
       this.__scheduleOverflow();
     }
 
-    /**
-     * A callback for the `_theme` property observer.
-     * It propagates the host theme to the buttons and the sub menu.
-     *
-     * @param {string | null} theme
-     * @private
-     */
-    _themeChanged(theme, overflow, container) {
-      if (overflow && container) {
-        this.__renderButtons(this.items);
-        this.__scheduleOverflow();
-
-        if (theme) {
-          overflow.setAttribute('theme', theme);
-          this._subMenu.setAttribute('theme', theme);
-        } else {
-          overflow.removeAttribute('theme');
-          this._subMenu.removeAttribute('theme');
-        }
-      }
-    }
-
-    /**
-     * A callback for the 'reverseCollapse' property observer.
-     *
-     * @param {boolean | null} _reverseCollapse
-     * @private
-     */
-    _reverseCollapseChanged(_reverseCollapse, overflow, container) {
-      if (overflow && container) {
-        this.__scheduleOverflow();
-      }
-    }
-
     /** @private */
-    _tabNavigationChanged(tabNavigation, overflow, container) {
-      if (overflow && container) {
-        const target = this.querySelector('[tabindex="0"]');
-        this._buttons.forEach((btn) => {
-          if (target) {
-            this._setTabindex(btn, btn === target);
-          } else {
-            this._setTabindex(btn, false);
-          }
-          btn.setAttribute('role', tabNavigation ? 'button' : 'menuitem');
-        });
+    _themeChanged(theme) {
+      if (theme) {
+        this._overflow.setAttribute('theme', theme);
+        this._subMenu.setAttribute('theme', theme);
+      } else {
+        this._overflow.removeAttribute('theme');
+        this._subMenu.removeAttribute('theme');
       }
-      this.setAttribute('role', tabNavigation ? 'group' : 'menubar');
     }
 
     /** @private */
-    __hasOverflowChanged(hasOverflow, overflow) {
-      if (overflow) {
-        overflow.toggleAttribute('hidden', !hasOverflow);
-      }
+    _tabNavigationChanged(tabNavigation) {
+      const target = this.querySelector('[tabindex="0"]');
+      this._buttons.forEach((btn) => {
+        if (target) {
+          this._setTabindex(btn, btn === target);
+        } else {
+          this._setTabindex(btn, false);
+        }
+        btn.setAttribute('role', tabNavigation ? 'button' : 'menuitem');
+      });
+
+      this.setAttribute('role', tabNavigation ? 'group' : 'menubar');
     }
 
     /** @private */
-    __updateButtons(items, disabled, overflow, container) {
-      if (!overflow || !container) {
-        return;
-      }
-
-      if (items !== this._oldItems) {
-        this._oldItems = items;
-        this.__renderButtons(items);
-        this.__scheduleOverflow();
-      }
-
-      if (disabled !== this._oldDisabled) {
-        this._oldDisabled = disabled;
-        this.__renderButtons(items);
-        overflow.toggleAttribute('disabled', disabled);
-      }
-
+    __updateSubMenu() {
       const subMenu = this._subMenu;
       if (subMenu && subMenu.opened) {
         const button = subMenu._overlayElement.positionTarget;
@@ -469,12 +439,12 @@ export const MenuBarMixin = (superClass) =>
     }
 
     /** @private */
-    __i18nChanged(effectiveI18n, overflow) {
-      if (overflow && effectiveI18n && effectiveI18n.moreOptions !== undefined) {
+    __i18nChanged(effectiveI18n) {
+      if (effectiveI18n && effectiveI18n.moreOptions !== undefined) {
         if (effectiveI18n.moreOptions) {
-          overflow.setAttribute('aria-label', effectiveI18n.moreOptions);
+          this._overflow.setAttribute('aria-label', effectiveI18n.moreOptions);
         } else {
-          overflow.removeAttribute('aria-label');
+          this._overflow.removeAttribute('aria-label');
         }
       }
     }
@@ -708,6 +678,7 @@ export const MenuBarMixin = (superClass) =>
     _hideTooltip(immediate) {
       const tooltip = this._tooltipController && this._tooltipController.node;
       if (tooltip) {
+        this._tooltipController.setContext({ item: null });
         tooltip._stateController.close(immediate);
       }
     }
@@ -771,6 +742,34 @@ export const MenuBarMixin = (superClass) =>
       return Array.from(e.composedPath()).find((el) => el.localName === 'vaadin-menu-bar-button');
     }
 
+    /**
+     * Override method inherited from `FocusMixin`
+     *
+     * @override
+     * @protected
+     */
+    _shouldSetFocus(event) {
+      // Ignore events from the submenu
+      if (event.composedPath().includes(this._subMenu)) {
+        return false;
+      }
+      return super._shouldSetFocus(event);
+    }
+
+    /**
+     * Override method inherited from `FocusMixin`
+     *
+     * @override
+     * @protected
+     */
+    _shouldRemoveFocus(event) {
+      // Ignore events from the submenu
+      if (event.composedPath().includes(this._subMenu)) {
+        return false;
+      }
+      return super._shouldRemoveFocus(event);
+    }
+
     /**
      * Override method inherited from `FocusMixin`
      *
@@ -853,6 +852,16 @@ export const MenuBarMixin = (superClass) =>
      * @override
      */
     _onKeyDown(event) {
+      // Ignore events from the submenu
+      if (event.composedPath().includes(this._subMenu)) {
+        return;
+      }
+
+      this._handleKeyDown(event);
+    }
+
+    /** @private */
+    _handleKeyDown(event) {
       switch (event.key) {
         case 'ArrowDown':
           this._onArrowDown(event);
@@ -867,11 +876,16 @@ export const MenuBarMixin = (superClass) =>
     }
 
     /**
-     * @param {!MouseEvent} e
+     * @param {!MouseEvent} event
      * @protected
      */
-    _onMouseOver(e) {
-      const button = this._getButtonFromEvent(e);
+    _onMouseOver(event) {
+      // Ignore events from the submenu
+      if (event.composedPath().includes(this._subMenu)) {
+        return;
+      }
+
+      const button = this._getButtonFromEvent(event);
       if (!button) {
         // Hide tooltip on mouseover to disabled button
         this._hideTooltip();
@@ -903,11 +917,11 @@ export const MenuBarMixin = (superClass) =>
         if (e.keyCode === 37 || (e.keyCode === 39 && !item._item.children)) {
           // Prevent ArrowLeft from being handled in context-menu
           e.stopImmediatePropagation();
-          this._onKeyDown(e);
+          this._handleKeyDown(e);
         }
 
         if (e.key === 'Tab' && this.tabNavigation) {
-          this._onKeyDown(e);
+          this._handleKeyDown(e);
         }
       }
     }
@@ -990,13 +1004,13 @@ export const MenuBarMixin = (superClass) =>
 
     /** @private */
     _focusFirstItem() {
-      const list = this._subMenu._overlayElement.firstElementChild;
+      const list = this._subMenu._overlayElement._contentRoot.firstElementChild;
       list.focus();
     }
 
     /** @private */
     _focusLastItem() {
-      const list = this._subMenu._overlayElement.firstElementChild;
+      const list = this._subMenu._overlayElement._contentRoot.firstElementChild;
       const item = list.items[list.items.length - 1];
       if (item) {
         item.focus();

package/src/vaadin-menu-bar-overlay.js

@@ -3,18 +3,15 @@
  * Copyright (c) 2019 - 2025 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
-import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
+import { html, LitElement } from 'lit';
 import { defineCustomElement } from '@vaadin/component-base/src/define.js';
 import { DirMixin } from '@vaadin/component-base/src/dir-mixin.js';
+import { PolylitMixin } from '@vaadin/component-base/src/polylit-mixin.js';
 import { MenuOverlayMixin } from '@vaadin/context-menu/src/vaadin-menu-overlay-mixin.js';
-import { styles } from '@vaadin/context-menu/src/vaadin-menu-overlay-styles.js';
 import { OverlayMixin } from '@vaadin/overlay/src/vaadin-overlay-mixin.js';
-import { overlayStyles } from '@vaadin/overlay/src/vaadin-overlay-styles.js';
-import { registerStyles, ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
-
-registerStyles('vaadin-menu-bar-overlay', [overlayStyles, styles], {
-  moduleId: 'vaadin-menu-bar-overlay-styles',
-});
+import { LumoInjectionMixin } from '@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js';
+import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
+import { menuBarOverlayStyles } from './styles/vaadin-menu-bar-overlay-core-styles.js';
 
 /**
  * An element used internally by `<vaadin-menu-bar>`. Not intended to be used separately.
@@ -27,17 +24,25 @@ registerStyles('vaadin-menu-bar-overlay', [overlayStyles, styles], {
  * @mixes ThemableMixin
  * @protected
  */
-export class MenuBarOverlay extends MenuOverlayMixin(OverlayMixin(DirMixin(ThemableMixin(PolymerElement)))) {
+export class MenuBarOverlay extends MenuOverlayMixin(
+  OverlayMixin(DirMixin(ThemableMixin(PolylitMixin(LumoInjectionMixin(LitElement))))),
+) {
   static get is() {
     return 'vaadin-menu-bar-overlay';
   }
 
-  static get template() {
+  static get styles() {
+    return menuBarOverlayStyles;
+  }
+
+  /** @protected */
+  render() {
     return html`
-      <div id="backdrop" part="backdrop" hidden$="[[!withBackdrop]]"></div>
+      <div id="backdrop" part="backdrop" ?hidden="${!this.withBackdrop}"></div>
       <div part="overlay" id="overlay" tabindex="0">
         <div part="content" id="content">
           <slot></slot>
+          <slot name="submenu"></slot>
         </div>
       </div>
     `;

package/src/vaadin-menu-bar-submenu-mixin.js

@@ -31,8 +31,8 @@ export const SubMenuMixin = (superClass) =>
     /**
      * Overriding the observer to not add global "contextmenu" listener.
      */
-    _openedChanged(opened) {
-      this._overlayElement.opened = opened;
+    _openedChanged() {
+      // Do nothing
     }
 
     /**
@@ -43,7 +43,7 @@ export const SubMenuMixin = (superClass) =>
 
       // Only handle 1st level submenu
       if (this.hasAttribute('is-root')) {
-        this.getRootNode().host._close();
+        this.parentElement._close();
       }
     }
 

package/src/vaadin-menu-bar-submenu.js

@@ -6,9 +6,10 @@
 import './vaadin-menu-bar-item.js';
 import './vaadin-menu-bar-list-box.js';
 import './vaadin-menu-bar-overlay.js';
-import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
-import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
+import { css, html, LitElement } from 'lit';
+import { ifDefined } from 'lit/directives/if-defined.js';
 import { defineCustomElement } from '@vaadin/component-base/src/define.js';
+import { PolylitMixin } from '@vaadin/component-base/src/polylit-mixin.js';
 import { ThemePropertyMixin } from '@vaadin/vaadin-themable-mixin/vaadin-theme-property-mixin.js';
 import { SubMenuMixin } from './vaadin-menu-bar-submenu-mixin.js';
 
@@ -17,43 +18,48 @@ import { SubMenuMixin } from './vaadin-menu-bar-submenu-mixin.js';
  *
  * @customElement
  * @extends HTMLElement
- * @mixes ControllerMixin
  * @mixes SubMenuMixin
  * @mixes ThemePropertyMixin
  * @protected
  */
-class MenuBarSubmenu extends SubMenuMixin(ControllerMixin(ThemePropertyMixin(PolymerElement))) {
+class MenuBarSubmenu extends SubMenuMixin(ThemePropertyMixin(PolylitMixin(LitElement))) {
   static get is() {
     return 'vaadin-menu-bar-submenu';
   }
 
-  static get template() {
-    return html`
-      <style>
-        :host {
-          display: block;
-        }
-
-        :host([hidden]) {
-          display: none !important;
-        }
-      </style>
+  static get styles() {
+    return css`
+      :host {
+        display: block;
+      }
 
-      <slot id="slot"></slot>
+      :host([hidden]) {
+        display: none !important;
+      }
     `;
   }
 
-  /**
-   * @param {DocumentFragment} dom
-   * @return {ShadowRoot}
-   * @protected
-   * @override
-   */
-  _attachDom(dom) {
-    const root = this.attachShadow({ mode: 'open' });
-    root.appendChild(dom);
-    root.appendChild(this._overlayElement);
-    return root;
+  /** @protected */
+  render() {
+    return html`
+      <vaadin-menu-bar-overlay
+        id="overlay"
+        .owner="${this}"
+        .opened="${this.opened}"
+        .model="${this._context}"
+        .modeless="${this._modeless}"
+        .renderer="${this.__itemsRenderer}"
+        .withBackdrop="${this._phone}"
+        ?phone="${this._phone}"
+        theme="${ifDefined(this._theme)}"
+        exportparts="backdrop, overlay, content"
+        @opened-changed="${this._onOverlayOpened}"
+        @vaadin-overlay-open="${this._onVaadinOverlayOpen}"
+      >
+        <slot name="overlay"></slot>
+        <slot name="submenu" slot="submenu"></slot>
+      </vaadin-menu-bar-overlay>
+    `;
   }
 }
 

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

@@ -30,13 +30,13 @@ export interface MenuBarEventMap<TItem extends MenuBarItem = MenuBarItem>
  *
  * To create the menu bar, first add the component to the page:
  *
- * ```
+ * ```html
  * <vaadin-menu-bar></vaadin-menu-bar>
  * ```
  *
  * And then use [`items`](#/elements/vaadin-menu-bar#property-items) property to initialize the structure:
  *
- * ```
+ * ```js
  * document.querySelector('vaadin-menu-bar').items = [{text: 'File'}, {text: 'Edit'}];
  * ```
  *
@@ -65,7 +65,7 @@ export interface MenuBarEventMap<TItem extends MenuBarItem = MenuBarItem>
  * - `<vaadin-menu-bar-button>` - has the same API as [`<vaadin-button>`](#/elements/vaadin-button).
  * - `<vaadin-menu-bar-item>` - has the same API as [`<vaadin-item>`](#/elements/vaadin-item).
  * - `<vaadin-menu-bar-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).
- * - `<vaadin-menu-bar-overlay>` - has the same API as [`<vaadin-overlay>`](#/elements/vaadin-overlay).
+ * - `<vaadin-menu-bar-submenu>` - has the same API as [`<vaadin-context-menu>`](#/elements/vaadin-context-menu).
  *
  * The `<vaadin-menu-bar-item>` sub-menu elements have the following additional state attributes
  * on top of the built-in `<vaadin-item>` state attributes:
@@ -74,9 +74,6 @@ export interface MenuBarEventMap<TItem extends MenuBarItem = MenuBarItem>
  * ---------- |-------------
  * `expanded` | Expanded parent item.
  *
- * Note: the `theme` attribute value set on `<vaadin-menu-bar>` is
- * propagated to the internal components listed above.
- *
  * @fires {CustomEvent} item-selected - Fired when a submenu item or menu bar button without children is clicked.
  */
 declare class MenuBar<TItem extends MenuBarItem = MenuBarItem> extends HTMLElement {