@vaadin/menu-bar 24.4.0-dev.b3e1d14600 → 24.4.0-rc2

package/README.md

@@ -5,7 +5,6 @@ A web component for creating a horizontal button bar with hierarchical drop-down
 [Documentation + Live Demo ↗](https://vaadin.com/docs/latest/components/menu-bar)
 
 [![npm version](https://badgen.net/npm/v/@vaadin/menu-bar)](https://www.npmjs.com/package/@vaadin/menu-bar)
-[![Discord](https://img.shields.io/discord/732335336448852018?label=discord)](https://discord.gg/PHmkCKC)
 
 ```html
 <vaadin-menu-bar></vaadin-menu-bar>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/menu-bar",
-  "version": "24.4.0-dev.b3e1d14600",
+  "version": "24.4.0-rc2",
   "publishConfig": {
     "access": "public"
   },
@@ -24,6 +24,8 @@
     "theme",
     "vaadin-*.d.ts",
     "vaadin-*.js",
+    "!vaadin-lit-*.d.ts",
+    "!vaadin-lit-*.js",
     "web-types.json",
     "web-types.lit.json"
   ],
@@ -37,20 +39,21 @@
   "dependencies": {
     "@open-wc/dedupe-mixin": "^1.3.0",
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/a11y-base": "24.4.0-dev.b3e1d14600",
-    "@vaadin/button": "24.4.0-dev.b3e1d14600",
-    "@vaadin/component-base": "24.4.0-dev.b3e1d14600",
-    "@vaadin/context-menu": "24.4.0-dev.b3e1d14600",
-    "@vaadin/item": "24.4.0-dev.b3e1d14600",
-    "@vaadin/list-box": "24.4.0-dev.b3e1d14600",
-    "@vaadin/overlay": "24.4.0-dev.b3e1d14600",
-    "@vaadin/vaadin-lumo-styles": "24.4.0-dev.b3e1d14600",
-    "@vaadin/vaadin-material-styles": "24.4.0-dev.b3e1d14600",
-    "@vaadin/vaadin-themable-mixin": "24.4.0-dev.b3e1d14600"
+    "@vaadin/a11y-base": "24.4.0-rc2",
+    "@vaadin/button": "24.4.0-rc2",
+    "@vaadin/component-base": "24.4.0-rc2",
+    "@vaadin/context-menu": "24.4.0-rc2",
+    "@vaadin/item": "24.4.0-rc2",
+    "@vaadin/list-box": "24.4.0-rc2",
+    "@vaadin/overlay": "24.4.0-rc2",
+    "@vaadin/vaadin-lumo-styles": "24.4.0-rc2",
+    "@vaadin/vaadin-material-styles": "24.4.0-rc2",
+    "@vaadin/vaadin-themable-mixin": "24.4.0-rc2",
+    "lit": "^3.0.0"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
-    "@vaadin/icon": "24.4.0-dev.b3e1d14600",
+    "@vaadin/icon": "24.4.0-rc2",
     "@vaadin/testing-helpers": "^0.6.0",
     "sinon": "^13.0.2"
   },
@@ -58,5 +61,5 @@
     "web-types.json",
     "web-types.lit.json"
   ],
-  "gitHead": "502d4f5b03f770a83d270d98078cde230254dd0e"
+  "gitHead": "ea3d99e8cf67a337e959d5cab849f80464c7c7e5"
 }

package/src/vaadin-lit-menu-bar-button.js

@@ -0,0 +1,58 @@
+/**
+ * @license
+ * Copyright (c) 2019 - 2024 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import { Button } from '@vaadin/button/src/vaadin-lit-button.js';
+import { defineCustomElement } from '@vaadin/component-base/src/define.js';
+import { css } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
+
+/**
+ * An element used internally by `<vaadin-menu-bar>`. Not intended to be used separately.
+ *
+ * @customElement
+ * @extends Button
+ * @private
+ */
+class MenuBarButton extends Button {
+  static get is() {
+    return 'vaadin-menu-bar-button';
+  }
+
+  static get styles() {
+    return [
+      super.styles,
+      css`
+        :host {
+          flex-shrink: 0;
+        }
+
+        :host([slot='overflow']) {
+          margin-inline-end: 0;
+        }
+
+        [part='label'] ::slotted(vaadin-menu-bar-item) {
+          position: relative;
+          z-index: 1;
+        }
+      `,
+    ];
+  }
+
+  /**
+   * Override method inherited from `ButtonMixin` to set a flag based on whether the key
+   * is Enter and Space. Unlike mouse click, these keys should also focus the first item.
+   * This flag is used in menu bar to identify the action that triggered the click.
+   *
+   * @param {KeyboardEvent} event
+   * @protected
+   * @override
+   */
+  _onKeyDown(event) {
+    this.__triggeredWithActiveKeys = this._activeKeys.includes(event.key);
+    super._onKeyDown(event);
+    this.__triggeredWithActiveKeys = null;
+  }
+}
+
+defineCustomElement(MenuBarButton);

package/src/vaadin-lit-menu-bar-item.js

@@ -0,0 +1,62 @@
+/**
+ * @license
+ * Copyright (c) 2019 - 2024 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import { css, 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 { ItemMixin } from '@vaadin/item/src/vaadin-item-mixin.js';
+import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
+
+/**
+ * An element used internally by `<vaadin-menu-bar>`. Not intended to be used separately.
+ *
+ * @customElement
+ * @extends HTMLElement
+ * @mixes DirMixin
+ * @mixes ItemMixin
+ * @mixes ThemableMixin
+ * @protected
+ */
+class MenuBarItem extends ItemMixin(ThemableMixin(DirMixin(PolylitMixin(LitElement)))) {
+  static get is() {
+    return 'vaadin-menu-bar-item';
+  }
+
+  static get styles() {
+    return css`
+      :host {
+        display: inline-block;
+      }
+
+      :host([hidden]) {
+        display: none !important;
+      }
+    `;
+  }
+
+  /** @protected */
+  render() {
+    return html`
+      <span part="checkmark" aria-hidden="true"></span>
+      <div part="content">
+        <slot></slot>
+      </div>
+    `;
+  }
+
+  /** @protected */
+  connectedCallback() {
+    super.connectedCallback();
+
+    // Set role in `connectedCallback()` instead of `ready()`
+    // because the role is removed when teleporting to button.
+    this.setAttribute('role', 'menuitem');
+  }
+}
+
+defineCustomElement(MenuBarItem);
+
+export { MenuBarItem };

package/src/vaadin-lit-menu-bar-list-box.js

@@ -0,0 +1,87 @@
+/**
+ * @license
+ * Copyright (c) 2019 - 2024 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import { css, html, LitElement } from 'lit';
+import { ListMixin } from '@vaadin/a11y-base/src/list-mixin.js';
+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 { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
+
+/**
+ * An element used internally by `<vaadin-menu-bar>`. Not intended to be used separately.
+ *
+ * @customElement
+ * @extends HTMLElement
+ * @mixes DirMixin
+ * @mixes ListMixin
+ * @mixes ThemableMixin
+ * @protected
+ */
+class MenuBarListBox extends ListMixin(ThemableMixin(DirMixin(PolylitMixin(LitElement)))) {
+  static get is() {
+    return 'vaadin-menu-bar-list-box';
+  }
+
+  static get styles() {
+    return css`
+      :host {
+        display: flex;
+      }
+
+      :host([hidden]) {
+        display: none !important;
+      }
+
+      [part='items'] {
+        height: 100%;
+        width: 100%;
+        overflow-y: auto;
+        -webkit-overflow-scrolling: touch;
+      }
+    `;
+  }
+
+  static get properties() {
+    return {
+      // We don't need to define this property since super default is vertical,
+      // but we don't want it to be modified, or be shown in the API docs.
+      /** @private */
+      orientation: {
+        type: String,
+        readOnly: true,
+      },
+    };
+  }
+
+  /**
+   * @return {!HTMLElement}
+   * @protected
+   * @override
+   */
+  get _scrollerElement() {
+    return this.shadowRoot.querySelector('[part="items"]');
+  }
+
+  /** @protected */
+  render() {
+    return html`
+      <div part="items">
+        <slot></slot>
+      </div>
+    `;
+  }
+
+  /** @protected */
+  ready() {
+    super.ready();
+
+    this.setAttribute('role', 'menu');
+  }
+}
+
+defineCustomElement(MenuBarListBox);
+
+export { MenuBarListBox };

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

@@ -0,0 +1,65 @@
+/**
+ * @license
+ * Copyright (c) 2019 - 2024 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+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 { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
+
+/**
+ * An element used internally by `<vaadin-menu-bar>`. Not intended to be used separately.
+ *
+ * @customElement
+ * @extends HTMLElement
+ * @mixes DirMixin
+ * @mixes MenuOverlayMixin
+ * @mixes OverlayMixin
+ * @mixes ThemableMixin
+ * @protected
+ */
+export class MenuBarOverlay extends MenuOverlayMixin(OverlayMixin(DirMixin(ThemableMixin(PolylitMixin(LitElement))))) {
+  static get is() {
+    return 'vaadin-menu-bar-overlay';
+  }
+
+  static get properties() {
+    return {
+      /**
+       * When true, the overlay is visible and attached to body.
+       * This property config is overridden to set `sync: true`.
+       */
+      opened: {
+        type: Boolean,
+        notify: true,
+        observer: '_openedChanged',
+        reflectToAttribute: true,
+        sync: true,
+      },
+    };
+  }
+
+  static get styles() {
+    return [overlayStyles, styles];
+  }
+
+  /** @protected */
+  render() {
+    return html`
+      <div id="backdrop" part="backdrop" ?hidden="${!this.withBackdrop}"></div>
+      <div part="overlay" id="overlay" tabindex="0">
+        <div part="content" id="content">
+          <slot></slot>
+        </div>
+      </div>
+    `;
+  }
+}
+
+defineCustomElement(MenuBarOverlay);

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

@@ -0,0 +1,93 @@
+/**
+ * @license
+ * Copyright (c) 2019 - 2024 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import './vaadin-lit-menu-bar-item.js';
+import './vaadin-lit-menu-bar-list-box.js';
+import './vaadin-lit-menu-bar-overlay.js';
+import { css, html, LitElement } from 'lit';
+import { defineCustomElement } from '@vaadin/component-base/src/define.js';
+import { OverlayClassMixin } from '@vaadin/component-base/src/overlay-class-mixin.js';
+import { PolylitMixin } from '@vaadin/component-base/src/polylit-mixin.js';
+import { ContextMenuMixin } from '@vaadin/context-menu/src/vaadin-context-menu-mixin.js';
+import { ThemePropertyMixin } from '@vaadin/vaadin-themable-mixin/vaadin-theme-property-mixin.js';
+
+/**
+ * An element used internally by `<vaadin-menu-bar>`. Not intended to be used separately.
+ *
+ * @customElement
+ * @extends HTMLElement
+ * @mixes ContextMenuMixin
+ * @mixes OverlayClassMixin
+ * @mixes ThemePropertyMixin
+ * @protected
+ */
+class MenuBarSubmenu extends ContextMenuMixin(OverlayClassMixin(ThemePropertyMixin(PolylitMixin(LitElement)))) {
+  static get is() {
+    return 'vaadin-menu-bar-submenu';
+  }
+
+  static get styles() {
+    return css`
+      :host {
+        display: block;
+      }
+
+      :host([hidden]) {
+        display: none !important;
+      }
+    `;
+  }
+
+  constructor() {
+    super();
+
+    this.openOn = 'opensubmenu';
+  }
+
+  /**
+   * Tag name prefix used by overlay, list-box and items.
+   * @protected
+   * @return {string}
+   */
+  get _tagNamePrefix() {
+    return 'vaadin-menu-bar';
+  }
+
+  /** @protected */
+  render() {
+    return html`<slot id="slot"></slot>`;
+  }
+
+  /**
+   * @protected
+   * @override
+   */
+  createRenderRoot() {
+    const root = super.createRenderRoot();
+    root.appendChild(this._overlayElement);
+    return root;
+  }
+
+  /**
+   * Overriding the observer to not add global "contextmenu" listener.
+   */
+  _openedChanged(opened) {
+    this._overlayElement.opened = opened;
+  }
+
+  /**
+   * Overriding the public method to reset expanded button state.
+   */
+  close() {
+    super.close();
+
+    // Only handle 1st level submenu
+    if (this.hasAttribute('is-root')) {
+      this.getRootNode().host._close();
+    }
+  }
+}
+
+defineCustomElement(MenuBarSubmenu);

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

@@ -0,0 +1,83 @@
+/**
+ * @license
+ * Copyright (c) 2019 - 2024 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import './vaadin-lit-menu-bar-submenu.js';
+import './vaadin-lit-menu-bar-button.js';
+import { css, html, LitElement } from 'lit';
+import { defineCustomElement } from '@vaadin/component-base/src/define.js';
+import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
+import { PolylitMixin } from '@vaadin/component-base/src/polylit-mixin.js';
+import { TooltipController } from '@vaadin/component-base/src/tooltip-controller.js';
+import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
+import { MenuBarMixin } from './vaadin-menu-bar-mixin.js';
+
+/**
+ * LitElement based version of `<vaadin-menu-bar>` web component.
+ *
+ * ## Disclaimer
+ *
+ * This component is an experiment not intended for publishing to npm.
+ * There is no ETA regarding specific Vaadin version where it'll land.
+ * Feel free to try this code in your apps as per Apache 2.0 license.
+ */
+class MenuBar extends MenuBarMixin(ElementMixin(ThemableMixin(PolylitMixin(LitElement)))) {
+  static get is() {
+    return 'vaadin-menu-bar';
+  }
+
+  static get styles() {
+    return css`
+      :host {
+        display: block;
+      }
+
+      :host([hidden]) {
+        display: none !important;
+      }
+
+      [part='container'] {
+        position: relative;
+        display: flex;
+        width: 100%;
+        flex-wrap: nowrap;
+        overflow: hidden;
+      }
+    `;
+  }
+
+  /** @protected */
+  render() {
+    return html`
+      <div part="container">
+        <slot></slot>
+        <slot name="overflow"></slot>
+      </div>
+      <vaadin-menu-bar-submenu is-root .overlayClass="${this.overlayClass}"></vaadin-menu-bar-submenu>
+
+      <slot name="tooltip"></slot>
+    `;
+  }
+
+  /** @protected */
+  ready() {
+    super.ready();
+
+    this._tooltipController = new TooltipController(this);
+    this._tooltipController.setManual(true);
+    this.addController(this._tooltipController);
+  }
+
+  /**
+   * Fired when either a submenu item or menu bar button without nested children is clicked.
+   *
+   * @event item-selected
+   * @param {Object} detail
+   * @param {Object} detail.value the selected menu bar item
+   */
+}
+
+defineCustomElement(MenuBar);
+
+export { MenuBar };

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

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2019 - 2023 Vaadin Ltd.
+ * Copyright (c) 2019 - 2024 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { Button } from '@vaadin/button/src/vaadin-button.js';
@@ -37,6 +37,19 @@ class MenuBarButton extends Button {
   static get is() {
     return 'vaadin-menu-bar-button';
   }
+
+  /**
+   * Override method inherited from `ButtonMixin`. Sets a flag based on whether the key is an active key. Unlike a mouse click, Enter and Space should also focus the first item. This flag is used in menu bar to identify the action that triggered the click.
+   *
+   * @param {KeyboardEvent} event
+   * @protected
+   * @override
+   */
+  _onKeyDown(event) {
+    this.__triggeredWithActiveKeys = this._activeKeys.includes(event.key);
+    super._onKeyDown(event);
+    this.__triggeredWithActiveKeys = null;
+  }
 }
 
 defineCustomElement(MenuBarButton);

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

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2019 - 2023 Vaadin Ltd.
+ * Copyright (c) 2019 - 2024 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { DirMixin } from '@vaadin/component-base/src/dir-mixin.js';

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

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2019 - 2023 Vaadin Ltd.
+ * Copyright (c) 2019 - 2024 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';

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

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2019 - 2023 Vaadin Ltd.
+ * Copyright (c) 2019 - 2024 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { ListMixin } from '@vaadin/a11y-base/src/list-mixin.js';

package/src/vaadin-menu-bar-list-box.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2019 - 2023 Vaadin Ltd.
+ * Copyright (c) 2019 - 2024 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';

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

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2019 - 2023 Vaadin Ltd.
+ * Copyright (c) 2019 - 2024 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import type { Constructor } from '@open-wc/dedupe-mixin';
@@ -138,6 +138,18 @@ export declare class MenuBarMixinClass {
    */
   openOnHover: boolean | null | undefined;
 
+  /**
+   * If true, the buttons will be collapsed into the overflow menu
+   * starting from the "start" end of the bar instead of the "end".
+   * @attr {boolean} reverse-collapse
+   */
+  reverseCollapse: boolean | null | undefined;
+
+  /**
+   * Closes the current submenu.
+   */
+  close(): void;
+
   protected readonly _buttons: HTMLElement[];
 
   protected readonly _container: HTMLElement;