Skip to content

Commit 1f47047

Browse files
authored
refactor!: update menu-bar to use vaadin-menu-bar-list-box (#5354)
1 parent a6edd66 commit 1f47047

11 files changed

Lines changed: 106 additions & 12 deletions

‎packages/context-menu/src/vaadin-contextmenu-items-mixin.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ export const ItemsMixin = (superClass) =>
170170
const subMenu = root.querySelector(this.constructor.is);
171171
subMenu.closeOn = menu.closeOn;
172172

173-
const listBox = root.querySelector('vaadin-context-menu-list-box');
173+
const listBox = root.querySelector(`${this._tagNamePrefix}-list-box`);
174174

175175
listBox.innerHTML = '';
176176

@@ -244,7 +244,7 @@ export const ItemsMixin = (superClass) =>
244244
/** @private */
245245
__initMenu(root, menu) {
246246
if (!root.firstElementChild) {
247-
const listBox = document.createElement('vaadin-context-menu-list-box');
247+
const listBox = document.createElement(`${this._tagNamePrefix}-list-box`);
248248
root.appendChild(listBox);
249249

250250
if (this._theme) {
@@ -353,7 +353,7 @@ export const ItemsMixin = (superClass) =>
353353
}
354354
});
355355
} else {
356-
const listBox = root.querySelector('vaadin-context-menu-list-box');
356+
const listBox = root.querySelector(`${this._tagNamePrefix}-list-box`);
357357
if (this._theme) {
358358
listBox.setAttribute('theme', this._theme);
359359
} else {
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
/**
2+
* @license
3+
* Copyright (c) 2019 - 2023 Vaadin Ltd.
4+
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
5+
*/
6+
import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
7+
import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
8+
import { DirMixin } from '@vaadin/component-base/src/dir-mixin.js';
9+
import { ListMixin } from '@vaadin/component-base/src/list-mixin.js';
10+
import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
11+
12+
/**
13+
* An element used internally by `<vaadin-menu-bar>`. Not intended to be used separately.
14+
*
15+
* @extends HTMLElement
16+
* @mixes ControllerMixin
17+
* @mixes DirMixin
18+
* @mixes ListMixin
19+
* @mixes ThemableMixin
20+
* @protected
21+
*/
22+
class MenuBarListBox extends ListMixin(ThemableMixin(DirMixin(ControllerMixin(PolymerElement)))) {
23+
static get is() {
24+
return 'vaadin-menu-bar-list-box';
25+
}
26+
27+
static get template() {
28+
return html`
29+
<style>
30+
:host {
31+
display: flex;
32+
}
33+
34+
:host([hidden]) {
35+
display: none !important;
36+
}
37+
38+
[part='items'] {
39+
height: 100%;
40+
width: 100%;
41+
overflow-y: auto;
42+
-webkit-overflow-scrolling: touch;
43+
}
44+
</style>
45+
<div part="items">
46+
<slot></slot>
47+
</div>
48+
`;
49+
}
50+
51+
static get properties() {
52+
return {
53+
// We don't need to define this property since super default is vertical,
54+
// but we don't want it to be modified, or be shown in the API docs.
55+
/** @private */
56+
orientation: {
57+
readOnly: true,
58+
},
59+
};
60+
}
61+
62+
/**
63+
* @return {!HTMLElement}
64+
* @protected
65+
* @override
66+
*/
67+
get _scrollerElement() {
68+
return this.shadowRoot.querySelector('[part="items"]');
69+
}
70+
71+
/** @protected */
72+
ready() {
73+
super.ready();
74+
75+
this.setAttribute('role', 'menu');
76+
}
77+
}
78+
79+
customElements.define(MenuBarListBox.is, MenuBarListBox);
80+
81+
export { MenuBarListBox };

‎packages/menu-bar/src/vaadin-menu-bar-submenu.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
* Copyright (c) 2019 - 2023 Vaadin Ltd.
44
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
55
*/
6+
import './vaadin-menu-bar-list-box.js';
67
import './vaadin-menu-bar-overlay.js';
78
import { html } from '@polymer/polymer/lib/utils/html-tag.js';
89
import { ContextMenu } from '@vaadin/context-menu/src/vaadin-context-menu.js';

‎packages/menu-bar/src/vaadin-menu-bar.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ export interface MenuBarEventMap extends HTMLElementEventMap, MenuBarCustomEvent
102102
*
103103
* - `<vaadin-menu-bar-button>` - has the same API as [`<vaadin-button>`](#/elements/vaadin-button).
104104
* - `<vaadin-context-menu-item>` - has the same API as [`<vaadin-item>`](#/elements/vaadin-item).
105-
* - `<vaadin-context-menu-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).
105+
* - `<vaadin-menu-bar-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).
106106
* - `<vaadin-menu-bar-overlay>` - has the same API as [`<vaadin-overlay>`](#/elements/vaadin-overlay).
107107
*
108108
* @fires {CustomEvent} item-selected - Fired when a submenu item or menu bar button without children is clicked.

‎packages/menu-bar/src/vaadin-menu-bar.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ import { MenuBarMixin } from './vaadin-menu-bar-mixin.js';
5353
*
5454
* - `<vaadin-menu-bar-button>` - has the same API as [`<vaadin-button>`](#/elements/vaadin-button).
5555
* - `<vaadin-context-menu-item>` - has the same API as [`<vaadin-item>`](#/elements/vaadin-item).
56-
* - `<vaadin-context-menu-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).
56+
* - `<vaadin-menu-bar-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).
5757
* - `<vaadin-menu-bar-overlay>` - has the same API as [`<vaadin-overlay>`](#/elements/vaadin-overlay).
5858
*
5959
* @fires {CustomEvent<boolean>} item-selected - Fired when a submenu item or menu bar button without children is clicked.

‎packages/menu-bar/test/dom/__snapshots__/menu-bar.test.snap.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ snapshots["menu-bar overlay"] =
6464
start-aligned=""
6565
top-aligned=""
6666
>
67-
<vaadin-context-menu-list-box
67+
<vaadin-menu-bar-list-box
6868
aria-orientation="vertical"
69-
role="list"
69+
role="menu"
7070
>
7171
<vaadin-context-menu-item
7272
aria-haspopup="false"
@@ -84,7 +84,7 @@ snapshots["menu-bar overlay"] =
8484
>
8585
Generate Report
8686
</vaadin-context-menu-item>
87-
</vaadin-context-menu-list-box>
87+
</vaadin-menu-bar-list-box>
8888
<vaadin-menu-bar-submenu hidden="">
8989
</vaadin-menu-bar-submenu>
9090
</vaadin-menu-bar-overlay>
@@ -101,9 +101,9 @@ snapshots["menu-bar overlay class"] =
101101
start-aligned=""
102102
top-aligned=""
103103
>
104-
<vaadin-context-menu-list-box
104+
<vaadin-menu-bar-list-box
105105
aria-orientation="vertical"
106-
role="list"
106+
role="menu"
107107
>
108108
<vaadin-context-menu-item
109109
aria-haspopup="false"
@@ -121,7 +121,7 @@ snapshots["menu-bar overlay class"] =
121121
>
122122
Generate Report
123123
</vaadin-context-menu-item>
124-
</vaadin-context-menu-list-box>
124+
</vaadin-menu-bar-list-box>
125125
<vaadin-menu-bar-submenu hidden="">
126126
</vaadin-menu-bar-submenu>
127127
</vaadin-menu-bar-overlay>

‎packages/menu-bar/test/menu-bar.test.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -710,7 +710,7 @@ describe('item components', () => {
710710
const subMenu = menu._subMenu;
711711
overflow.click();
712712
await nextRender(subMenu);
713-
const listBox = subMenu.$.overlay.querySelector('vaadin-context-menu-list-box');
713+
const listBox = subMenu.$.overlay.querySelector('vaadin-menu-bar-list-box');
714714
expect(listBox.items[0]).to.equal(buttons[2].item.component);
715715
expect(listBox.items[0].firstChild).to.equal(menu.items[2].component);
716716
expect(listBox.items[0].firstChild.localName).to.equal('div');
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import { contextMenuListBox } from '@vaadin/context-menu/theme/lumo/vaadin-context-menu-list-box-styles.js';
2+
import { listBox } from '@vaadin/list-box/theme/lumo/vaadin-list-box-styles.js';
3+
import { registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
4+
5+
registerStyles('vaadin-menu-bar-list-box', [listBox, contextMenuListBox], { moduleId: 'lumo-menu-bar-list-box' });

‎packages/menu-bar/theme/lumo/vaadin-menu-bar.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import './vaadin-menu-bar-button.js';
22
import './vaadin-menu-bar-item-styles.js';
3+
import './vaadin-menu-bar-list-box-styles.js';
34
import './vaadin-menu-bar-overlay-styles.js';
45
import './vaadin-menu-bar-styles.js';
56
import '@vaadin/context-menu/theme/lumo/vaadin-context-menu.js';
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import { contextMenuListBox } from '@vaadin/context-menu/theme/material/vaadin-context-menu-list-box-styles.js';
2+
import { listBox } from '@vaadin/list-box/theme/material/vaadin-list-box-styles.js';
3+
import { registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
4+
5+
registerStyles('vaadin-menu-bar-list-box', [listBox, contextMenuListBox], { moduleId: 'material-menu-bar-list-box' });

0 commit comments

Comments
 (0)