Skip to content

Commit df489d9

Browse files
authored
feat: add overlayClass property to vaadin-context-menu (#5227)
1 parent 923132c commit df489d9

9 files changed

Lines changed: 307 additions & 6 deletions

File tree

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
55
*/
66
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
7+
import { OverlayClassMixin } from '@vaadin/component-base/src/overlay-class-mixin.js';
78
import { ThemePropertyMixin } from '@vaadin/vaadin-themable-mixin/vaadin-theme-property-mixin.js';
89
import { ContextMenuItem, ItemsMixin } from './vaadin-contextmenu-items-mixin.js';
910

@@ -223,7 +224,7 @@ export interface ContextMenuEventMap extends HTMLElementEventMap, ContextMenuCus
223224
* @fires {CustomEvent} opened-changed - Fired when the `opened` property changes.
224225
* @fires {CustomEvent} item-selected - Fired when an item is selected when the context menu is populated using the `items` API.
225226
*/
226-
declare class ContextMenu extends ElementMixin(ThemePropertyMixin(ItemsMixin(HTMLElement))) {
227+
declare class ContextMenu extends OverlayClassMixin(ElementMixin(ThemePropertyMixin(ItemsMixin(HTMLElement)))) {
227228
/**
228229
* CSS selector that can be used to target any child element
229230
* of the context menu to listen for `openOn` events.

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js'
1111
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
1212
import { addListener, gestures, removeListener } from '@vaadin/component-base/src/gestures.js';
1313
import { MediaQueryController } from '@vaadin/component-base/src/media-query-controller.js';
14+
import { OverlayClassMixin } from '@vaadin/component-base/src/overlay-class-mixin.js';
1415
import { processTemplates } from '@vaadin/component-base/src/templates.js';
1516
import { ThemePropertyMixin } from '@vaadin/vaadin-themable-mixin/vaadin-theme-property-mixin.js';
1617
import { ItemsMixin } from './vaadin-contextmenu-items-mixin.js';
@@ -199,10 +200,13 @@ import { ItemsMixin } from './vaadin-contextmenu-items-mixin.js';
199200
* @extends HTMLElement
200201
* @mixes ElementMixin
201202
* @mixes ControllerMixin
203+
* @mixes OverlayClassMixin
202204
* @mixes ThemePropertyMixin
203205
* @mixes ItemsMixin
204206
*/
205-
class ContextMenu extends ControllerMixin(ElementMixin(ThemePropertyMixin(ItemsMixin(PolymerElement)))) {
207+
class ContextMenu extends OverlayClassMixin(
208+
ControllerMixin(ElementMixin(ThemePropertyMixin(ItemsMixin(PolymerElement)))),
209+
) {
206210
static get template() {
207211
return html`
208212
<style>

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,10 @@ export const ItemsMixin = (superClass) =>
144144
}
145145

146146
/** @private */
147-
__openSubMenu(subMenu, itemElement) {
147+
__openSubMenu(subMenu, itemElement, overlayClass) {
148148
subMenu.items = itemElement._item.children;
149149
subMenu.listenOn = itemElement;
150+
subMenu.overlayClass = overlayClass;
150151

151152
const parent = this.$.overlay;
152153

@@ -346,7 +347,10 @@ export const ItemsMixin = (superClass) =>
346347
if (itemElement._item.children && itemElement._item.children.length) {
347348
itemElement.setAttribute('aria-expanded', 'true');
348349
itemElement.setAttribute('expanded', '');
349-
this.__openSubMenu(subMenu, itemElement);
350+
351+
// Forward parent overlay class
352+
const { overlayClass } = menu;
353+
this.__openSubMenu(subMenu, itemElement, overlayClass);
350354
} else {
351355
subMenu.listenOn.focus();
352356
}
File renamed without changes.
Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
/* @web/test-runner snapshot v1 */
2+
export const snapshots = {};
3+
4+
snapshots["context-menu items"] =
5+
`<vaadin-context-menu-overlay
6+
dir="ltr"
7+
id="overlay"
8+
opened=""
9+
>
10+
<vaadin-context-menu-list-box
11+
aria-orientation="vertical"
12+
role="menu"
13+
>
14+
<vaadin-context-menu-item
15+
aria-haspopup="false"
16+
aria-selected="false"
17+
focus-ring=""
18+
focused=""
19+
role="menuitem"
20+
tabindex="0"
21+
>
22+
Menu Item 1
23+
</vaadin-context-menu-item>
24+
<hr
25+
aria-haspopup="false"
26+
role="separator"
27+
>
28+
<vaadin-context-menu-item
29+
aria-expanded="false"
30+
aria-haspopup="true"
31+
aria-selected="false"
32+
role="menuitem"
33+
tabindex="-1"
34+
>
35+
Menu Item 2
36+
</vaadin-context-menu-item>
37+
<vaadin-context-menu-item
38+
aria-disabled="true"
39+
aria-haspopup="false"
40+
aria-selected="false"
41+
disabled=""
42+
role="menuitem"
43+
tabindex="-1"
44+
>
45+
Menu Item 3
46+
</vaadin-context-menu-item>
47+
</vaadin-context-menu-list-box>
48+
<vaadin-context-menu hidden="">
49+
</vaadin-context-menu>
50+
</vaadin-context-menu-overlay>
51+
`;
52+
/* end snapshot context-menu items */
53+
54+
snapshots["context-menu items nested"] =
55+
`<vaadin-context-menu-overlay
56+
dir="ltr"
57+
id="overlay"
58+
modeless=""
59+
opened=""
60+
right-aligned=""
61+
start-aligned=""
62+
top-aligned=""
63+
>
64+
<vaadin-context-menu-list-box
65+
aria-orientation="vertical"
66+
role="menu"
67+
>
68+
<vaadin-context-menu-item
69+
aria-haspopup="false"
70+
aria-selected="false"
71+
role="menuitem"
72+
tabindex="0"
73+
>
74+
Menu Item 2-1
75+
</vaadin-context-menu-item>
76+
<vaadin-context-menu-item
77+
aria-expanded="true"
78+
aria-haspopup="true"
79+
aria-selected="false"
80+
expanded=""
81+
role="menuitem"
82+
tabindex="-1"
83+
>
84+
Menu Item 2-2
85+
</vaadin-context-menu-item>
86+
</vaadin-context-menu-list-box>
87+
<vaadin-context-menu hidden="">
88+
</vaadin-context-menu>
89+
</vaadin-context-menu-overlay>
90+
`;
91+
/* end snapshot context-menu items nested */
92+
93+
snapshots["context-menu items overlay class"] =
94+
`<vaadin-context-menu-overlay
95+
class="context-menu-overlay custom"
96+
dir="ltr"
97+
id="overlay"
98+
opened=""
99+
>
100+
<vaadin-context-menu-list-box
101+
aria-orientation="vertical"
102+
role="menu"
103+
>
104+
<vaadin-context-menu-item
105+
aria-haspopup="false"
106+
aria-selected="false"
107+
focus-ring=""
108+
focused=""
109+
role="menuitem"
110+
tabindex="0"
111+
>
112+
Menu Item 1
113+
</vaadin-context-menu-item>
114+
<hr
115+
aria-haspopup="false"
116+
role="separator"
117+
>
118+
<vaadin-context-menu-item
119+
aria-expanded="false"
120+
aria-haspopup="true"
121+
aria-selected="false"
122+
role="menuitem"
123+
tabindex="-1"
124+
>
125+
Menu Item 2
126+
</vaadin-context-menu-item>
127+
<vaadin-context-menu-item
128+
aria-disabled="true"
129+
aria-haspopup="false"
130+
aria-selected="false"
131+
disabled=""
132+
role="menuitem"
133+
tabindex="-1"
134+
>
135+
Menu Item 3
136+
</vaadin-context-menu-item>
137+
</vaadin-context-menu-list-box>
138+
<vaadin-context-menu hidden="">
139+
</vaadin-context-menu>
140+
</vaadin-context-menu-overlay>
141+
`;
142+
/* end snapshot context-menu items overlay class */
143+
144+
snapshots["context-menu items overlay class nested"] =
145+
`<vaadin-context-menu-overlay
146+
class="context-menu-overlay custom"
147+
dir="ltr"
148+
id="overlay"
149+
modeless=""
150+
opened=""
151+
right-aligned=""
152+
start-aligned=""
153+
top-aligned=""
154+
>
155+
<vaadin-context-menu-list-box
156+
aria-orientation="vertical"
157+
role="menu"
158+
>
159+
<vaadin-context-menu-item
160+
aria-haspopup="false"
161+
aria-selected="false"
162+
role="menuitem"
163+
tabindex="0"
164+
>
165+
Menu Item 2-1
166+
</vaadin-context-menu-item>
167+
<vaadin-context-menu-item
168+
aria-expanded="true"
169+
aria-haspopup="true"
170+
aria-selected="false"
171+
expanded=""
172+
role="menuitem"
173+
tabindex="-1"
174+
>
175+
Menu Item 2-2
176+
</vaadin-context-menu-item>
177+
</vaadin-context-menu-list-box>
178+
<vaadin-context-menu hidden="">
179+
</vaadin-context-menu>
180+
</vaadin-context-menu-overlay>
181+
`;
182+
/* end snapshot context-menu items overlay class nested */
183+
Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
import { expect } from '@esm-bundle/chai';
2+
import { fixtureSync, nextRender } from '@vaadin/testing-helpers';
3+
import '../../src/vaadin-context-menu.js';
4+
import '../not-animated-styles.js';
5+
import { openSubMenus } from '../common.js';
6+
7+
describe('context-menu', () => {
8+
let menu, overlay;
9+
10+
const SNAPSHOT_CONFIG = {
11+
// Some inline CSS styles related to the overlay's position
12+
// may slightly change depending on the environment, so ignore them.
13+
ignoreAttributes: ['style'],
14+
};
15+
16+
const ITEMS = [
17+
{ text: 'Menu Item 1' },
18+
{ component: 'hr' },
19+
{
20+
text: 'Menu Item 2',
21+
children: [
22+
{ text: 'Menu Item 2-1' },
23+
{
24+
text: 'Menu Item 2-2',
25+
children: [
26+
{ text: 'Menu Item 2-2-1', checked: true },
27+
{ text: 'Menu Item 2-2-2', disabled: true },
28+
{ component: 'hr' },
29+
{ text: 'Menu Item 2-2-3' },
30+
],
31+
},
32+
],
33+
},
34+
{ text: 'Menu Item 3', disabled: true },
35+
];
36+
37+
const contextmenu = (target) => {
38+
const domRect = target.getBoundingClientRect();
39+
40+
target.listenOn.dispatchEvent(
41+
new MouseEvent('contextmenu', {
42+
bubbles: true,
43+
cancelable: true,
44+
clientX: domRect.left,
45+
clientY: domRect.y,
46+
}),
47+
);
48+
};
49+
50+
beforeEach(async () => {
51+
menu = fixtureSync(`
52+
<vaadin-context-menu>
53+
<div style="padding: 10px">Target</div>
54+
</vaadin-context-menu>
55+
`);
56+
await nextRender();
57+
overlay = menu.$.overlay;
58+
});
59+
60+
it('items', async () => {
61+
menu.items = ITEMS;
62+
63+
contextmenu(menu);
64+
await nextRender();
65+
66+
await expect(overlay).dom.to.equalSnapshot(SNAPSHOT_CONFIG);
67+
});
68+
69+
it('items nested', async () => {
70+
menu.items = ITEMS;
71+
72+
contextmenu(menu);
73+
await openSubMenus(menu);
74+
await nextRender();
75+
76+
const subMenu = overlay.querySelector('vaadin-context-menu');
77+
await expect(subMenu.$.overlay).dom.to.equalSnapshot(SNAPSHOT_CONFIG);
78+
});
79+
80+
it('items overlay class', async () => {
81+
menu.overlayClass = 'context-menu-overlay custom';
82+
menu.items = ITEMS;
83+
84+
contextmenu(menu);
85+
await nextRender();
86+
87+
await expect(menu.$.overlay).dom.to.equalSnapshot(SNAPSHOT_CONFIG);
88+
});
89+
90+
it('items overlay class nested', async () => {
91+
menu.overlayClass = 'context-menu-overlay custom';
92+
menu.items = ITEMS;
93+
94+
contextmenu(menu);
95+
await openSubMenus(menu);
96+
await nextRender();
97+
98+
const subMenu = overlay.querySelector('vaadin-context-menu');
99+
await expect(subMenu.$.overlay).dom.to.equalSnapshot(SNAPSHOT_CONFIG);
100+
});
101+
});

‎packages/context-menu/test/typings/context-menu.types.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ const menu = document.createElement('vaadin-context-menu');
1212

1313
const assertType = <TExpected>(actual: TExpected) => actual;
1414

15+
// Properties
16+
assertType<boolean>(menu.opened);
17+
assertType<string>(menu.openOn);
18+
assertType<string>(menu.closeOn);
19+
assertType<HTMLElement>(menu.listenOn);
20+
assertType<string>(menu.overlayClass);
21+
22+
// Events
1523
menu.addEventListener('opened-changed', (event) => {
1624
assertType<ContextMenuOpenedChangedEvent>(event);
1725
assertType<boolean>(event.detail.value);

‎packages/context-menu/test/visual/lumo/context-menu.test.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { fixtureSync, nextRender } from '@vaadin/testing-helpers';
22
import { visualDiff } from '@web/test-runner-visual-regression';
33
import '../../../theme/lumo/vaadin-context-menu.js';
44
import '../../not-animated-styles.js';
5-
import { openSubMenus } from '../common.js';
5+
import { openSubMenus } from '../../common.js';
66

77
describe('context-menu', () => {
88
let element;

‎packages/context-menu/test/visual/material/context-menu.test.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { fixtureSync, nextRender } from '@vaadin/testing-helpers';
22
import { visualDiff } from '@web/test-runner-visual-regression';
33
import '../../../theme/material/vaadin-context-menu.js';
44
import '../../not-animated-styles.js';
5-
import { openSubMenus } from '../common.js';
5+
import { openSubMenus } from '../../common.js';
66

77
describe('context-menu', () => {
88
let element;

0 commit comments

Comments
 (0)