@vaadin/menu-bar 25.3.0 → 25.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/menu-bar",
-  "version": "25.3.0",
+  "version": "25.3.1",
   "publishConfig": {
     "access": "public"
   },
@@ -35,23 +35,23 @@
   ],
   "dependencies": {
     "@open-wc/dedupe-mixin": "^1.3.0",
-    "@vaadin/a11y-base": "~25.3.0",
-    "@vaadin/button": "~25.3.0",
-    "@vaadin/component-base": "~25.3.0",
-    "@vaadin/context-menu": "~25.3.0",
-    "@vaadin/item": "~25.3.0",
-    "@vaadin/list-box": "~25.3.0",
-    "@vaadin/overlay": "~25.3.0",
-    "@vaadin/vaadin-themable-mixin": "~25.3.0",
+    "@vaadin/a11y-base": "~25.3.1",
+    "@vaadin/button": "~25.3.1",
+    "@vaadin/component-base": "~25.3.1",
+    "@vaadin/context-menu": "~25.3.1",
+    "@vaadin/item": "~25.3.1",
+    "@vaadin/list-box": "~25.3.1",
+    "@vaadin/overlay": "~25.3.1",
+    "@vaadin/vaadin-themable-mixin": "~25.3.1",
     "lit": "^3.0.0"
   },
   "devDependencies": {
-    "@vaadin/aura": "~25.3.0",
-    "@vaadin/chai-plugins": "~25.3.0",
-    "@vaadin/icon": "~25.3.0",
-    "@vaadin/test-runner-commands": "~25.3.0",
+    "@vaadin/aura": "~25.3.1",
+    "@vaadin/chai-plugins": "~25.3.1",
+    "@vaadin/icon": "~25.3.1",
+    "@vaadin/test-runner-commands": "~25.3.1",
     "@vaadin/testing-helpers": "^2.0.0",
-    "@vaadin/vaadin-lumo-styles": "~25.3.0",
+    "@vaadin/vaadin-lumo-styles": "~25.3.1",
     "sinon": "^22.0.0"
   },
   "customElements": "custom-elements.json",
@@ -59,5 +59,5 @@
     "web-types.json",
     "web-types.lit.json"
   ],
-  "gitHead": "4133747243c03bf544f6e82cc2ec9f295aaccd65"
+  "gitHead": "a652d6071d7ad5add8465772f14f3efe633066a8"
 }

package/src/styles/vaadin-menu-bar-base-styles.js

