@vaadin/menu-bar 23.2.0-alpha2 → 23.2.0-alpha5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/menu-bar",
-  "version": "23.2.0-alpha2",
+  "version": "23.2.0-alpha5",
   "publishConfig": {
     "access": "public"
   },
@@ -23,7 +23,9 @@
     "src",
     "theme",
     "vaadin-*.d.ts",
-    "vaadin-*.js"
+    "vaadin-*.js",
+    "web-types.json",
+    "web-types.lit.json"
   ],
   "keywords": [
     "Vaadin",
@@ -35,18 +37,22 @@
   "dependencies": {
     "@open-wc/dedupe-mixin": "^1.3.0",
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/button": "23.2.0-alpha2",
-    "@vaadin/component-base": "23.2.0-alpha2",
-    "@vaadin/vaadin-context-menu": "23.2.0-alpha2",
-    "@vaadin/vaadin-lumo-styles": "23.2.0-alpha2",
-    "@vaadin/vaadin-material-styles": "23.2.0-alpha2",
-    "@vaadin/vaadin-themable-mixin": "23.2.0-alpha2"
+    "@vaadin/button": "23.2.0-alpha5",
+    "@vaadin/component-base": "23.2.0-alpha5",
+    "@vaadin/context-menu": "23.2.0-alpha5",
+    "@vaadin/vaadin-lumo-styles": "23.2.0-alpha5",
+    "@vaadin/vaadin-material-styles": "23.2.0-alpha5",
+    "@vaadin/vaadin-themable-mixin": "23.2.0-alpha5"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
-    "@vaadin/icon": "23.2.0-alpha2",
+    "@vaadin/icon": "23.2.0-alpha5",
     "@vaadin/testing-helpers": "^0.3.2",
     "sinon": "^13.0.2"
   },
-  "gitHead": "c9b8113d0fa9a602f8b9cb915c1826355af2e8df"
+  "web-types": [
+    "web-types.json",
+    "web-types.lit.json"
+  ],
+  "gitHead": "c6247fd741d61096d75a71feda4a1faf88b6f0ce"
 }

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

@@ -3,12 +3,12 @@
  * Copyright (c) 2019 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
-import { Constructor } from '@open-wc/dedupe-mixin';
-import { ResizeMixinClass } from '@vaadin/component-base/src/resize-mixin.js';
+import type { Constructor } from '@open-wc/dedupe-mixin';
+import type { ResizeMixinClass } from '@vaadin/component-base/src/resize-mixin.js';
 
 export declare function ButtonsMixin<T extends Constructor<HTMLElement>>(
   base: T,
-): T & Constructor<ButtonsMixinClass> & Constructor<ResizeMixinClass>;
+): Constructor<ButtonsMixinClass> & Constructor<ResizeMixinClass> & T;
 
 export declare class ButtonsMixinClass {
   protected readonly _buttons: HTMLElement[];

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

@@ -163,6 +163,9 @@ export const ButtonsMixin = (superClass) =>
       if (oldOverflowCount !== newOverflowCount && this._subMenu.opened) {
         this._subMenu.close();
       }
+
+      const isSingleButton = newOverflowCount === buttons.length || (newOverflowCount === 0 && buttons.length === 1);
+      this.toggleAttribute('has-single-button', isSingleButton);
     }
 
     /** @protected */

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

@@ -3,11 +3,11 @@
  * Copyright (c) 2019 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
