@vaadin/menu-bar 25.1.0-beta1 → 25.1.0-beta2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/custom-elements.json +27 -1193
- package/package.json +15 -15
- package/src/styles/vaadin-menu-bar-base-styles.js +0 -1
- package/src/vaadin-menu-bar-mixin.js +1 -1
- package/web-types.json +3 -3
- package/web-types.lit.json +2 -2
package/custom-elements.json
CHANGED
|
@@ -17,323 +17,6 @@
|
|
|
17
17
|
}
|
|
18
18
|
]
|
|
19
19
|
},
|
|
20
|
-
{
|
|
21
|
-
"kind": "javascript-module",
|
|
22
|
-
"path": "src/vaadin-menu-bar-button.js",
|
|
23
|
-
"declarations": [
|
|
24
|
-
{
|
|
25
|
-
"kind": "class",
|
|
26
|
-
"description": "An element used internally by `<vaadin-menu-bar>`. Not intended to be used separately.",
|
|
27
|
-
"name": "MenuBarButton",
|
|
28
|
-
"members": [
|
|
29
|
-
{
|
|
30
|
-
"kind": "field",
|
|
31
|
-
"name": "disabled",
|
|
32
|
-
"privacy": "public",
|
|
33
|
-
"type": {
|
|
34
|
-
"text": "boolean"
|
|
35
|
-
},
|
|
36
|
-
"description": "When disabled, the button is rendered as \"dimmed\" and prevents all\nuser interactions (mouse and keyboard).\n\nSince disabled buttons are not focusable and cannot react to hover\nevents by default, it can cause accessibility issues by making them\nentirely invisible to assistive technologies, and prevents the use\nof Tooltips to explain why the action is not available. This can be\naddressed by enabling the feature flag `accessibleDisabledButtons`,\nwhich makes disabled buttons focusable and hoverable, while still\npreventing them from being triggered:\n\n```js\n// Set before any button is attached to the DOM.\nwindow.Vaadin.featureFlags.accessibleDisabledButtons = true\n```",
|
|
37
|
-
"attribute": "disabled",
|
|
38
|
-
"inheritedFrom": {
|
|
39
|
-
"name": "Button",
|
|
40
|
-
"package": "@vaadin/button/src/vaadin-button.js"
|
|
41
|
-
}
|
|
42
|
-
}
|
|
43
|
-
],
|
|
44
|
-
"superclass": {
|
|
45
|
-
"name": "Button",
|
|
46
|
-
"package": "@vaadin/button/src/vaadin-button.js"
|
|
47
|
-
},
|
|
48
|
-
"tagName": "vaadin-menu-bar-button",
|
|
49
|
-
"customElement": true,
|
|
50
|
-
"attributes": [
|
|
51
|
-
{
|
|
52
|
-
"name": "disabled",
|
|
53
|
-
"type": {
|
|
54
|
-
"text": "boolean"
|
|
55
|
-
},
|
|
56
|
-
"description": "When disabled, the button is rendered as \"dimmed\" and prevents all\nuser interactions (mouse and keyboard).\n\nSince disabled buttons are not focusable and cannot react to hover\nevents by default, it can cause accessibility issues by making them\nentirely invisible to assistive technologies, and prevents the use\nof Tooltips to explain why the action is not available. This can be\naddressed by enabling the feature flag `accessibleDisabledButtons`,\nwhich makes disabled buttons focusable and hoverable, while still\npreventing them from being triggered:\n\n```js\n// Set before any button is attached to the DOM.\nwindow.Vaadin.featureFlags.accessibleDisabledButtons = true\n```",
|
|
57
|
-
"fieldName": "disabled",
|
|
58
|
-
"inheritedFrom": {
|
|
59
|
-
"name": "Button",
|
|
60
|
-
"package": "@vaadin/button/src/vaadin-button.js"
|
|
61
|
-
}
|
|
62
|
-
},
|
|
63
|
-
{
|
|
64
|
-
"name": "tabindex",
|
|
65
|
-
"type": {
|
|
66
|
-
"text": "number"
|
|
67
|
-
},
|
|
68
|
-
"description": "Indicates whether the element can be focused and where it participates in sequential keyboard navigation.",
|
|
69
|
-
"fieldName": "tabindex",
|
|
70
|
-
"inheritedFrom": {
|
|
71
|
-
"name": "Button",
|
|
72
|
-
"package": "@vaadin/button/src/vaadin-button.js"
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
],
|
|
76
|
-
"events": []
|
|
77
|
-
}
|
|
78
|
-
],
|
|
79
|
-
"exports": [
|
|
80
|
-
{
|
|
81
|
-
"kind": "js",
|
|
82
|
-
"name": "MenuBarButton",
|
|
83
|
-
"declaration": {
|
|
84
|
-
"name": "MenuBarButton",
|
|
85
|
-
"module": "src/vaadin-menu-bar-button.js"
|
|
86
|
-
}
|
|
87
|
-
}
|
|
88
|
-
]
|
|
89
|
-
},
|
|
90
|
-
{
|
|
91
|
-
"kind": "javascript-module",
|
|
92
|
-
"path": "src/vaadin-menu-bar-item.js",
|
|
93
|
-
"declarations": [
|
|
94
|
-
{
|
|
95
|
-
"kind": "class",
|
|
96
|
-
"description": "An element used internally by `<vaadin-menu-bar>`. Not intended to be used separately.",
|
|
97
|
-
"name": "MenuBarItem",
|
|
98
|
-
"members": [
|
|
99
|
-
{
|
|
100
|
-
"kind": "field",
|
|
101
|
-
"name": "selected",
|
|
102
|
-
"privacy": "public",
|
|
103
|
-
"type": {
|
|
104
|
-
"text": "boolean"
|
|
105
|
-
},
|
|
106
|
-
"description": "If true, the item is in selected state.",
|
|
107
|
-
"attribute": "selected",
|
|
108
|
-
"inheritedFrom": {
|
|
109
|
-
"name": "ItemMixin",
|
|
110
|
-
"package": "@vaadin/item/src/vaadin-item-mixin.js"
|
|
111
|
-
}
|
|
112
|
-
},
|
|
113
|
-
{
|
|
114
|
-
"kind": "field",
|
|
115
|
-
"name": "value",
|
|
116
|
-
"return": {
|
|
117
|
-
"type": {
|
|
118
|
-
"text": "string"
|
|
119
|
-
}
|
|
120
|
-
},
|
|
121
|
-
"parameters": [
|
|
122
|
-
{
|
|
123
|
-
"name": "value",
|
|
124
|
-
"type": {
|
|
125
|
-
"text": "string"
|
|
126
|
-
}
|
|
127
|
-
}
|
|
128
|
-
],
|
|
129
|
-
"inheritedFrom": {
|
|
130
|
-
"name": "ItemMixin",
|
|
131
|
-
"package": "@vaadin/item/src/vaadin-item-mixin.js"
|
|
132
|
-
}
|
|
133
|
-
}
|
|
134
|
-
],
|
|
135
|
-
"mixins": [
|
|
136
|
-
{
|
|
137
|
-
"name": "ItemMixin",
|
|
138
|
-
"package": "@vaadin/item/src/vaadin-item-mixin.js"
|
|
139
|
-
},
|
|
140
|
-
{
|
|
141
|
-
"name": "ThemableMixin",
|
|
142
|
-
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
143
|
-
},
|
|
144
|
-
{
|
|
145
|
-
"name": "DirMixin",
|
|
146
|
-
"package": "@vaadin/component-base/src/dir-mixin.js"
|
|
147
|
-
},
|
|
148
|
-
{
|
|
149
|
-
"name": "PolylitMixin",
|
|
150
|
-
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
151
|
-
},
|
|
152
|
-
{
|
|
153
|
-
"name": "LumoInjectionMixin",
|
|
154
|
-
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
155
|
-
}
|
|
156
|
-
],
|
|
157
|
-
"superclass": {
|
|
158
|
-
"name": "LitElement",
|
|
159
|
-
"package": "lit"
|
|
160
|
-
},
|
|
161
|
-
"tagName": "vaadin-menu-bar-item",
|
|
162
|
-
"customElement": true,
|
|
163
|
-
"attributes": [
|
|
164
|
-
{
|
|
165
|
-
"name": "selected",
|
|
166
|
-
"type": {
|
|
167
|
-
"text": "boolean"
|
|
168
|
-
},
|
|
169
|
-
"description": "If true, the item is in selected state.",
|
|
170
|
-
"fieldName": "selected",
|
|
171
|
-
"inheritedFrom": {
|
|
172
|
-
"name": "ItemMixin",
|
|
173
|
-
"package": "@vaadin/item/src/vaadin-item-mixin.js"
|
|
174
|
-
}
|
|
175
|
-
}
|
|
176
|
-
],
|
|
177
|
-
"events": []
|
|
178
|
-
}
|
|
179
|
-
],
|
|
180
|
-
"exports": [
|
|
181
|
-
{
|
|
182
|
-
"kind": "js",
|
|
183
|
-
"name": "MenuBarItem",
|
|
184
|
-
"declaration": {
|
|
185
|
-
"name": "MenuBarItem",
|
|
186
|
-
"module": "src/vaadin-menu-bar-item.js"
|
|
187
|
-
}
|
|
188
|
-
}
|
|
189
|
-
]
|
|
190
|
-
},
|
|
191
|
-
{
|
|
192
|
-
"kind": "javascript-module",
|
|
193
|
-
"path": "src/vaadin-menu-bar-list-box.js",
|
|
194
|
-
"declarations": [
|
|
195
|
-
{
|
|
196
|
-
"kind": "class",
|
|
197
|
-
"description": "An element used internally by `<vaadin-menu-bar>`. Not intended to be used separately.",
|
|
198
|
-
"name": "MenuBarListBox",
|
|
199
|
-
"members": [
|
|
200
|
-
{
|
|
201
|
-
"kind": "field",
|
|
202
|
-
"name": "disabled",
|
|
203
|
-
"privacy": "public",
|
|
204
|
-
"type": {
|
|
205
|
-
"text": "boolean"
|
|
206
|
-
},
|
|
207
|
-
"description": "If true, the user cannot interact with this element.\nWhen the element is disabled, the selected item is\nnot updated when `selected` property is changed.",
|
|
208
|
-
"attribute": "disabled",
|
|
209
|
-
"inheritedFrom": {
|
|
210
|
-
"name": "ListMixin",
|
|
211
|
-
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
212
|
-
}
|
|
213
|
-
},
|
|
214
|
-
{
|
|
215
|
-
"kind": "field",
|
|
216
|
-
"name": "items",
|
|
217
|
-
"privacy": "public",
|
|
218
|
-
"type": {
|
|
219
|
-
"text": "!Array<!Element> | undefined"
|
|
220
|
-
},
|
|
221
|
-
"description": "A read-only list of items from which a selection can be made.\nIt is populated from the elements passed to the light DOM,\nand updated dynamically when adding or removing items.",
|
|
222
|
-
"attribute": "items",
|
|
223
|
-
"inheritedFrom": {
|
|
224
|
-
"name": "ListMixin",
|
|
225
|
-
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
226
|
-
}
|
|
227
|
-
},
|
|
228
|
-
{
|
|
229
|
-
"kind": "field",
|
|
230
|
-
"name": "orientation",
|
|
231
|
-
"privacy": "public",
|
|
232
|
-
"type": {
|
|
233
|
-
"text": "!ListOrientation"
|
|
234
|
-
},
|
|
235
|
-
"description": "Define how items are disposed in the dom.\nPossible values are: `horizontal|vertical`.\nIt also changes navigation keys from left/right to up/down.",
|
|
236
|
-
"attribute": "orientation",
|
|
237
|
-
"inheritedFrom": {
|
|
238
|
-
"name": "ListMixin",
|
|
239
|
-
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
240
|
-
}
|
|
241
|
-
},
|
|
242
|
-
{
|
|
243
|
-
"kind": "field",
|
|
244
|
-
"name": "selected",
|
|
245
|
-
"privacy": "public",
|
|
246
|
-
"type": {
|
|
247
|
-
"text": "number"
|
|
248
|
-
},
|
|
249
|
-
"description": "The index of the item selected in the items array.\nNote: Not updated when used in `multiple` selection mode.",
|
|
250
|
-
"attribute": "selected",
|
|
251
|
-
"inheritedFrom": {
|
|
252
|
-
"name": "ListMixin",
|
|
253
|
-
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
254
|
-
}
|
|
255
|
-
}
|
|
256
|
-
],
|
|
257
|
-
"attributes": [
|
|
258
|
-
{
|
|
259
|
-
"name": "disabled",
|
|
260
|
-
"type": {
|
|
261
|
-
"text": "boolean"
|
|
262
|
-
},
|
|
263
|
-
"description": "If true, the user cannot interact with this element.\nWhen the element is disabled, the selected item is\nnot updated when `selected` property is changed.",
|
|
264
|
-
"fieldName": "disabled",
|
|
265
|
-
"inheritedFrom": {
|
|
266
|
-
"name": "ListMixin",
|
|
267
|
-
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
268
|
-
}
|
|
269
|
-
},
|
|
270
|
-
{
|
|
271
|
-
"name": "orientation",
|
|
272
|
-
"type": {
|
|
273
|
-
"text": "!ListOrientation"
|
|
274
|
-
},
|
|
275
|
-
"description": "Define how items are disposed in the dom.\nPossible values are: `horizontal|vertical`.\nIt also changes navigation keys from left/right to up/down.",
|
|
276
|
-
"fieldName": "orientation",
|
|
277
|
-
"inheritedFrom": {
|
|
278
|
-
"name": "ListMixin",
|
|
279
|
-
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
280
|
-
}
|
|
281
|
-
},
|
|
282
|
-
{
|
|
283
|
-
"name": "selected",
|
|
284
|
-
"type": {
|
|
285
|
-
"text": "number"
|
|
286
|
-
},
|
|
287
|
-
"description": "The index of the item selected in the items array.\nNote: Not updated when used in `multiple` selection mode.",
|
|
288
|
-
"fieldName": "selected",
|
|
289
|
-
"inheritedFrom": {
|
|
290
|
-
"name": "ListMixin",
|
|
291
|
-
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
292
|
-
}
|
|
293
|
-
}
|
|
294
|
-
],
|
|
295
|
-
"mixins": [
|
|
296
|
-
{
|
|
297
|
-
"name": "ListMixin",
|
|
298
|
-
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
299
|
-
},
|
|
300
|
-
{
|
|
301
|
-
"name": "ThemableMixin",
|
|
302
|
-
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
303
|
-
},
|
|
304
|
-
{
|
|
305
|
-
"name": "DirMixin",
|
|
306
|
-
"package": "@vaadin/component-base/src/dir-mixin.js"
|
|
307
|
-
},
|
|
308
|
-
{
|
|
309
|
-
"name": "PolylitMixin",
|
|
310
|
-
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
311
|
-
},
|
|
312
|
-
{
|
|
313
|
-
"name": "LumoInjectionMixin",
|
|
314
|
-
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
315
|
-
}
|
|
316
|
-
],
|
|
317
|
-
"superclass": {
|
|
318
|
-
"name": "LitElement",
|
|
319
|
-
"package": "lit"
|
|
320
|
-
},
|
|
321
|
-
"tagName": "vaadin-menu-bar-list-box",
|
|
322
|
-
"customElement": true,
|
|
323
|
-
"events": []
|
|
324
|
-
}
|
|
325
|
-
],
|
|
326
|
-
"exports": [
|
|
327
|
-
{
|
|
328
|
-
"kind": "js",
|
|
329
|
-
"name": "MenuBarListBox",
|
|
330
|
-
"declaration": {
|
|
331
|
-
"name": "MenuBarListBox",
|
|
332
|
-
"module": "src/vaadin-menu-bar-list-box.js"
|
|
333
|
-
}
|
|
334
|
-
}
|
|
335
|
-
]
|
|
336
|
-
},
|
|
337
20
|
{
|
|
338
21
|
"kind": "javascript-module",
|
|
339
22
|
"path": "src/vaadin-menu-bar-mixin.js",
|
|
@@ -352,19 +35,9 @@
|
|
|
352
35
|
"kind": "field",
|
|
353
36
|
"name": "i18n",
|
|
354
37
|
"description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following JSON structure and default values:\n```js\n{\n moreOptions: 'More options'\n}\n```",
|
|
355
|
-
"
|
|
356
|
-
"
|
|
357
|
-
"text": "!MenuBarI18n"
|
|
358
|
-
}
|
|
38
|
+
"type": {
|
|
39
|
+
"text": "Object"
|
|
359
40
|
},
|
|
360
|
-
"parameters": [
|
|
361
|
-
{
|
|
362
|
-
"name": "value",
|
|
363
|
-
"type": {
|
|
364
|
-
"text": "Object"
|
|
365
|
-
}
|
|
366
|
-
}
|
|
367
|
-
],
|
|
368
41
|
"inheritedFrom": {
|
|
369
42
|
"name": "I18nMixin",
|
|
370
43
|
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
@@ -456,6 +129,22 @@
|
|
|
456
129
|
{
|
|
457
130
|
"name": "I18nMixin",
|
|
458
131
|
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"name": "DisabledMixin",
|
|
135
|
+
"package": "@vaadin/a11y-base/src/disabled-mixin.js"
|
|
136
|
+
},
|
|
137
|
+
{
|
|
138
|
+
"name": "FocusMixin",
|
|
139
|
+
"package": "@vaadin/a11y-base/src/focus-mixin.js"
|
|
140
|
+
},
|
|
141
|
+
{
|
|
142
|
+
"name": "KeyboardDirectionMixin",
|
|
143
|
+
"package": "@vaadin/a11y-base/src/keyboard-direction-mixin.js"
|
|
144
|
+
},
|
|
145
|
+
{
|
|
146
|
+
"name": "ResizeMixin",
|
|
147
|
+
"package": "@vaadin/component-base/src/resize-mixin.js"
|
|
459
148
|
}
|
|
460
149
|
],
|
|
461
150
|
"parameters": [
|
|
@@ -478,884 +167,29 @@
|
|
|
478
167
|
},
|
|
479
168
|
{
|
|
480
169
|
"kind": "javascript-module",
|
|
481
|
-
"path": "src/vaadin-menu-bar
|
|
170
|
+
"path": "src/vaadin-menu-bar.js",
|
|
482
171
|
"declarations": [
|
|
483
172
|
{
|
|
484
173
|
"kind": "class",
|
|
485
|
-
"description": "
|
|
486
|
-
"name": "
|
|
174
|
+
"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`](#/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\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>`](#/elements/vaadin-button).\n- `<vaadin-menu-bar-item>` - has the same API as [`<vaadin-item>`](#/elements/vaadin-item).\n- `<vaadin-menu-bar-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).\n- `<vaadin-menu-bar-submenu>` - has the same API as [`<vaadin-context-menu>`](#/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.",
|
|
175
|
+
"name": "MenuBar",
|
|
487
176
|
"members": [
|
|
488
|
-
{
|
|
489
|
-
"kind": "method",
|
|
490
|
-
"name": "bringToFront",
|
|
491
|
-
"description": "Brings the overlay as visually the frontmost one.",
|
|
492
|
-
"inheritedFrom": {
|
|
493
|
-
"name": "OverlayStackMixin",
|
|
494
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-stack-mixin.js"
|
|
495
|
-
}
|
|
496
|
-
},
|
|
497
177
|
{
|
|
498
178
|
"kind": "method",
|
|
499
179
|
"name": "close",
|
|
500
|
-
"
|
|
501
|
-
{
|
|
502
|
-
"name": "sourceEvent",
|
|
503
|
-
"type": {
|
|
504
|
-
"text": "Event="
|
|
505
|
-
}
|
|
506
|
-
}
|
|
507
|
-
],
|
|
508
|
-
"inheritedFrom": {
|
|
509
|
-
"name": "OverlayMixin",
|
|
510
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
511
|
-
}
|
|
512
|
-
},
|
|
513
|
-
{
|
|
514
|
-
"kind": "field",
|
|
515
|
-
"name": "focusTrap",
|
|
516
|
-
"privacy": "public",
|
|
517
|
-
"type": {
|
|
518
|
-
"text": "boolean"
|
|
519
|
-
},
|
|
520
|
-
"description": "When true, opening the overlay moves focus to the first focusable child,\nor to the overlay part with tabindex if there are no focusable children.",
|
|
521
|
-
"attribute": "focus-trap",
|
|
522
|
-
"inheritedFrom": {
|
|
523
|
-
"name": "OverlayFocusMixin",
|
|
524
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
525
|
-
}
|
|
526
|
-
},
|
|
527
|
-
{
|
|
528
|
-
"kind": "method",
|
|
529
|
-
"name": "getBoundaries",
|
|
530
|
-
"description": "Returns the adjusted boundaries of the overlay.",
|
|
531
|
-
"return": {
|
|
532
|
-
"type": {
|
|
533
|
-
"text": "object"
|
|
534
|
-
}
|
|
535
|
-
},
|
|
536
|
-
"inheritedFrom": {
|
|
537
|
-
"name": "MenuOverlayMixin",
|
|
538
|
-
"package": "@vaadin/context-menu/src/vaadin-menu-overlay-mixin.js"
|
|
539
|
-
}
|
|
540
|
-
},
|
|
541
|
-
{
|
|
542
|
-
"kind": "field",
|
|
543
|
-
"name": "hidden",
|
|
544
|
-
"privacy": "public",
|
|
545
|
-
"type": {
|
|
546
|
-
"text": "boolean"
|
|
547
|
-
},
|
|
548
|
-
"description": "When set to true, the overlay is hidden. This also closes the overlay\nimmediately in case there is a closing animation in progress.",
|
|
549
|
-
"attribute": "hidden",
|
|
180
|
+
"description": "Closes the current submenu.",
|
|
550
181
|
"inheritedFrom": {
|
|
551
|
-
"name": "
|
|
552
|
-
"
|
|
182
|
+
"name": "MenuBarMixin",
|
|
183
|
+
"module": "src/vaadin-menu-bar-mixin.js"
|
|
553
184
|
}
|
|
554
185
|
},
|
|
555
186
|
{
|
|
556
187
|
"kind": "field",
|
|
557
|
-
"name": "
|
|
558
|
-
"
|
|
188
|
+
"name": "i18n",
|
|
189
|
+
"description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following JSON structure and default values:\n```js\n{\n moreOptions: 'More options'\n}\n```",
|
|
559
190
|
"type": {
|
|
560
|
-
"text": "
|
|
561
|
-
},
|
|
562
|
-
"description": "When `positionTarget` is set, this property defines whether to align the overlay's\nleft or right side to the target element by default.\nPossible values are `start` and `end`.\nRTL is taken into account when interpreting the value.\nThe overlay is automatically flipped to the opposite side when it doesn't fit into\nthe default side defined by this property.",
|
|
563
|
-
"attribute": "horizontal-align",
|
|
564
|
-
"inheritedFrom": {
|
|
565
|
-
"name": "PositionMixin",
|
|
566
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
567
|
-
}
|
|
568
|
-
},
|
|
569
|
-
{
|
|
570
|
-
"kind": "field",
|
|
571
|
-
"name": "model",
|
|
572
|
-
"privacy": "public",
|
|
573
|
-
"type": {
|
|
574
|
-
"text": "object"
|
|
575
|
-
},
|
|
576
|
-
"description": "Object with properties that is passed to `renderer` function",
|
|
577
|
-
"attribute": "model",
|
|
578
|
-
"inheritedFrom": {
|
|
579
|
-
"name": "OverlayMixin",
|
|
580
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
581
|
-
}
|
|
582
|
-
},
|
|
583
|
-
{
|
|
584
|
-
"kind": "field",
|
|
585
|
-
"name": "modeless",
|
|
586
|
-
"privacy": "public",
|
|
587
|
-
"type": {
|
|
588
|
-
"text": "boolean"
|
|
589
|
-
},
|
|
590
|
-
"description": "When true the overlay won't disable the main content, showing\nit doesn't change the functionality of the user interface.",
|
|
591
|
-
"attribute": "modeless",
|
|
592
|
-
"inheritedFrom": {
|
|
593
|
-
"name": "OverlayMixin",
|
|
594
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
595
|
-
}
|
|
596
|
-
},
|
|
597
|
-
{
|
|
598
|
-
"kind": "field",
|
|
599
|
-
"name": "noHorizontalOverlap",
|
|
600
|
-
"privacy": "public",
|
|
601
|
-
"type": {
|
|
602
|
-
"text": "boolean"
|
|
603
|
-
},
|
|
604
|
-
"description": "When `positionTarget` is set, this property defines whether the overlay should overlap\nthe target element in the x-axis, or be positioned right next to it.",
|
|
605
|
-
"attribute": "no-horizontal-overlap",
|
|
606
|
-
"inheritedFrom": {
|
|
607
|
-
"name": "PositionMixin",
|
|
608
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
609
|
-
}
|
|
610
|
-
},
|
|
611
|
-
{
|
|
612
|
-
"kind": "field",
|
|
613
|
-
"name": "noVerticalOverlap",
|
|
614
|
-
"privacy": "public",
|
|
615
|
-
"type": {
|
|
616
|
-
"text": "boolean"
|
|
617
|
-
},
|
|
618
|
-
"description": "When `positionTarget` is set, this property defines whether the overlay should overlap\nthe target element in the y-axis, or be positioned right above/below it.",
|
|
619
|
-
"attribute": "no-vertical-overlap",
|
|
620
|
-
"inheritedFrom": {
|
|
621
|
-
"name": "PositionMixin",
|
|
622
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
623
|
-
}
|
|
624
|
-
},
|
|
625
|
-
{
|
|
626
|
-
"kind": "field",
|
|
627
|
-
"name": "opened",
|
|
628
|
-
"privacy": "public",
|
|
629
|
-
"type": {
|
|
630
|
-
"text": "boolean"
|
|
631
|
-
},
|
|
632
|
-
"description": "When true, the overlay is visible and attached to body.",
|
|
633
|
-
"attribute": "opened",
|
|
634
|
-
"inheritedFrom": {
|
|
635
|
-
"name": "OverlayMixin",
|
|
636
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
637
|
-
}
|
|
638
|
-
},
|
|
639
|
-
{
|
|
640
|
-
"kind": "field",
|
|
641
|
-
"name": "owner",
|
|
642
|
-
"privacy": "public",
|
|
643
|
-
"type": {
|
|
644
|
-
"text": "HTMLElement"
|
|
645
|
-
},
|
|
646
|
-
"description": "Owner element passed with renderer function",
|
|
647
|
-
"attribute": "owner",
|
|
648
|
-
"inheritedFrom": {
|
|
649
|
-
"name": "OverlayMixin",
|
|
650
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
651
|
-
}
|
|
652
|
-
},
|
|
653
|
-
{
|
|
654
|
-
"kind": "field",
|
|
655
|
-
"name": "positionTarget",
|
|
656
|
-
"privacy": "public",
|
|
657
|
-
"type": {
|
|
658
|
-
"text": "object"
|
|
659
|
-
},
|
|
660
|
-
"description": "The element next to which this overlay should be aligned.\nThe position of the overlay relative to the positionTarget can be adjusted\nwith properties `horizontalAlign`, `verticalAlign`, `noHorizontalOverlap`\nand `noVerticalOverlap`.",
|
|
661
|
-
"attribute": "position-target",
|
|
662
|
-
"inheritedFrom": {
|
|
663
|
-
"name": "PositionMixin",
|
|
664
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
665
|
-
}
|
|
666
|
-
},
|
|
667
|
-
{
|
|
668
|
-
"kind": "field",
|
|
669
|
-
"name": "renderer",
|
|
670
|
-
"privacy": "public",
|
|
671
|
-
"type": {
|
|
672
|
-
"text": "OverlayRenderer | null | undefined"
|
|
673
|
-
},
|
|
674
|
-
"description": "Custom function for rendering the content of the overlay.\nReceives three arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `owner` The host element of the renderer function.\n- `model` The object with the properties related with rendering.",
|
|
675
|
-
"attribute": "renderer",
|
|
676
|
-
"inheritedFrom": {
|
|
677
|
-
"name": "OverlayMixin",
|
|
678
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
679
|
-
}
|
|
680
|
-
},
|
|
681
|
-
{
|
|
682
|
-
"kind": "method",
|
|
683
|
-
"name": "requestContentUpdate",
|
|
684
|
-
"description": "Requests an update for the content of the overlay.\nWhile performing the update, it invokes the renderer passed in the `renderer` property.\n\nIt is not guaranteed that the update happens immediately (synchronously) after it is requested.",
|
|
685
|
-
"inheritedFrom": {
|
|
686
|
-
"name": "OverlayMixin",
|
|
687
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
688
|
-
}
|
|
689
|
-
},
|
|
690
|
-
{
|
|
691
|
-
"kind": "field",
|
|
692
|
-
"name": "requiredVerticalSpace",
|
|
693
|
-
"privacy": "public",
|
|
694
|
-
"type": {
|
|
695
|
-
"text": "number"
|
|
696
|
-
},
|
|
697
|
-
"description": "If the overlay content has no intrinsic height, this property can be used to set\nthe minimum vertical space (in pixels) required by the overlay. Setting a value to\nthe property effectively disables the content measurement in favor of using this\nfixed value for determining the open direction.",
|
|
698
|
-
"attribute": "required-vertical-space",
|
|
699
|
-
"inheritedFrom": {
|
|
700
|
-
"name": "PositionMixin",
|
|
701
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
702
|
-
}
|
|
703
|
-
},
|
|
704
|
-
{
|
|
705
|
-
"kind": "field",
|
|
706
|
-
"name": "restoreFocusNode",
|
|
707
|
-
"privacy": "public",
|
|
708
|
-
"type": {
|
|
709
|
-
"text": "HTMLElement"
|
|
710
|
-
},
|
|
711
|
-
"description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.",
|
|
712
|
-
"attribute": "restore-focus-node",
|
|
713
|
-
"inheritedFrom": {
|
|
714
|
-
"name": "OverlayFocusMixin",
|
|
715
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
716
|
-
}
|
|
717
|
-
},
|
|
718
|
-
{
|
|
719
|
-
"kind": "field",
|
|
720
|
-
"name": "restoreFocusOnClose",
|
|
721
|
-
"privacy": "public",
|
|
722
|
-
"type": {
|
|
723
|
-
"text": "boolean"
|
|
724
|
-
},
|
|
725
|
-
"description": "Set to true to enable restoring of focus when overlay is closed.",
|
|
726
|
-
"attribute": "restore-focus-on-close",
|
|
727
|
-
"inheritedFrom": {
|
|
728
|
-
"name": "OverlayFocusMixin",
|
|
729
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
730
|
-
}
|
|
731
|
-
},
|
|
732
|
-
{
|
|
733
|
-
"kind": "method",
|
|
734
|
-
"name": "setBounds",
|
|
735
|
-
"parameters": [
|
|
736
|
-
{
|
|
737
|
-
"name": "bounds",
|
|
738
|
-
"type": {
|
|
739
|
-
"text": "!OverlayBoundsParam"
|
|
740
|
-
}
|
|
741
|
-
},
|
|
742
|
-
{
|
|
743
|
-
"name": "absolute",
|
|
744
|
-
"default": "true",
|
|
745
|
-
"type": {
|
|
746
|
-
"text": "boolean"
|
|
747
|
-
}
|
|
748
|
-
}
|
|
749
|
-
],
|
|
750
|
-
"description": "Updates the coordinates of the overlay.",
|
|
751
|
-
"inheritedFrom": {
|
|
752
|
-
"name": "OverlayMixin",
|
|
753
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
754
|
-
}
|
|
755
|
-
},
|
|
756
|
-
{
|
|
757
|
-
"kind": "field",
|
|
758
|
-
"name": "verticalAlign",
|
|
759
|
-
"privacy": "public",
|
|
760
|
-
"type": {
|
|
761
|
-
"text": "string"
|
|
762
|
-
},
|
|
763
|
-
"description": "When `positionTarget` is set, this property defines whether to align the overlay's\ntop or bottom side to the target element by default.\nPossible values are `top` and `bottom`.\nThe overlay is automatically flipped to the opposite side when it doesn't fit into\nthe default side defined by this property.",
|
|
764
|
-
"attribute": "vertical-align",
|
|
765
|
-
"inheritedFrom": {
|
|
766
|
-
"name": "PositionMixin",
|
|
767
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
768
|
-
}
|
|
769
|
-
},
|
|
770
|
-
{
|
|
771
|
-
"kind": "field",
|
|
772
|
-
"name": "withBackdrop",
|
|
773
|
-
"privacy": "public",
|
|
774
|
-
"type": {
|
|
775
|
-
"text": "boolean"
|
|
776
|
-
},
|
|
777
|
-
"description": "When true the overlay has backdrop on top of content when opened.",
|
|
778
|
-
"attribute": "with-backdrop",
|
|
779
|
-
"inheritedFrom": {
|
|
780
|
-
"name": "OverlayMixin",
|
|
781
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
782
|
-
}
|
|
783
|
-
}
|
|
784
|
-
],
|
|
785
|
-
"mixins": [
|
|
786
|
-
{
|
|
787
|
-
"name": "MenuOverlayMixin",
|
|
788
|
-
"package": "@vaadin/context-menu/src/vaadin-menu-overlay-mixin.js"
|
|
789
|
-
},
|
|
790
|
-
{
|
|
791
|
-
"name": "OverlayMixin",
|
|
792
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
793
|
-
},
|
|
794
|
-
{
|
|
795
|
-
"name": "DirMixin",
|
|
796
|
-
"package": "@vaadin/component-base/src/dir-mixin.js"
|
|
797
|
-
},
|
|
798
|
-
{
|
|
799
|
-
"name": "ThemableMixin",
|
|
800
|
-
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
801
|
-
},
|
|
802
|
-
{
|
|
803
|
-
"name": "PolylitMixin",
|
|
804
|
-
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
805
|
-
},
|
|
806
|
-
{
|
|
807
|
-
"name": "LumoInjectionMixin",
|
|
808
|
-
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
809
|
-
}
|
|
810
|
-
],
|
|
811
|
-
"superclass": {
|
|
812
|
-
"name": "LitElement",
|
|
813
|
-
"package": "lit"
|
|
814
|
-
},
|
|
815
|
-
"tagName": "vaadin-menu-bar-overlay",
|
|
816
|
-
"customElement": true,
|
|
817
|
-
"attributes": [
|
|
818
|
-
{
|
|
819
|
-
"name": "focus-trap",
|
|
820
|
-
"type": {
|
|
821
|
-
"text": "boolean"
|
|
822
|
-
},
|
|
823
|
-
"description": "When true, opening the overlay moves focus to the first focusable child,\nor to the overlay part with tabindex if there are no focusable children.",
|
|
824
|
-
"fieldName": "focusTrap",
|
|
825
|
-
"inheritedFrom": {
|
|
826
|
-
"name": "OverlayFocusMixin",
|
|
827
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
828
|
-
}
|
|
829
|
-
},
|
|
830
|
-
{
|
|
831
|
-
"name": "hidden",
|
|
832
|
-
"type": {
|
|
833
|
-
"text": "boolean"
|
|
834
|
-
},
|
|
835
|
-
"description": "When set to true, the overlay is hidden. This also closes the overlay\nimmediately in case there is a closing animation in progress.",
|
|
836
|
-
"fieldName": "hidden",
|
|
837
|
-
"inheritedFrom": {
|
|
838
|
-
"name": "OverlayMixin",
|
|
839
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
840
|
-
}
|
|
841
|
-
},
|
|
842
|
-
{
|
|
843
|
-
"name": "horizontal-align",
|
|
844
|
-
"type": {
|
|
845
|
-
"text": "string"
|
|
846
|
-
},
|
|
847
|
-
"description": "When `positionTarget` is set, this property defines whether to align the overlay's\nleft or right side to the target element by default.\nPossible values are `start` and `end`.\nRTL is taken into account when interpreting the value.\nThe overlay is automatically flipped to the opposite side when it doesn't fit into\nthe default side defined by this property.",
|
|
848
|
-
"fieldName": "horizontalAlign",
|
|
849
|
-
"inheritedFrom": {
|
|
850
|
-
"name": "PositionMixin",
|
|
851
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
852
|
-
}
|
|
853
|
-
},
|
|
854
|
-
{
|
|
855
|
-
"name": "modeless",
|
|
856
|
-
"type": {
|
|
857
|
-
"text": "boolean"
|
|
858
|
-
},
|
|
859
|
-
"description": "When true the overlay won't disable the main content, showing\nit doesn't change the functionality of the user interface.",
|
|
860
|
-
"fieldName": "modeless",
|
|
861
|
-
"inheritedFrom": {
|
|
862
|
-
"name": "OverlayMixin",
|
|
863
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
864
|
-
}
|
|
865
|
-
},
|
|
866
|
-
{
|
|
867
|
-
"name": "no-horizontal-overlap",
|
|
868
|
-
"type": {
|
|
869
|
-
"text": "boolean"
|
|
870
|
-
},
|
|
871
|
-
"description": "When `positionTarget` is set, this property defines whether the overlay should overlap\nthe target element in the x-axis, or be positioned right next to it.",
|
|
872
|
-
"fieldName": "noHorizontalOverlap",
|
|
873
|
-
"inheritedFrom": {
|
|
874
|
-
"name": "PositionMixin",
|
|
875
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
876
|
-
}
|
|
877
|
-
},
|
|
878
|
-
{
|
|
879
|
-
"name": "no-vertical-overlap",
|
|
880
|
-
"type": {
|
|
881
|
-
"text": "boolean"
|
|
882
|
-
},
|
|
883
|
-
"description": "When `positionTarget` is set, this property defines whether the overlay should overlap\nthe target element in the y-axis, or be positioned right above/below it.",
|
|
884
|
-
"fieldName": "noVerticalOverlap",
|
|
885
|
-
"inheritedFrom": {
|
|
886
|
-
"name": "PositionMixin",
|
|
887
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
888
|
-
}
|
|
889
|
-
},
|
|
890
|
-
{
|
|
891
|
-
"name": "opened",
|
|
892
|
-
"type": {
|
|
893
|
-
"text": "boolean"
|
|
894
|
-
},
|
|
895
|
-
"description": "When true, the overlay is visible and attached to body.",
|
|
896
|
-
"fieldName": "opened",
|
|
897
|
-
"inheritedFrom": {
|
|
898
|
-
"name": "OverlayMixin",
|
|
899
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
900
|
-
}
|
|
901
|
-
},
|
|
902
|
-
{
|
|
903
|
-
"name": "owner",
|
|
904
|
-
"type": {
|
|
905
|
-
"text": "HTMLElement"
|
|
906
|
-
},
|
|
907
|
-
"description": "Owner element passed with renderer function",
|
|
908
|
-
"fieldName": "owner",
|
|
909
|
-
"inheritedFrom": {
|
|
910
|
-
"name": "OverlayMixin",
|
|
911
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
912
|
-
}
|
|
913
|
-
},
|
|
914
|
-
{
|
|
915
|
-
"name": "renderer",
|
|
916
|
-
"type": {
|
|
917
|
-
"text": "OverlayRenderer | null | undefined"
|
|
918
|
-
},
|
|
919
|
-
"description": "Custom function for rendering the content of the overlay.\nReceives three arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `owner` The host element of the renderer function.\n- `model` The object with the properties related with rendering.",
|
|
920
|
-
"fieldName": "renderer",
|
|
921
|
-
"inheritedFrom": {
|
|
922
|
-
"name": "OverlayMixin",
|
|
923
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
924
|
-
}
|
|
925
|
-
},
|
|
926
|
-
{
|
|
927
|
-
"name": "required-vertical-space",
|
|
928
|
-
"type": {
|
|
929
|
-
"text": "number"
|
|
930
|
-
},
|
|
931
|
-
"description": "If the overlay content has no intrinsic height, this property can be used to set\nthe minimum vertical space (in pixels) required by the overlay. Setting a value to\nthe property effectively disables the content measurement in favor of using this\nfixed value for determining the open direction.",
|
|
932
|
-
"fieldName": "requiredVerticalSpace",
|
|
933
|
-
"inheritedFrom": {
|
|
934
|
-
"name": "PositionMixin",
|
|
935
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
936
|
-
}
|
|
937
|
-
},
|
|
938
|
-
{
|
|
939
|
-
"name": "restore-focus-node",
|
|
940
|
-
"type": {
|
|
941
|
-
"text": "HTMLElement"
|
|
942
|
-
},
|
|
943
|
-
"description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.",
|
|
944
|
-
"fieldName": "restoreFocusNode",
|
|
945
|
-
"inheritedFrom": {
|
|
946
|
-
"name": "OverlayFocusMixin",
|
|
947
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
948
|
-
}
|
|
949
|
-
},
|
|
950
|
-
{
|
|
951
|
-
"name": "restore-focus-on-close",
|
|
952
|
-
"type": {
|
|
953
|
-
"text": "boolean"
|
|
954
|
-
},
|
|
955
|
-
"description": "Set to true to enable restoring of focus when overlay is closed.",
|
|
956
|
-
"fieldName": "restoreFocusOnClose",
|
|
957
|
-
"inheritedFrom": {
|
|
958
|
-
"name": "OverlayFocusMixin",
|
|
959
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
960
|
-
}
|
|
961
|
-
},
|
|
962
|
-
{
|
|
963
|
-
"name": "vertical-align",
|
|
964
|
-
"type": {
|
|
965
|
-
"text": "string"
|
|
966
|
-
},
|
|
967
|
-
"description": "When `positionTarget` is set, this property defines whether to align the overlay's\ntop or bottom side to the target element by default.\nPossible values are `top` and `bottom`.\nThe overlay is automatically flipped to the opposite side when it doesn't fit into\nthe default side defined by this property.",
|
|
968
|
-
"fieldName": "verticalAlign",
|
|
969
|
-
"inheritedFrom": {
|
|
970
|
-
"name": "PositionMixin",
|
|
971
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
972
|
-
}
|
|
973
|
-
},
|
|
974
|
-
{
|
|
975
|
-
"name": "with-backdrop",
|
|
976
|
-
"type": {
|
|
977
|
-
"text": "boolean"
|
|
978
|
-
},
|
|
979
|
-
"description": "When true the overlay has backdrop on top of content when opened.",
|
|
980
|
-
"fieldName": "withBackdrop",
|
|
981
|
-
"inheritedFrom": {
|
|
982
|
-
"name": "OverlayMixin",
|
|
983
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
984
|
-
}
|
|
985
|
-
}
|
|
986
|
-
],
|
|
987
|
-
"events": [
|
|
988
|
-
{
|
|
989
|
-
"name": "vaadin-overlay-closed",
|
|
990
|
-
"type": {
|
|
991
|
-
"text": "CustomEvent"
|
|
992
|
-
},
|
|
993
|
-
"inheritedFrom": {
|
|
994
|
-
"name": "OverlayMixin",
|
|
995
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
996
|
-
}
|
|
997
|
-
},
|
|
998
|
-
{
|
|
999
|
-
"name": "vaadin-overlay-closing",
|
|
1000
|
-
"type": {
|
|
1001
|
-
"text": "CustomEvent"
|
|
1002
|
-
},
|
|
1003
|
-
"inheritedFrom": {
|
|
1004
|
-
"name": "OverlayMixin",
|
|
1005
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1006
|
-
}
|
|
1007
|
-
}
|
|
1008
|
-
]
|
|
1009
|
-
}
|
|
1010
|
-
],
|
|
1011
|
-
"exports": [
|
|
1012
|
-
{
|
|
1013
|
-
"kind": "js",
|
|
1014
|
-
"name": "MenuBarOverlay",
|
|
1015
|
-
"declaration": {
|
|
1016
|
-
"name": "MenuBarOverlay",
|
|
1017
|
-
"module": "src/vaadin-menu-bar-overlay.js"
|
|
1018
|
-
}
|
|
1019
|
-
}
|
|
1020
|
-
]
|
|
1021
|
-
},
|
|
1022
|
-
{
|
|
1023
|
-
"kind": "javascript-module",
|
|
1024
|
-
"path": "src/vaadin-menu-bar-submenu.js",
|
|
1025
|
-
"declarations": [
|
|
1026
|
-
{
|
|
1027
|
-
"kind": "class",
|
|
1028
|
-
"description": "An element used internally by `<vaadin-menu-bar>`. Not intended to be used separately.",
|
|
1029
|
-
"name": "MenuBarSubmenu",
|
|
1030
|
-
"members": [
|
|
1031
|
-
{
|
|
1032
|
-
"kind": "method",
|
|
1033
|
-
"name": "close",
|
|
1034
|
-
"description": "Overriding the public method to reset expanded button state.",
|
|
1035
|
-
"inheritedFrom": {
|
|
1036
|
-
"name": "ContextMenuMixin",
|
|
1037
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1038
|
-
}
|
|
1039
|
-
},
|
|
1040
|
-
{
|
|
1041
|
-
"kind": "field",
|
|
1042
|
-
"name": "closeOn",
|
|
1043
|
-
"privacy": "public",
|
|
1044
|
-
"type": {
|
|
1045
|
-
"text": "string"
|
|
1046
|
-
},
|
|
1047
|
-
"description": "Event name to listen for closing the context menu.",
|
|
1048
|
-
"attribute": "close-on",
|
|
1049
|
-
"inheritedFrom": {
|
|
1050
|
-
"name": "ContextMenuMixin",
|
|
1051
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1052
|
-
}
|
|
1053
|
-
},
|
|
1054
|
-
{
|
|
1055
|
-
"kind": "field",
|
|
1056
|
-
"name": "isRoot",
|
|
1057
|
-
"privacy": "public",
|
|
1058
|
-
"type": {
|
|
1059
|
-
"text": "boolean"
|
|
1060
|
-
},
|
|
1061
|
-
"attribute": "is-root"
|
|
1062
|
-
},
|
|
1063
|
-
{
|
|
1064
|
-
"kind": "field",
|
|
1065
|
-
"name": "items",
|
|
1066
|
-
"privacy": "public",
|
|
1067
|
-
"type": {
|
|
1068
|
-
"text": "!Array<!ContextMenuItem> | undefined"
|
|
1069
|
-
},
|
|
1070
|
-
"description": "Defines a (hierarchical) menu structure for the component.\nIf a menu item has a non-empty `children` set, a sub-menu with the child items is opened\nnext to the parent menu on mouseover, tap or a right arrow keypress.\n\nThe items API can't be used together with a renderer!\n\n#### Example\n\n```javascript\ncontextMenu.items = [\n { text: 'Menu Item 1', theme: 'primary', className: 'first', children:\n [\n { text: 'Menu Item 1-1', checked: true, keepOpen: true },\n { text: 'Menu Item 1-2' }\n ]\n },\n { component: 'hr' },\n { text: 'Menu Item 2', children:\n [\n { text: 'Menu Item 2-1' },\n { text: 'Menu Item 2-2', disabled: true }\n ]\n },\n { text: 'Menu Item 3', disabled: true, className: 'last' }\n];\n```",
|
|
1071
|
-
"attribute": "items",
|
|
1072
|
-
"inheritedFrom": {
|
|
1073
|
-
"name": "ItemsMixin",
|
|
1074
|
-
"package": "@vaadin/context-menu/src/vaadin-contextmenu-items-mixin.js"
|
|
1075
|
-
}
|
|
1076
|
-
},
|
|
1077
|
-
{
|
|
1078
|
-
"kind": "field",
|
|
1079
|
-
"name": "listenOn",
|
|
1080
|
-
"privacy": "public",
|
|
1081
|
-
"type": {
|
|
1082
|
-
"text": "!HTMLElement"
|
|
1083
|
-
},
|
|
1084
|
-
"description": "The target element that's listened to for context menu opening events.\nBy default the vaadin-context-menu listens to the target's `vaadin-contextmenu`\nevents.",
|
|
1085
|
-
"default": "self",
|
|
1086
|
-
"attribute": "listen-on",
|
|
1087
|
-
"inheritedFrom": {
|
|
1088
|
-
"name": "ContextMenuMixin",
|
|
1089
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1090
|
-
}
|
|
1091
|
-
},
|
|
1092
|
-
{
|
|
1093
|
-
"kind": "method",
|
|
1094
|
-
"name": "open",
|
|
1095
|
-
"parameters": [
|
|
1096
|
-
{
|
|
1097
|
-
"name": "e",
|
|
1098
|
-
"description": "used as the context for the menu. Overlay coordinates are taken from this event.",
|
|
1099
|
-
"type": {
|
|
1100
|
-
"text": "!Event | undefined"
|
|
1101
|
-
}
|
|
1102
|
-
}
|
|
1103
|
-
],
|
|
1104
|
-
"description": "Opens the overlay.",
|
|
1105
|
-
"inheritedFrom": {
|
|
1106
|
-
"name": "ContextMenuMixin",
|
|
1107
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1108
|
-
}
|
|
1109
|
-
},
|
|
1110
|
-
{
|
|
1111
|
-
"kind": "field",
|
|
1112
|
-
"name": "opened",
|
|
1113
|
-
"privacy": "public",
|
|
1114
|
-
"type": {
|
|
1115
|
-
"text": "boolean"
|
|
1116
|
-
},
|
|
1117
|
-
"description": "True if the overlay is currently displayed.",
|
|
1118
|
-
"attribute": "opened",
|
|
1119
|
-
"inheritedFrom": {
|
|
1120
|
-
"name": "ContextMenuMixin",
|
|
1121
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1122
|
-
}
|
|
1123
|
-
},
|
|
1124
|
-
{
|
|
1125
|
-
"kind": "field",
|
|
1126
|
-
"name": "openOn",
|
|
1127
|
-
"privacy": "public",
|
|
1128
|
-
"type": {
|
|
1129
|
-
"text": "string"
|
|
1130
|
-
},
|
|
1131
|
-
"description": "Event name to listen for opening the context menu.",
|
|
1132
|
-
"attribute": "open-on",
|
|
1133
|
-
"default": "'opensubmenu'",
|
|
1134
|
-
"inheritedFrom": {
|
|
1135
|
-
"name": "ContextMenuMixin",
|
|
1136
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1137
|
-
}
|
|
1138
|
-
},
|
|
1139
|
-
{
|
|
1140
|
-
"kind": "field",
|
|
1141
|
-
"name": "renderer",
|
|
1142
|
-
"privacy": "public",
|
|
1143
|
-
"type": {
|
|
1144
|
-
"text": "ContextMenuRenderer | undefined"
|
|
1145
|
-
},
|
|
1146
|
-
"description": "Custom function for rendering the content of the menu overlay.\nReceives three arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `contextMenu` The reference to the `<vaadin-context-menu>` element.\n- `context` The object with the menu context, contains:\n - `context.target` the target of the menu opening event,\n - `context.detail` the menu opening event detail.",
|
|
1147
|
-
"attribute": "renderer",
|
|
1148
|
-
"inheritedFrom": {
|
|
1149
|
-
"name": "ContextMenuMixin",
|
|
1150
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1151
|
-
}
|
|
1152
|
-
},
|
|
1153
|
-
{
|
|
1154
|
-
"kind": "method",
|
|
1155
|
-
"name": "requestContentUpdate",
|
|
1156
|
-
"description": "Requests an update for the content of the menu overlay.\nWhile performing the update, it invokes the renderer passed in the `renderer` property.\n\nIt is not guaranteed that the update happens immediately (synchronously) after it is requested.",
|
|
1157
|
-
"inheritedFrom": {
|
|
1158
|
-
"name": "ContextMenuMixin",
|
|
1159
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1160
|
-
}
|
|
1161
|
-
},
|
|
1162
|
-
{
|
|
1163
|
-
"kind": "field",
|
|
1164
|
-
"name": "selector",
|
|
1165
|
-
"privacy": "public",
|
|
1166
|
-
"type": {
|
|
1167
|
-
"text": "string"
|
|
1168
|
-
},
|
|
1169
|
-
"description": "CSS selector that can be used to target any child element\nof the context menu to listen for `openOn` events.",
|
|
1170
|
-
"attribute": "selector",
|
|
1171
|
-
"inheritedFrom": {
|
|
1172
|
-
"name": "ContextMenuMixin",
|
|
1173
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1174
|
-
}
|
|
1175
|
-
}
|
|
1176
|
-
],
|
|
1177
|
-
"attributes": [
|
|
1178
|
-
{
|
|
1179
|
-
"name": "close-on",
|
|
1180
|
-
"type": {
|
|
1181
|
-
"text": "string"
|
|
1182
|
-
},
|
|
1183
|
-
"description": "Event name to listen for closing the context menu.",
|
|
1184
|
-
"fieldName": "closeOn",
|
|
1185
|
-
"inheritedFrom": {
|
|
1186
|
-
"name": "ContextMenuMixin",
|
|
1187
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1188
|
-
}
|
|
1189
|
-
},
|
|
1190
|
-
{
|
|
1191
|
-
"name": "is-root",
|
|
1192
|
-
"type": {
|
|
1193
|
-
"text": "boolean"
|
|
1194
|
-
},
|
|
1195
|
-
"fieldName": "isRoot"
|
|
1196
|
-
},
|
|
1197
|
-
{
|
|
1198
|
-
"name": "listen-on",
|
|
1199
|
-
"type": {
|
|
1200
|
-
"text": "!HTMLElement"
|
|
1201
|
-
},
|
|
1202
|
-
"description": "The target element that's listened to for context menu opening events.\nBy default the vaadin-context-menu listens to the target's `vaadin-contextmenu`\nevents.",
|
|
1203
|
-
"default": "self",
|
|
1204
|
-
"fieldName": "listenOn",
|
|
1205
|
-
"inheritedFrom": {
|
|
1206
|
-
"name": "ContextMenuMixin",
|
|
1207
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1208
|
-
}
|
|
1209
|
-
},
|
|
1210
|
-
{
|
|
1211
|
-
"name": "open-on",
|
|
1212
|
-
"type": {
|
|
1213
|
-
"text": "string"
|
|
1214
|
-
},
|
|
1215
|
-
"description": "Event name to listen for opening the context menu.",
|
|
1216
|
-
"fieldName": "openOn",
|
|
1217
|
-
"inheritedFrom": {
|
|
1218
|
-
"name": "ContextMenuMixin",
|
|
1219
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1220
|
-
}
|
|
1221
|
-
},
|
|
1222
|
-
{
|
|
1223
|
-
"name": "opened",
|
|
1224
|
-
"type": {
|
|
1225
|
-
"text": "boolean"
|
|
1226
|
-
},
|
|
1227
|
-
"description": "True if the overlay is currently displayed.",
|
|
1228
|
-
"fieldName": "opened",
|
|
1229
|
-
"inheritedFrom": {
|
|
1230
|
-
"name": "ContextMenuMixin",
|
|
1231
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1232
|
-
}
|
|
1233
|
-
},
|
|
1234
|
-
{
|
|
1235
|
-
"name": "renderer",
|
|
1236
|
-
"type": {
|
|
1237
|
-
"text": "ContextMenuRenderer | undefined"
|
|
1238
|
-
},
|
|
1239
|
-
"description": "Custom function for rendering the content of the menu overlay.\nReceives three arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `contextMenu` The reference to the `<vaadin-context-menu>` element.\n- `context` The object with the menu context, contains:\n - `context.target` the target of the menu opening event,\n - `context.detail` the menu opening event detail.",
|
|
1240
|
-
"fieldName": "renderer",
|
|
1241
|
-
"inheritedFrom": {
|
|
1242
|
-
"name": "ContextMenuMixin",
|
|
1243
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1244
|
-
}
|
|
1245
|
-
},
|
|
1246
|
-
{
|
|
1247
|
-
"name": "selector",
|
|
1248
|
-
"type": {
|
|
1249
|
-
"text": "string"
|
|
1250
|
-
},
|
|
1251
|
-
"description": "CSS selector that can be used to target any child element\nof the context menu to listen for `openOn` events.",
|
|
1252
|
-
"fieldName": "selector",
|
|
1253
|
-
"inheritedFrom": {
|
|
1254
|
-
"name": "ContextMenuMixin",
|
|
1255
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1256
|
-
}
|
|
1257
|
-
}
|
|
1258
|
-
],
|
|
1259
|
-
"mixins": [
|
|
1260
|
-
{
|
|
1261
|
-
"name": "ContextMenuMixin",
|
|
1262
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1263
|
-
},
|
|
1264
|
-
{
|
|
1265
|
-
"name": "ThemePropertyMixin",
|
|
1266
|
-
"package": "@vaadin/vaadin-themable-mixin/vaadin-theme-property-mixin.js"
|
|
1267
|
-
},
|
|
1268
|
-
{
|
|
1269
|
-
"name": "PolylitMixin",
|
|
1270
|
-
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
1271
|
-
}
|
|
1272
|
-
],
|
|
1273
|
-
"superclass": {
|
|
1274
|
-
"name": "LitElement",
|
|
1275
|
-
"package": "lit"
|
|
1276
|
-
},
|
|
1277
|
-
"tagName": "vaadin-menu-bar-submenu",
|
|
1278
|
-
"customElement": true,
|
|
1279
|
-
"events": [
|
|
1280
|
-
{
|
|
1281
|
-
"name": "close-all-menus",
|
|
1282
|
-
"type": {
|
|
1283
|
-
"text": "CustomEvent"
|
|
1284
|
-
},
|
|
1285
|
-
"inheritedFrom": {
|
|
1286
|
-
"name": "ItemsMixin",
|
|
1287
|
-
"package": "@vaadin/context-menu/src/vaadin-contextmenu-items-mixin.js"
|
|
1288
|
-
}
|
|
1289
|
-
},
|
|
1290
|
-
{
|
|
1291
|
-
"name": "closed",
|
|
1292
|
-
"type": {
|
|
1293
|
-
"text": "CustomEvent"
|
|
1294
|
-
},
|
|
1295
|
-
"inheritedFrom": {
|
|
1296
|
-
"name": "ContextMenuMixin",
|
|
1297
|
-
"package": "@vaadin/context-menu/src/vaadin-context-menu-mixin.js"
|
|
1298
|
-
}
|
|
1299
|
-
},
|
|
1300
|
-
{
|
|
1301
|
-
"name": "item-selected",
|
|
1302
|
-
"type": {
|
|
1303
|
-
"text": "CustomEvent"
|
|
1304
|
-
},
|
|
1305
|
-
"inheritedFrom": {
|
|
1306
|
-
"name": "ItemsMixin",
|
|
1307
|
-
"package": "@vaadin/context-menu/src/vaadin-contextmenu-items-mixin.js"
|
|
1308
|
-
}
|
|
1309
|
-
}
|
|
1310
|
-
]
|
|
1311
|
-
}
|
|
1312
|
-
],
|
|
1313
|
-
"exports": [
|
|
1314
|
-
{
|
|
1315
|
-
"kind": "js",
|
|
1316
|
-
"name": "MenuBarSubmenu",
|
|
1317
|
-
"declaration": {
|
|
1318
|
-
"name": "MenuBarSubmenu",
|
|
1319
|
-
"module": "src/vaadin-menu-bar-submenu.js"
|
|
1320
|
-
}
|
|
1321
|
-
}
|
|
1322
|
-
]
|
|
1323
|
-
},
|
|
1324
|
-
{
|
|
1325
|
-
"kind": "javascript-module",
|
|
1326
|
-
"path": "src/vaadin-menu-bar.js",
|
|
1327
|
-
"declarations": [
|
|
1328
|
-
{
|
|
1329
|
-
"kind": "class",
|
|
1330
|
-
"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`](#/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\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>`](#/elements/vaadin-button).\n- `<vaadin-menu-bar-item>` - has the same API as [`<vaadin-item>`](#/elements/vaadin-item).\n- `<vaadin-menu-bar-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).\n- `<vaadin-menu-bar-submenu>` - has the same API as [`<vaadin-context-menu>`](#/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.",
|
|
1331
|
-
"name": "MenuBar",
|
|
1332
|
-
"members": [
|
|
1333
|
-
{
|
|
1334
|
-
"kind": "method",
|
|
1335
|
-
"name": "close",
|
|
1336
|
-
"description": "Closes the current submenu.",
|
|
1337
|
-
"inheritedFrom": {
|
|
1338
|
-
"name": "MenuBarMixin",
|
|
1339
|
-
"module": "src/vaadin-menu-bar-mixin.js"
|
|
1340
|
-
}
|
|
1341
|
-
},
|
|
1342
|
-
{
|
|
1343
|
-
"kind": "field",
|
|
1344
|
-
"name": "i18n",
|
|
1345
|
-
"description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following JSON structure and default values:\n```js\n{\n moreOptions: 'More options'\n}\n```",
|
|
1346
|
-
"return": {
|
|
1347
|
-
"type": {
|
|
1348
|
-
"text": "!MenuBarI18n"
|
|
1349
|
-
}
|
|
191
|
+
"text": "Object"
|
|
1350
192
|
},
|
|
1351
|
-
"parameters": [
|
|
1352
|
-
{
|
|
1353
|
-
"name": "value",
|
|
1354
|
-
"type": {
|
|
1355
|
-
"text": "Object"
|
|
1356
|
-
}
|
|
1357
|
-
}
|
|
1358
|
-
],
|
|
1359
193
|
"inheritedFrom": {
|
|
1360
194
|
"name": "I18nMixin",
|
|
1361
195
|
"package": "@vaadin/component-base/src/i18n-mixin.js"
|