@@ -15,6 +15,12 @@ export const menuBarStyles = css`
     display: none !important;
   }
 
+  /* Keep the width measured with all buttons in flow while the host is frozen */
+  :host([overflow-frozen]) {
+    contain: inline-size !important;
+    contain-intrinsic-inline-size: var(--_vaadin-menu-bar-content-width);
+  }
+
   [part='container'] {
     display: flex;
     flex-wrap: nowrap;

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

@@ -57,6 +57,9 @@ const DEFAULT_I18N = {
   moreOptions: 'More options',
 };
 
+// Two client rects of the same edge can differ by float noise, a few 1e-5 px under browser zoom
+const OVERFLOW_TOLERANCE = 0.1;
+
 export const MenuBarMixin = (superClass) =>
   class MenuBarMixinClass extends I18nMixin(
     KeyboardDirectionMixin(ResizeMixin(FocusMixin(DisabledMixin(superClass)))),
@@ -459,7 +462,6 @@ export const MenuBarMixin = (superClass) =>
       buttons.forEach((button) => {
         button.style.visibility = '';
         button.style.position = '';
-        button.style.width = '';
 
         // Teleport item component back from "overflow" sub-menu
         const item = button.item?.component;
@@ -469,6 +471,20 @@ export const MenuBarMixin = (superClass) =>
       });
     }
 
+    /**
+     * Restores all buttons, the overflow button and the state attributes, so that
+     * the measurement does not use the button margins of the previous state.
+     *
+     * @param {!Array<!HTMLElement>} buttons
+     * @private
+     */
+    __restoreState(buttons) {
+      this.__restoreButtons(buttons);
+      this.__updateOverflow([]);
+      this.toggleAttribute('has-single-button', buttons.length === 1);
+      this.__updateVisibleAttributes(buttons);
+    }
+
     /** @private */
     __restoreItem(button, item) {
       button.appendChild(item);
@@ -484,49 +500,154 @@ export const MenuBarMixin = (superClass) =>
       this._hasOverflow = items.length > 0;
     }
 
-    /** @private */
-    __setOverflowItems(buttons, overflow) {
-      const container = this._container;
-
-      // Prevent the container from shrinking while buttons are being hidden.
-      // The host has min-width: 0 so it can shrink inside flex/grid layouts.
-      // Without this lock, hiding a button reduces the host width, which
-      // shrinks the container (width: 100%), shifting all button positions
-      // and causing a cascading collapse where every button appears to overflow.
-      container.style.minWidth = `${container.offsetWidth}px`;
-
-      if (container.offsetWidth < container.scrollWidth) {
-        this._hasOverflow = true;
-
-        const isRTL = this.__isRTL;
-        const containerLeft = container.offsetLeft;
-        const containerWidth = container.offsetWidth;
-
-        const remaining = [...buttons];
-        while (remaining.length) {
-          // The overflow button follows the last remaining one, so its far edge is what has
-          // to fit. Auto margins move the whole row but cannot push that edge past the end.
-          const overflowEnd = isRTL
-            ? containerWidth - (overflow.offsetLeft - containerLeft)
-            : overflow.offsetLeft + overflow.offsetWidth - containerLeft;
-
-          if (overflowEnd <= containerWidth) {
-            break;
-          }
+    /**
+     * Inline end edge of the element, mirrored in RTL. Unlike `offsetWidth` and `scrollWidth`,
+     * the rect keeps the fraction that browser zoom leaves on the width.
+     *
+     * @param {!HTMLElement} el
+     * @return {number}
+     * @private
+     */
+    __getInlineEnd(el) {
+      const { left, right } = el.getBoundingClientRect();
+      return this.__isRTL ? -left : right;
+    }
 
-          const btn = this.reverseCollapse ? remaining.shift() : remaining.pop();
+    /**
+     * Whether the element ends past the container, with the tolerance for fractional widths.
+     *
+     * @param {!HTMLElement} el
+     * @return {boolean}
+     * @private
+     */
+    __isPastContainerEnd(el) {
+      return this.__getInlineEnd(el) > this.__getInlineEnd(this._container) + OVERFLOW_TOLERANCE;
+    }
 
-          // Save width for buttons with component
-          btn.style.width = getComputedStyle(btn).width;
-          btn.style.visibility = 'hidden';
-          btn.style.position = 'absolute';
+    /**
+     * Layout of the buttons, the overflow button and the container, read in one batch
+     * before any button is hidden. Positions are mirrored in RTL so that a larger value
+     * is always further along the inline axis.
+     *
+     * @typedef {object} MenuBarOverflowLayout
+     * @property {number[]} starts Inline start of each button
+     * @property {number[]} ends Inline end of each button
+     * @property {number[]} margins Inline start margin of each button
+     * @property {number} overflowExtent Space the overflow button adds after the last button
+     * @property {number} containerWidth Width of the container
+     * @property {number} contentWidth Width of all buttons and the overflow button in flow
+     */
+
+    /**
+     * @param {!Array<!HTMLElement>} buttons
+     * @param {!HTMLElement} overflow
+     * @return {!MenuBarOverflowLayout}
+     * @private
+     */
+    __getOverflowLayout(buttons, overflow) {
+      const isRTL = this.__isRTL;
+      const rects = buttons.map((btn) => btn.getBoundingClientRect());
+      const ends = rects.map(({ left, right }) => (isRTL ? -left : right));
+      const overflowEnd = this.__getInlineEnd(overflow);
+      const containerRect = this._container.getBoundingClientRect();
+      const containerStart = isRTL ? -containerRect.right : containerRect.left;
+
+      return {
+        starts: rects.map(({ left, right }) => (isRTL ? -right : left)),
+        ends,
+        // `auto` resolves to 0 while the content overflows.
+        margins: buttons.map((btn) => parseFloat(getComputedStyle(btn).marginInlineStart) || 0),
+        overflowExtent: overflowEnd - ends.at(-1),
+        containerWidth: containerRect.width,
+        contentWidth: overflowEnd - containerStart,
+      };
+    }
+
+    /**
+     * Picks the buttons to collapse so that the rest plus the overflow button end inside
+     * the container. Hiding a button only shifts the buttons after it, so the end of any
+     * kept range follows from one measurement.
+     *
+     * @param {!Array<!HTMLElement>} buttons
+     * @param {!MenuBarOverflowLayout} layout
+     * @return {!Array<!HTMLElement>} buttons to collapse, in DOM order
+     * @private
+     */
+    __getButtonsToCollapse(buttons, { starts, ends, margins, overflowExtent, containerWidth }) {
+      let lo = 0;
+      let hi = buttons.length - 1;
+
+      // The first kept button keeps its own start margin in front of the range.
+      while (lo <= hi && margins[lo] + ends[hi] - starts[lo] + overflowExtent > containerWidth + OVERFLOW_TOLERANCE) {
+        if (this.reverseCollapse) {
+          lo += 1;
+        } else {
+          hi -= 1;
         }
+      }
+
+      return buttons.filter((_, i) => i < lo || i > hi);
+    }
 
-        const items = buttons.filter((b) => !remaining.includes(b)).map((b) => b.item);
-        this.__updateOverflow(items);
+    /**
+     * Keeps the intrinsic width of the host at the given value. A parent sized by content,
+     * such as a split layout pane, shrinks the host once the buttons are out of flow. The
+     * width the host had with all buttons in flow keeps the collapse that was decided for it.
+     * The `overflow-frozen` attribute marks the frozen state for the styles and for the next
+     * detection. It is internal and not documented.
+     *
+     * @param {number} width
+     * @private
+     */
+    __freezeWidth(width) {
+      this.style.setProperty('--_vaadin-menu-bar-content-width', `${width}px`);
+      this.setAttribute('overflow-frozen', '');
+    }
+
+    /** @private */
+    __unfreezeWidth() {
+      this.style.removeProperty('--_vaadin-menu-bar-content-width');
+      this.removeAttribute('overflow-frozen');
+    }
+
+    /**
+     * Shows the overflow button and collapses buttons into it when the last button
+     * does not fit in the container. Freezes the host width when the parent shrinks
+     * the host after the collapse. A frozen host stays frozen until all buttons and the
+     * overflow button fit, so that its flex basis does not change between detections
+     * when another element in the same row depends on it.
+     *
+     * @param {!Array<!HTMLElement>} buttons
+     * @param {!HTMLElement} overflow
+     * @private
+     */
+    __setOverflowItems(buttons, overflow) {
+      const lastButton = buttons.at(-1);
+      // A frozen host is as wide as all buttons plus the overflow button, so the quick
+      // check would report a fit one overflow button too early. Measure instead.
+      const wasFrozen = this.hasAttribute('overflow-frozen');
+      if (!lastButton || (!wasFrozen && !this.__isPastContainerEnd(lastButton))) {
+        this.__unfreezeWidth();
+        return;
       }
+      this._hasOverflow = true;
+
+      // Read the layout once the overflow button is in flow
+      const layout = this.__getOverflowLayout(buttons, overflow);
+      const collapsed = this.__getButtonsToCollapse(buttons, layout);
 
-      container.style.minWidth = '';
+      // Write the DOM state
+      collapsed.forEach((btn) => {
+        btn.style.visibility = 'hidden';
+        btn.style.position = 'absolute';
+      });
+      this.__updateOverflow(collapsed.map((btn) => btn.item));
+
+      if (collapsed.length === 0) {
+        this.__unfreezeWidth();
+      } else if (wasFrozen || this.__isPastContainerEnd(overflow)) {
+        this.__freezeWidth(layout.contentWidth);
+      }
     }
 
     /** @private */
@@ -542,9 +663,7 @@ export const MenuBarMixin = (superClass) =>
       const buttons = this._buttons.filter((btn) => btn !== overflow);
       const oldOverflowCount = this.__getOverflowCount(overflow);
 
-      // Reset all buttons in the menu bar and the overflow button
-      this.__restoreButtons(buttons);
-      this.__updateOverflow([]);
+      this.__restoreState(buttons);
 
       // Hide any overflowing buttons and put them in the 'overflow' button
       this.__setOverflowItems(buttons, overflow);
@@ -573,6 +692,11 @@ export const MenuBarMixin = (superClass) =>
         this._setTabindex(visibleButtons[visibleButtons.length - 1], true);
       }
 
+      this.__updateVisibleAttributes(visibleButtons);
+    }
+
+    /** @private */
+    __updateVisibleAttributes(visibleButtons) {
       visibleButtons.forEach((btn, index) => {
         btn.toggleAttribute('first-visible', index === 0);
         btn.toggleAttribute('last-visible', !this._hasOverflow && index === visibleButtons.length - 1);

package/web-types.json

@@ -1,14 +1,14 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/menu-bar",
-  "version": "25.3.0",
+  "version": "25.3.1",
   "description-markup": "markdown",
   "contributions": {
     "html": {
       "elements": [
         {
           "name": "vaadin-menu-bar",
-          "description": "`<vaadin-menu-bar>` is a Web Component providing a set of horizontally stacked buttons offering\nthe user quick access to a consistent set of commands. Each button can toggle a submenu with\nsupport for additional levels of nested menus.\n\nTo create the menu bar, first add the component to the page:\n\n```html\n<vaadin-menu-bar></vaadin-menu-bar>\n```\n\nAnd then use [`items`](https://cdn.vaadin.com/vaadin-web-components/25.3.0/#/elements/vaadin-menu-bar#property-items) property to initialize the structure:\n\n```js\ndocument.querySelector('vaadin-menu-bar').items = [{text: 'File'}, {text: 'Edit'}];\n```\n\n### Styling\n\nThe following shadow DOM parts are exposed for styling:\n\nPart name         | Description\n------------------|----------------\n`container`       | The container wrapping menu bar buttons.\n\nThe following state attributes are available for styling:\n\nAttribute           | Description\n--------------------|----------------------------------\n`disabled`          | Set when the menu bar is disabled\n`has-single-button` | Set when there is only one button visible\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property         |\n:---------------------------|\n| `--vaadin-menu-bar-gap`   |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.\n\n### Internal components\n\nIn addition to `<vaadin-menu-bar>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-menu-bar-button>` - has the same API as [`<vaadin-button>`](https://cdn.vaadin.com/vaadin-web-components/25.3.0/#/elements/vaadin-button).\n- `<vaadin-menu-bar-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/25.3.0/#/elements/vaadin-item).\n- `<vaadin-menu-bar-list-box>` - has the same API as [`<vaadin-list-box>`](https://cdn.vaadin.com/vaadin-web-components/25.3.0/#/elements/vaadin-list-box).\n- `<vaadin-menu-bar-submenu>` - has the same API as [`<vaadin-context-menu>`](https://cdn.vaadin.com/vaadin-web-components/25.3.0/#/elements/vaadin-context-menu).\n\nThe `<vaadin-menu-bar-item>` sub-menu elements have the following additional state attributes\non top of the built-in `<vaadin-item>` state attributes:\n\nAttribute  | Description\n---------- |-------------\n`expanded` | Expanded parent item.",
+          "description": "`<vaadin-menu-bar>` is a Web Component providing a set of horizontally stacked buttons offering\nthe user quick access to a consistent set of commands. Each button can toggle a submenu with\nsupport for additional levels of nested menus.\n\nTo create the menu bar, first add the component to the page:\n\n```html\n<vaadin-menu-bar></vaadin-menu-bar>\n```\n\nAnd then use [`items`](https://cdn.vaadin.com/vaadin-web-components/25.3.1/#/elements/vaadin-menu-bar#property-items) property to initialize the structure:\n\n```js\ndocument.querySelector('vaadin-menu-bar').items = [{text: 'File'}, {text: 'Edit'}];\n```\n\n### Styling\n\nThe following shadow DOM parts are exposed for styling:\n\nPart name         | Description\n------------------|----------------\n`container`       | The container wrapping menu bar buttons.\n\nThe following state attributes are available for styling:\n\nAttribute           | Description\n--------------------|----------------------------------\n`disabled`          | Set when the menu bar is disabled\n`has-single-button` | Set when there is only one button visible\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property         |\n:---------------------------|\n| `--vaadin-menu-bar-gap`   |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.\n\n### Internal components\n\nIn addition to `<vaadin-menu-bar>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-menu-bar-button>` - has the same API as [`<vaadin-button>`](https://cdn.vaadin.com/vaadin-web-components/25.3.1/#/elements/vaadin-button).\n- `<vaadin-menu-bar-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/25.3.1/#/elements/vaadin-item).\n- `<vaadin-menu-bar-list-box>` - has the same API as [`<vaadin-list-box>`](https://cdn.vaadin.com/vaadin-web-components/25.3.1/#/elements/vaadin-list-box).\n- `<vaadin-menu-bar-submenu>` - has the same API as [`<vaadin-context-menu>`](https://cdn.vaadin.com/vaadin-web-components/25.3.1/#/elements/vaadin-context-menu).\n\nThe `<vaadin-menu-bar-item>` sub-menu elements have the following additional state attributes\non top of the built-in `<vaadin-item>` state attributes:\n\nAttribute  | Description\n---------- |-------------\n`expanded` | Expanded parent item.",
           "attributes": [
             {
               "name": "disabled",

package/web-types.lit.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/menu-bar",
-  "version": "25.3.0",
+  "version": "25.3.1",
   "description-markup": "markdown",
   "framework": "lit",
   "framework-config": {
@@ -16,7 +16,7 @@
       "elements": [
         {
           "name": "vaadin-menu-bar",
-          "description": "`<vaadin-menu-bar>` is a Web Component providing a set of horizontally stacked buttons offering\nthe user quick access to a consistent set of commands. Each button can toggle a submenu with\nsupport for additional levels of nested menus.\n\nTo create the menu bar, first add the component to the page:\n\n```html\n<vaadin-menu-bar></vaadin-menu-bar>\n```\n\nAnd then use [`items`](https://cdn.vaadin.com/vaadin-web-components/25.3.0/#/elements/vaadin-menu-bar#property-items) property to initialize the structure:\n\n```js\ndocument.querySelector('vaadin-menu-bar').items = [{text: 'File'}, {text: 'Edit'}];\n```\n\n### Styling\n\nThe following shadow DOM parts are exposed for styling:\n\nPart name         | Description\n------------------|----------------\n`container`       | The container wrapping menu bar buttons.\n\nThe following state attributes are available for styling:\n\nAttribute           | Description\n--------------------|----------------------------------\n`disabled`          | Set when the menu bar is disabled\n`has-single-button` | Set when there is only one button visible\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property         |\n:---------------------------|\n| `--vaadin-menu-bar-gap`   |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.\n\n### Internal components\n\nIn addition to `<vaadin-menu-bar>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-menu-bar-button>` - has the same API as [`<vaadin-button>`](https://cdn.vaadin.com/vaadin-web-components/25.3.0/#/elements/vaadin-button).\n- `<vaadin-menu-bar-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/25.3.0/#/elements/vaadin-item).\n- `<vaadin-menu-bar-list-box>` - has the same API as [`<vaadin-list-box>`](https://cdn.vaadin.com/vaadin-web-components/25.3.0/#/elements/vaadin-list-box).\n- `<vaadin-menu-bar-submenu>` - has the same API as [`<vaadin-context-menu>`](https://cdn.vaadin.com/vaadin-web-components/25.3.0/#/elements/vaadin-context-menu).\n\nThe `<vaadin-menu-bar-item>` sub-menu elements have the following additional state attributes\non top of the built-in `<vaadin-item>` state attributes:\n\nAttribute  | Description\n---------- |-------------\n`expanded` | Expanded parent item.",
+          "description": "`<vaadin-menu-bar>` is a Web Component providing a set of horizontally stacked buttons offering\nthe user quick access to a consistent set of commands. Each button can toggle a submenu with\nsupport for additional levels of nested menus.\n\nTo create the menu bar, first add the component to the page:\n\n```html\n<vaadin-menu-bar></vaadin-menu-bar>\n```\n\nAnd then use [`items`](https://cdn.vaadin.com/vaadin-web-components/25.3.1/#/elements/vaadin-menu-bar#property-items) property to initialize the structure:\n\n```js\ndocument.querySelector('vaadin-menu-bar').items = [{text: 'File'}, {text: 'Edit'}];\n```\n\n### Styling\n\nThe following shadow DOM parts are exposed for styling:\n\nPart name         | Description\n------------------|----------------\n`container`       | The container wrapping menu bar buttons.\n\nThe following state attributes are available for styling:\n\nAttribute           | Description\n--------------------|----------------------------------\n`disabled`          | Set when the menu bar is disabled\n`has-single-button` | Set when there is only one button visible\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property         |\n:---------------------------|\n| `--vaadin-menu-bar-gap`   |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.\n\n### Internal components\n\nIn addition to `<vaadin-menu-bar>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-menu-bar-button>` - has the same API as [`<vaadin-button>`](https://cdn.vaadin.com/vaadin-web-components/25.3.1/#/elements/vaadin-button).\n- `<vaadin-menu-bar-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/25.3.1/#/elements/vaadin-item).\n- `<vaadin-menu-bar-list-box>` - has the same API as [`<vaadin-list-box>`](https://cdn.vaadin.com/vaadin-web-components/25.3.1/#/elements/vaadin-list-box).\n- `<vaadin-menu-bar-submenu>` - has the same API as [`<vaadin-context-menu>`](https://cdn.vaadin.com/vaadin-web-components/25.3.1/#/elements/vaadin-context-menu).\n\nThe `<vaadin-menu-bar-item>` sub-menu elements have the following additional state attributes\non top of the built-in `<vaadin-item>` state attributes:\n\nAttribute  | Description\n---------- |-------------\n`expanded` | Expanded parent item.",
           "extension": true,
           "attributes": [
             {