-import { Constructor } from '@open-wc/dedupe-mixin';
+import type { Constructor } from '@open-wc/dedupe-mixin';
 
 export declare function InteractionsMixin<T extends Constructor<HTMLElement>>(
   base: T,
-): T & Constructor<InteractionsMixinClass>;
+): Constructor<InteractionsMixinClass> & T;
 
 export declare class InteractionsMixinClass {
   /**

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

@@ -3,7 +3,7 @@
  * Copyright (c) 2019 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
-import { ContextMenu } from '@vaadin/vaadin-context-menu/src/vaadin-context-menu.js';
+import { ContextMenu } from '@vaadin/context-menu/src/vaadin-context-menu.js';
 
 /**
  * An element used internally by `<vaadin-menu-bar>`. Not intended to be used separately.

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

@@ -11,17 +11,17 @@ import { InteractionsMixin } from './vaadin-menu-bar-interactions-mixin.js';
 
 export interface MenuBarItem {
   text?: string;
-  component?: string | HTMLElement;
+  component?: HTMLElement | string;
   disabled?: boolean;
-  theme?: string | string[];
+  theme?: string[] | string;
   children?: SubMenuItem[];
 }
 
 export interface SubMenuItem {
   text?: string;
-  component?: string | HTMLElement;
+  component?: HTMLElement | string;
   disabled?: boolean;
-  theme?: string | string[];
+  theme?: string[] | string;
   checked?: boolean;
   children?: SubMenuItem[];
 }
@@ -68,6 +68,13 @@ export interface MenuBarEventMap extends HTMLElementEventMap, MenuBarCustomEvent
  * `menu-bar-button` | The menu bar button.
  * `overflow-button` | The "overflow" button appearing when menu bar width is not enough to fit all the buttons.
  *
+ * The following state attributes are available for styling:
+ *
+ * Attribute           | Description
+ * --------------------|----------------------------------
+ * `disabled`          | Set when the menu bar is disabled
+ * `has-single-button` | Set when there is only one button visible
+ *
  * See [Styling Components](https://vaadin.com/docs/latest/ds/customization/styling-components) documentation.
  *
  * ### Internal components
@@ -138,13 +145,13 @@ declare class MenuBar extends ButtonsMixin(DisabledMixin(InteractionsMixin(Eleme
   addEventListener<K extends keyof MenuBarEventMap>(
     type: K,
     listener: (this: MenuBar, ev: MenuBarEventMap[K]) => void,
-    options?: boolean | AddEventListenerOptions,
+    options?: AddEventListenerOptions | boolean,
   ): void;
 
   removeEventListener<K extends keyof MenuBarEventMap>(
     type: K,
     listener: (this: MenuBar, ev: MenuBarEventMap[K]) => void,
-    options?: boolean | EventListenerOptions,
+    options?: EventListenerOptions | boolean,
   ): void;
 
   /**

package/src/vaadin-menu-bar.js

@@ -39,6 +39,13 @@ import { InteractionsMixin } from './vaadin-menu-bar-interactions-mixin.js';
  * `menu-bar-button` | The menu bar button.
  * `overflow-button` | The "overflow" button appearing when menu bar width is not enough to fit all the buttons.
  *
+ * The following state attributes are available for styling:
+ *
+ * Attribute           | Description
+ * --------------------|----------------------------------
+ * `disabled`          | Set when the menu bar is disabled
+ * `has-single-button` | Set when there is only one button visible
+ *
  * See [Styling Components](https://vaadin.com/docs/latest/ds/customization/styling-components) documentation.
  *
  * ### Internal components
@@ -56,6 +63,7 @@ import { InteractionsMixin } from './vaadin-menu-bar-interactions-mixin.js';
  * @extends HTMLElement
  * @mixes ButtonsMixin
  * @mixes InteractionsMixin
+ * @mixes DisabledMixin
  * @mixes ElementMixin
  * @mixes ThemableMixin
  */

package/theme/lumo/vaadin-menu-bar-styles.js

@@ -0,0 +1,17 @@
+import '@vaadin/vaadin-lumo-styles/style.js';
+import { css, registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
+
+registerStyles(
+  'vaadin-menu-bar',
+  css`
+    :host([has-single-button]) [part$='button'] {
+      border-radius: var(--lumo-border-radius-m);
+    }
+
+    :host([theme~='end-aligned']) [part$='button']:first-child,
+    :host([theme~='end-aligned'][has-single-button]) [part$='button'] {
+      margin-inline-start: auto;
+    }
+  `,
+  { moduleId: 'lumo-menu-bar' },
+);

package/theme/lumo/vaadin-menu-bar.js

@@ -1,5 +1,6 @@
 import './vaadin-menu-bar-button.js';
 import './vaadin-menu-bar-item-styles.js';
 import './vaadin-menu-bar-overlay-styles.js';
-import '@vaadin/vaadin-context-menu/theme/lumo/vaadin-context-menu.js';
+import './vaadin-menu-bar-styles.js';
+import '@vaadin/context-menu/theme/lumo/vaadin-context-menu.js';
 import '../../src/vaadin-menu-bar.js';

package/theme/material/vaadin-menu-bar-button-styles.js

@@ -14,8 +14,8 @@ const menuBarButton = css`
     justify-content: center;
   }
 
-  :host([theme='outlined']),
-  :host([theme='contained']) {
+  :host([theme~='outlined']),
+  :host([theme~='contained']) {
     border-radius: 0;
   }
 
@@ -36,7 +36,7 @@ const menuBarButton = css`
     transition: 0s;
   }
 
-  :host([theme='contained'][expanded]) {
+  :host([theme~='contained'][expanded]) {
     box-shadow: var(--material-shadow-elevation-8dp);
   }
 
@@ -45,7 +45,7 @@ const menuBarButton = css`
     opacity: 0;
   }
 
-  :host([theme='contained']:not([dir='rtl'])) {
+  :host([theme~='contained']:not([dir='rtl'])) {
     margin-right: 1px;
   }
 
@@ -68,16 +68,16 @@ const menuBarButton = css`
     font-size: 24px;
   }
 
-  :host([theme='outlined']:not([dir='rtl'])) {
+  :host([theme~='outlined']:not([dir='rtl'])) {
     margin-right: -1px;
   }
 
-  :host([theme='outlined']:not([dir='rtl']):nth-last-of-type(2)),
-  :host([theme='outlined']:not([dir='rtl'])[part~='overflow-button']) {
+  :host([theme~='outlined']:not([dir='rtl']):nth-last-of-type(2)),
+  :host([theme~='outlined']:not([dir='rtl'])[part~='overflow-button']) {
     margin-right: 0;
   }
 
-  :host([theme='text']),
+  :host([theme~='text']),
   :host(:not([theme])) {
     border-radius: 4px;
   }
@@ -92,16 +92,16 @@ const menuBarButton = css`
     border-radius: 4px 0 0 4px;
   }
 
-  :host([dir='rtl'][theme='contained']) {
+  :host([dir='rtl'][theme~='contained']) {
     margin-left: 1px;
   }
 
-  :host([dir='rtl'][theme='outlined']) {
+  :host([dir='rtl'][theme~='outlined']) {
     margin-left: -1px;
   }
 
-  :host([theme='outlined'][dir='rtl']:nth-last-of-type(2)),
-  :host([theme='outlined'][dir='rtl'][part~='overflow-button']) {
+  :host([theme~='outlined'][dir='rtl']:nth-last-of-type(2)),
+  :host([theme~='outlined'][dir='rtl'][part~='overflow-button']) {
     margin-left: 0;
   }
 `;

package/theme/material/vaadin-menu-bar-styles.js

@@ -7,6 +7,15 @@ registerStyles(
       /* To retain the box-shadow */
       padding-bottom: 5px;
     }
+
+    :host([has-single-button]) [part$='button'] {
+      border-radius: 4px;
+    }
+
+    :host([theme~='end-aligned']) [part$='button']:first-child,
+    :host([theme~='end-aligned'][has-single-button]) [part$='button'] {
+      margin-inline-start: auto;
+    }
   `,
   { moduleId: 'material-menu-bar' },
 );

package/theme/material/vaadin-menu-bar.js

@@ -2,5 +2,5 @@ import './vaadin-menu-bar-button.js';
 import './vaadin-menu-bar-item-styles.js';
 import './vaadin-menu-bar-styles.js';
 import './vaadin-menu-bar-overlay-styles.js';
-import '@vaadin/vaadin-context-menu/theme/material/vaadin-context-menu.js';
+import '@vaadin/context-menu/theme/material/vaadin-context-menu.js';
 import '../../src/vaadin-menu-bar.js';

package/web-types.json

@@ -0,0 +1,101 @@
+{
+  "$schema": "https://json.schemastore.org/web-types",
+  "name": "@vaadin/menu-bar",
+  "version": "23.2.0-alpha5",
+  "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```\n<vaadin-menu-bar></vaadin-menu-bar>\n```\n\nAnd then use [`items`](https://cdn.vaadin.com/vaadin-web-components/23.2.0-alpha5/#/elements/vaadin-menu-bar#property-items) property to initialize the structure:\n\n```\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`menu-bar-button` | The menu bar button.\n`overflow-button` | The \"overflow\" button appearing when menu bar width is not enough to fit all the 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\nSee [Styling Components](https://vaadin.com/docs/latest/ds/customization/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/23.2.0-alpha5/#/elements/vaadin-button).\n- `<vaadin-context-menu-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/23.2.0-alpha5/#/elements/vaadin-item).\n- `<vaadin-context-menu-list-box>` - has the same API as [`<vaadin-list-box>`](https://cdn.vaadin.com/vaadin-web-components/23.2.0-alpha5/#/elements/vaadin-list-box).\n- `<vaadin-context-menu-overlay>` - has the same API as [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/23.2.0-alpha5/#/elements/vaadin-overlay).",
+          "attributes": [
+            {
+              "name": "open-on-hover",
+              "description": "If true, the submenu will open on hover (mouseover) instead of click.",
+              "value": {
+                "type": [
+                  "boolean",
+                  "null",
+                  "undefined"
+                ]
+              }
+            },
+            {
+              "name": "disabled",
+              "description": "If true, the user cannot interact with this element.",
+              "value": {
+                "type": [
+                  "boolean",
+                  "null",
+                  "undefined"
+                ]
+              }
+            },
+            {
+              "name": "theme",
+              "description": "The theme variants to apply to the component.",
+              "value": {
+                "type": [
+                  "string",
+                  "null",
+                  "undefined"
+                ]
+              }
+            }
+          ],
+          "js": {
+            "properties": [
+              {
+                "name": "openOnHover",
+                "description": "If true, the submenu will open on hover (mouseover) instead of click.",
+                "value": {
+                  "type": [
+                    "boolean",
+                    "null",
+                    "undefined"
+                  ]
+                }
+              },
+              {
+                "name": "disabled",
+                "description": "If true, the user cannot interact with this element.",
+                "value": {
+                  "type": [
+                    "boolean",
+                    "null",
+                    "undefined"
+                  ]
+                }
+              },
+              {
+                "name": "items",
+                "description": "Defines a hierarchical structure, where root level items represent menu bar buttons,\nand `children` property configures a submenu with items to be opened below\nthe button on click, Enter, Space, Up and Down arrow keys.\n\n#### Example\n\n```js\nmenubar.items = [\n  {\n    text: 'File',\n    children: [\n      {text: 'Open'}\n      {text: 'Auto Save', checked: true},\n    ]\n  },\n  {component: 'hr'},\n  {\n    text: 'Edit',\n    children: [\n      {text: 'Undo', disabled: true},\n      {text: 'Redo'}\n    ]\n  },\n  {text: 'Help'}\n];\n```",
+                "value": {
+                  "type": [
+                    "Array.<MenuBarItem>"
+                  ]
+                }
+              },
+              {
+                "name": "i18n",
+                "description": "The object used to localize this component.\nTo change the default localization, replace the entire\n`i18n` object with a custom one.\n\nTo update individual properties, extend the existing i18n object like so:\n```\nmenuBar.i18n = {\n  ...menuBar.i18n,\n  moreOptions: 'More options'\n}\n```\n\nThe object has the following JSON structure and default values:\n```\n{\n  moreOptions: 'More options'\n}\n```",
+                "value": {
+                  "type": [
+                    "MenuBarI18n"
+                  ]
+                }
+              }
+            ],
+            "events": [
+              {
+                "name": "item-selected",
+                "description": "Fired when either a submenu item or menu bar button without nested children is clicked."
+              }
+            ]
+          }
+        }
+      ]
+    }
+  }
+}

package/web-types.lit.json

@@ -0,0 +1,62 @@
+{
+  "$schema": "https://json.schemastore.org/web-types",
+  "name": "@vaadin/menu-bar",
+  "version": "23.2.0-alpha5",
+  "description-markup": "markdown",
+  "framework": "lit",
+  "framework-config": {
+    "enable-when": {
+      "node-packages": [
+        "lit"
+      ]
+    }
+  },
+  "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```\n<vaadin-menu-bar></vaadin-menu-bar>\n```\n\nAnd then use [`items`](https://cdn.vaadin.com/vaadin-web-components/23.2.0-alpha5/#/elements/vaadin-menu-bar#property-items) property to initialize the structure:\n\n```\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`menu-bar-button` | The menu bar button.\n`overflow-button` | The \"overflow\" button appearing when menu bar width is not enough to fit all the 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\nSee [Styling Components](https://vaadin.com/docs/latest/ds/customization/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/23.2.0-alpha5/#/elements/vaadin-button).\n- `<vaadin-context-menu-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/23.2.0-alpha5/#/elements/vaadin-item).\n- `<vaadin-context-menu-list-box>` - has the same API as [`<vaadin-list-box>`](https://cdn.vaadin.com/vaadin-web-components/23.2.0-alpha5/#/elements/vaadin-list-box).\n- `<vaadin-context-menu-overlay>` - has the same API as [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/23.2.0-alpha5/#/elements/vaadin-overlay).",
+          "extension": true,
+          "attributes": [
+            {
+              "name": "?openOnHover",
+              "description": "If true, the submenu will open on hover (mouseover) instead of click.",
+              "value": {
+                "kind": "expression"
+              }
+            },
+            {
+              "name": "?disabled",
+              "description": "If true, the user cannot interact with this element.",
+              "value": {
+                "kind": "expression"
+              }
+            },
+            {
+              "name": ".items",
+              "description": "Defines a hierarchical structure, where root level items represent menu bar buttons,\nand `children` property configures a submenu with items to be opened below\nthe button on click, Enter, Space, Up and Down arrow keys.\n\n#### Example\n\n```js\nmenubar.items = [\n  {\n    text: 'File',\n    children: [\n      {text: 'Open'}\n      {text: 'Auto Save', checked: true},\n    ]\n  },\n  {component: 'hr'},\n  {\n    text: 'Edit',\n    children: [\n      {text: 'Undo', disabled: true},\n      {text: 'Redo'}\n    ]\n  },\n  {text: 'Help'}\n];\n```",
+              "value": {
+                "kind": "expression"
+              }
+            },
+            {
+              "name": ".i18n",
+              "description": "The object used to localize this component.\nTo change the default localization, replace the entire\n`i18n` object with a custom one.\n\nTo update individual properties, extend the existing i18n object like so:\n```\nmenuBar.i18n = {\n  ...menuBar.i18n,\n  moreOptions: 'More options'\n}\n```\n\nThe object has the following JSON structure and default values:\n```\n{\n  moreOptions: 'More options'\n}\n```",
+              "value": {
+                "kind": "expression"
+              }
+            },
+            {
+              "name": "@item-selected",
+              "description": "Fired when either a submenu item or menu bar button without nested children is clicked.",
+              "value": {
+                "kind": "expression"
+              }
+            }
+          ]
+        }
+      ]
+    }
+  }
+}