@vaadin/overlay 25.1.0-alpha6 → 25.1.0-alpha8
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 +1116 -0
- package/package.json +12 -10
- package/src/vaadin-overlay-mixin.js +9 -2
- package/src/vaadin-overlay.js +1 -1
|
@@ -0,0 +1,1116 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": "1.0.0",
|
|
3
|
+
"readme": "",
|
|
4
|
+
"modules": [
|
|
5
|
+
{
|
|
6
|
+
"kind": "javascript-module",
|
|
7
|
+
"path": "vaadin-overlay.js",
|
|
8
|
+
"declarations": [],
|
|
9
|
+
"exports": [
|
|
10
|
+
{
|
|
11
|
+
"kind": "js",
|
|
12
|
+
"name": "*",
|
|
13
|
+
"declaration": {
|
|
14
|
+
"name": "*",
|
|
15
|
+
"module": "src/vaadin-overlay.js"
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
]
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"kind": "javascript-module",
|
|
22
|
+
"path": "src/vaadin-overlay-focus-mixin.js",
|
|
23
|
+
"declarations": [
|
|
24
|
+
{
|
|
25
|
+
"kind": "mixin",
|
|
26
|
+
"description": "",
|
|
27
|
+
"name": "OverlayFocusMixin",
|
|
28
|
+
"members": [
|
|
29
|
+
{
|
|
30
|
+
"kind": "field",
|
|
31
|
+
"name": "focusTrap",
|
|
32
|
+
"privacy": "public",
|
|
33
|
+
"type": {
|
|
34
|
+
"text": "boolean"
|
|
35
|
+
},
|
|
36
|
+
"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.",
|
|
37
|
+
"attribute": "focus-trap"
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"kind": "field",
|
|
41
|
+
"name": "restoreFocusNode",
|
|
42
|
+
"privacy": "public",
|
|
43
|
+
"type": {
|
|
44
|
+
"text": "HTMLElement"
|
|
45
|
+
},
|
|
46
|
+
"description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.",
|
|
47
|
+
"attribute": "restore-focus-node"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"kind": "field",
|
|
51
|
+
"name": "restoreFocusOnClose",
|
|
52
|
+
"privacy": "public",
|
|
53
|
+
"type": {
|
|
54
|
+
"text": "boolean"
|
|
55
|
+
},
|
|
56
|
+
"description": "Set to true to enable restoring of focus when overlay is closed.",
|
|
57
|
+
"attribute": "restore-focus-on-close"
|
|
58
|
+
}
|
|
59
|
+
],
|
|
60
|
+
"attributes": [
|
|
61
|
+
{
|
|
62
|
+
"name": "focus-trap",
|
|
63
|
+
"type": {
|
|
64
|
+
"text": "boolean"
|
|
65
|
+
},
|
|
66
|
+
"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.",
|
|
67
|
+
"fieldName": "focusTrap"
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"name": "restore-focus-node",
|
|
71
|
+
"type": {
|
|
72
|
+
"text": "HTMLElement"
|
|
73
|
+
},
|
|
74
|
+
"description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.",
|
|
75
|
+
"fieldName": "restoreFocusNode"
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"name": "restore-focus-on-close",
|
|
79
|
+
"type": {
|
|
80
|
+
"text": "boolean"
|
|
81
|
+
},
|
|
82
|
+
"description": "Set to true to enable restoring of focus when overlay is closed.",
|
|
83
|
+
"fieldName": "restoreFocusOnClose"
|
|
84
|
+
}
|
|
85
|
+
],
|
|
86
|
+
"parameters": [
|
|
87
|
+
{
|
|
88
|
+
"name": "superClass"
|
|
89
|
+
}
|
|
90
|
+
]
|
|
91
|
+
}
|
|
92
|
+
],
|
|
93
|
+
"exports": [
|
|
94
|
+
{
|
|
95
|
+
"kind": "js",
|
|
96
|
+
"name": "OverlayFocusMixin",
|
|
97
|
+
"declaration": {
|
|
98
|
+
"name": "OverlayFocusMixin",
|
|
99
|
+
"module": "src/vaadin-overlay-focus-mixin.js"
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
]
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"kind": "javascript-module",
|
|
106
|
+
"path": "src/vaadin-overlay-mixin.js",
|
|
107
|
+
"declarations": [
|
|
108
|
+
{
|
|
109
|
+
"kind": "mixin",
|
|
110
|
+
"description": "",
|
|
111
|
+
"name": "OverlayMixin",
|
|
112
|
+
"members": [
|
|
113
|
+
{
|
|
114
|
+
"kind": "method",
|
|
115
|
+
"name": "bringToFront",
|
|
116
|
+
"description": "Brings the overlay as visually the frontmost one.",
|
|
117
|
+
"inheritedFrom": {
|
|
118
|
+
"name": "OverlayStackMixin",
|
|
119
|
+
"module": "src/vaadin-overlay-stack-mixin.js"
|
|
120
|
+
}
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"kind": "method",
|
|
124
|
+
"name": "close",
|
|
125
|
+
"parameters": [
|
|
126
|
+
{
|
|
127
|
+
"name": "sourceEvent",
|
|
128
|
+
"type": {
|
|
129
|
+
"text": "Event="
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
]
|
|
133
|
+
},
|
|
134
|
+
{
|
|
135
|
+
"kind": "field",
|
|
136
|
+
"name": "focusTrap",
|
|
137
|
+
"privacy": "public",
|
|
138
|
+
"type": {
|
|
139
|
+
"text": "boolean"
|
|
140
|
+
},
|
|
141
|
+
"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.",
|
|
142
|
+
"attribute": "focus-trap",
|
|
143
|
+
"inheritedFrom": {
|
|
144
|
+
"name": "OverlayFocusMixin",
|
|
145
|
+
"module": "src/vaadin-overlay-focus-mixin.js"
|
|
146
|
+
}
|
|
147
|
+
},
|
|
148
|
+
{
|
|
149
|
+
"kind": "field",
|
|
150
|
+
"name": "hidden",
|
|
151
|
+
"privacy": "public",
|
|
152
|
+
"type": {
|
|
153
|
+
"text": "boolean"
|
|
154
|
+
},
|
|
155
|
+
"description": "When set to true, the overlay is hidden. This also closes the overlay\nimmediately in case there is a closing animation in progress.",
|
|
156
|
+
"attribute": "hidden"
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"kind": "field",
|
|
160
|
+
"name": "model",
|
|
161
|
+
"privacy": "public",
|
|
162
|
+
"type": {
|
|
163
|
+
"text": "object"
|
|
164
|
+
},
|
|
165
|
+
"description": "Object with properties that is passed to `renderer` function",
|
|
166
|
+
"attribute": "model"
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
"kind": "field",
|
|
170
|
+
"name": "modeless",
|
|
171
|
+
"privacy": "public",
|
|
172
|
+
"type": {
|
|
173
|
+
"text": "boolean"
|
|
174
|
+
},
|
|
175
|
+
"description": "When true the overlay won't disable the main content, showing\nit doesn't change the functionality of the user interface.",
|
|
176
|
+
"attribute": "modeless"
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
"kind": "field",
|
|
180
|
+
"name": "opened",
|
|
181
|
+
"privacy": "public",
|
|
182
|
+
"type": {
|
|
183
|
+
"text": "boolean"
|
|
184
|
+
},
|
|
185
|
+
"description": "When true, the overlay is visible and attached to body.",
|
|
186
|
+
"attribute": "opened"
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"kind": "field",
|
|
190
|
+
"name": "owner",
|
|
191
|
+
"privacy": "public",
|
|
192
|
+
"type": {
|
|
193
|
+
"text": "HTMLElement"
|
|
194
|
+
},
|
|
195
|
+
"description": "Owner element passed with renderer function",
|
|
196
|
+
"attribute": "owner"
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"kind": "field",
|
|
200
|
+
"name": "renderer",
|
|
201
|
+
"privacy": "public",
|
|
202
|
+
"type": {
|
|
203
|
+
"text": "OverlayRenderer | null | undefined"
|
|
204
|
+
},
|
|
205
|
+
"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.",
|
|
206
|
+
"attribute": "renderer"
|
|
207
|
+
},
|
|
208
|
+
{
|
|
209
|
+
"kind": "method",
|
|
210
|
+
"name": "requestContentUpdate",
|
|
211
|
+
"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."
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
"kind": "field",
|
|
215
|
+
"name": "restoreFocusNode",
|
|
216
|
+
"privacy": "public",
|
|
217
|
+
"type": {
|
|
218
|
+
"text": "HTMLElement"
|
|
219
|
+
},
|
|
220
|
+
"description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.",
|
|
221
|
+
"attribute": "restore-focus-node",
|
|
222
|
+
"inheritedFrom": {
|
|
223
|
+
"name": "OverlayFocusMixin",
|
|
224
|
+
"module": "src/vaadin-overlay-focus-mixin.js"
|
|
225
|
+
}
|
|
226
|
+
},
|
|
227
|
+
{
|
|
228
|
+
"kind": "field",
|
|
229
|
+
"name": "restoreFocusOnClose",
|
|
230
|
+
"privacy": "public",
|
|
231
|
+
"type": {
|
|
232
|
+
"text": "boolean"
|
|
233
|
+
},
|
|
234
|
+
"description": "Set to true to enable restoring of focus when overlay is closed.",
|
|
235
|
+
"attribute": "restore-focus-on-close",
|
|
236
|
+
"inheritedFrom": {
|
|
237
|
+
"name": "OverlayFocusMixin",
|
|
238
|
+
"module": "src/vaadin-overlay-focus-mixin.js"
|
|
239
|
+
}
|
|
240
|
+
},
|
|
241
|
+
{
|
|
242
|
+
"kind": "method",
|
|
243
|
+
"name": "setBounds",
|
|
244
|
+
"parameters": [
|
|
245
|
+
{
|
|
246
|
+
"name": "bounds",
|
|
247
|
+
"type": {
|
|
248
|
+
"text": "!OverlayBoundsParam"
|
|
249
|
+
}
|
|
250
|
+
},
|
|
251
|
+
{
|
|
252
|
+
"name": "absolute",
|
|
253
|
+
"default": "true",
|
|
254
|
+
"type": {
|
|
255
|
+
"text": "boolean"
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
],
|
|
259
|
+
"description": "Updates the coordinates of the overlay."
|
|
260
|
+
},
|
|
261
|
+
{
|
|
262
|
+
"kind": "field",
|
|
263
|
+
"name": "withBackdrop",
|
|
264
|
+
"privacy": "public",
|
|
265
|
+
"type": {
|
|
266
|
+
"text": "boolean"
|
|
267
|
+
},
|
|
268
|
+
"description": "When true the overlay has backdrop on top of content when opened.",
|
|
269
|
+
"attribute": "with-backdrop"
|
|
270
|
+
}
|
|
271
|
+
],
|
|
272
|
+
"events": [
|
|
273
|
+
{
|
|
274
|
+
"name": "vaadin-overlay-closed",
|
|
275
|
+
"type": {
|
|
276
|
+
"text": "CustomEvent"
|
|
277
|
+
}
|
|
278
|
+
},
|
|
279
|
+
{
|
|
280
|
+
"name": "vaadin-overlay-closing",
|
|
281
|
+
"type": {
|
|
282
|
+
"text": "CustomEvent"
|
|
283
|
+
}
|
|
284
|
+
}
|
|
285
|
+
],
|
|
286
|
+
"attributes": [
|
|
287
|
+
{
|
|
288
|
+
"name": "focus-trap",
|
|
289
|
+
"type": {
|
|
290
|
+
"text": "boolean"
|
|
291
|
+
},
|
|
292
|
+
"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.",
|
|
293
|
+
"fieldName": "focusTrap",
|
|
294
|
+
"inheritedFrom": {
|
|
295
|
+
"name": "OverlayFocusMixin",
|
|
296
|
+
"module": "src/vaadin-overlay-focus-mixin.js"
|
|
297
|
+
}
|
|
298
|
+
},
|
|
299
|
+
{
|
|
300
|
+
"name": "hidden",
|
|
301
|
+
"type": {
|
|
302
|
+
"text": "boolean"
|
|
303
|
+
},
|
|
304
|
+
"description": "When set to true, the overlay is hidden. This also closes the overlay\nimmediately in case there is a closing animation in progress.",
|
|
305
|
+
"fieldName": "hidden"
|
|
306
|
+
},
|
|
307
|
+
{
|
|
308
|
+
"name": "modeless",
|
|
309
|
+
"type": {
|
|
310
|
+
"text": "boolean"
|
|
311
|
+
},
|
|
312
|
+
"description": "When true the overlay won't disable the main content, showing\nit doesn't change the functionality of the user interface.",
|
|
313
|
+
"fieldName": "modeless"
|
|
314
|
+
},
|
|
315
|
+
{
|
|
316
|
+
"name": "opened",
|
|
317
|
+
"type": {
|
|
318
|
+
"text": "boolean"
|
|
319
|
+
},
|
|
320
|
+
"description": "When true, the overlay is visible and attached to body.",
|
|
321
|
+
"fieldName": "opened"
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
"name": "owner",
|
|
325
|
+
"type": {
|
|
326
|
+
"text": "HTMLElement"
|
|
327
|
+
},
|
|
328
|
+
"description": "Owner element passed with renderer function",
|
|
329
|
+
"fieldName": "owner"
|
|
330
|
+
},
|
|
331
|
+
{
|
|
332
|
+
"name": "renderer",
|
|
333
|
+
"type": {
|
|
334
|
+
"text": "OverlayRenderer | null | undefined"
|
|
335
|
+
},
|
|
336
|
+
"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.",
|
|
337
|
+
"fieldName": "renderer"
|
|
338
|
+
},
|
|
339
|
+
{
|
|
340
|
+
"name": "restore-focus-node",
|
|
341
|
+
"type": {
|
|
342
|
+
"text": "HTMLElement"
|
|
343
|
+
},
|
|
344
|
+
"description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.",
|
|
345
|
+
"fieldName": "restoreFocusNode",
|
|
346
|
+
"inheritedFrom": {
|
|
347
|
+
"name": "OverlayFocusMixin",
|
|
348
|
+
"module": "src/vaadin-overlay-focus-mixin.js"
|
|
349
|
+
}
|
|
350
|
+
},
|
|
351
|
+
{
|
|
352
|
+
"name": "restore-focus-on-close",
|
|
353
|
+
"type": {
|
|
354
|
+
"text": "boolean"
|
|
355
|
+
},
|
|
356
|
+
"description": "Set to true to enable restoring of focus when overlay is closed.",
|
|
357
|
+
"fieldName": "restoreFocusOnClose",
|
|
358
|
+
"inheritedFrom": {
|
|
359
|
+
"name": "OverlayFocusMixin",
|
|
360
|
+
"module": "src/vaadin-overlay-focus-mixin.js"
|
|
361
|
+
}
|
|
362
|
+
},
|
|
363
|
+
{
|
|
364
|
+
"name": "with-backdrop",
|
|
365
|
+
"type": {
|
|
366
|
+
"text": "boolean"
|
|
367
|
+
},
|
|
368
|
+
"description": "When true the overlay has backdrop on top of content when opened.",
|
|
369
|
+
"fieldName": "withBackdrop"
|
|
370
|
+
}
|
|
371
|
+
],
|
|
372
|
+
"mixins": [
|
|
373
|
+
{
|
|
374
|
+
"name": "OverlayFocusMixin",
|
|
375
|
+
"module": "src/vaadin-overlay-focus-mixin.js"
|
|
376
|
+
},
|
|
377
|
+
{
|
|
378
|
+
"name": "OverlayStackMixin",
|
|
379
|
+
"module": "src/vaadin-overlay-stack-mixin.js"
|
|
380
|
+
}
|
|
381
|
+
],
|
|
382
|
+
"parameters": [
|
|
383
|
+
{
|
|
384
|
+
"name": "superClass"
|
|
385
|
+
}
|
|
386
|
+
]
|
|
387
|
+
}
|
|
388
|
+
],
|
|
389
|
+
"exports": [
|
|
390
|
+
{
|
|
391
|
+
"kind": "js",
|
|
392
|
+
"name": "OverlayMixin",
|
|
393
|
+
"declaration": {
|
|
394
|
+
"name": "OverlayMixin",
|
|
395
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
396
|
+
}
|
|
397
|
+
}
|
|
398
|
+
]
|
|
399
|
+
},
|
|
400
|
+
{
|
|
401
|
+
"kind": "javascript-module",
|
|
402
|
+
"path": "src/vaadin-overlay-position-mixin.js",
|
|
403
|
+
"declarations": [
|
|
404
|
+
{
|
|
405
|
+
"kind": "mixin",
|
|
406
|
+
"description": "",
|
|
407
|
+
"name": "PositionMixin",
|
|
408
|
+
"members": [
|
|
409
|
+
{
|
|
410
|
+
"kind": "field",
|
|
411
|
+
"name": "horizontalAlign",
|
|
412
|
+
"privacy": "public",
|
|
413
|
+
"type": {
|
|
414
|
+
"text": "string"
|
|
415
|
+
},
|
|
416
|
+
"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.",
|
|
417
|
+
"attribute": "horizontal-align"
|
|
418
|
+
},
|
|
419
|
+
{
|
|
420
|
+
"kind": "field",
|
|
421
|
+
"name": "noHorizontalOverlap",
|
|
422
|
+
"privacy": "public",
|
|
423
|
+
"type": {
|
|
424
|
+
"text": "boolean"
|
|
425
|
+
},
|
|
426
|
+
"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.",
|
|
427
|
+
"attribute": "no-horizontal-overlap"
|
|
428
|
+
},
|
|
429
|
+
{
|
|
430
|
+
"kind": "field",
|
|
431
|
+
"name": "noVerticalOverlap",
|
|
432
|
+
"privacy": "public",
|
|
433
|
+
"type": {
|
|
434
|
+
"text": "boolean"
|
|
435
|
+
},
|
|
436
|
+
"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.",
|
|
437
|
+
"attribute": "no-vertical-overlap"
|
|
438
|
+
},
|
|
439
|
+
{
|
|
440
|
+
"kind": "field",
|
|
441
|
+
"name": "positionTarget",
|
|
442
|
+
"privacy": "public",
|
|
443
|
+
"type": {
|
|
444
|
+
"text": "object"
|
|
445
|
+
},
|
|
446
|
+
"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`.",
|
|
447
|
+
"attribute": "position-target"
|
|
448
|
+
},
|
|
449
|
+
{
|
|
450
|
+
"kind": "field",
|
|
451
|
+
"name": "requiredVerticalSpace",
|
|
452
|
+
"privacy": "public",
|
|
453
|
+
"type": {
|
|
454
|
+
"text": "number"
|
|
455
|
+
},
|
|
456
|
+
"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.",
|
|
457
|
+
"attribute": "required-vertical-space"
|
|
458
|
+
},
|
|
459
|
+
{
|
|
460
|
+
"kind": "field",
|
|
461
|
+
"name": "verticalAlign",
|
|
462
|
+
"privacy": "public",
|
|
463
|
+
"type": {
|
|
464
|
+
"text": "string"
|
|
465
|
+
},
|
|
466
|
+
"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.",
|
|
467
|
+
"attribute": "vertical-align"
|
|
468
|
+
}
|
|
469
|
+
],
|
|
470
|
+
"attributes": [
|
|
471
|
+
{
|
|
472
|
+
"name": "horizontal-align",
|
|
473
|
+
"type": {
|
|
474
|
+
"text": "string"
|
|
475
|
+
},
|
|
476
|
+
"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.",
|
|
477
|
+
"fieldName": "horizontalAlign"
|
|
478
|
+
},
|
|
479
|
+
{
|
|
480
|
+
"name": "no-horizontal-overlap",
|
|
481
|
+
"type": {
|
|
482
|
+
"text": "boolean"
|
|
483
|
+
},
|
|
484
|
+
"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.",
|
|
485
|
+
"fieldName": "noHorizontalOverlap"
|
|
486
|
+
},
|
|
487
|
+
{
|
|
488
|
+
"name": "no-vertical-overlap",
|
|
489
|
+
"type": {
|
|
490
|
+
"text": "boolean"
|
|
491
|
+
},
|
|
492
|
+
"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.",
|
|
493
|
+
"fieldName": "noVerticalOverlap"
|
|
494
|
+
},
|
|
495
|
+
{
|
|
496
|
+
"name": "required-vertical-space",
|
|
497
|
+
"type": {
|
|
498
|
+
"text": "number"
|
|
499
|
+
},
|
|
500
|
+
"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.",
|
|
501
|
+
"fieldName": "requiredVerticalSpace"
|
|
502
|
+
},
|
|
503
|
+
{
|
|
504
|
+
"name": "vertical-align",
|
|
505
|
+
"type": {
|
|
506
|
+
"text": "string"
|
|
507
|
+
},
|
|
508
|
+
"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.",
|
|
509
|
+
"fieldName": "verticalAlign"
|
|
510
|
+
}
|
|
511
|
+
],
|
|
512
|
+
"parameters": [
|
|
513
|
+
{
|
|
514
|
+
"name": "superClass"
|
|
515
|
+
}
|
|
516
|
+
]
|
|
517
|
+
}
|
|
518
|
+
],
|
|
519
|
+
"exports": [
|
|
520
|
+
{
|
|
521
|
+
"kind": "js",
|
|
522
|
+
"name": "PositionMixin",
|
|
523
|
+
"declaration": {
|
|
524
|
+
"name": "PositionMixin",
|
|
525
|
+
"module": "src/vaadin-overlay-position-mixin.js"
|
|
526
|
+
}
|
|
527
|
+
}
|
|
528
|
+
]
|
|
529
|
+
},
|
|
530
|
+
{
|
|
531
|
+
"kind": "javascript-module",
|
|
532
|
+
"path": "src/vaadin-overlay-stack-mixin.js",
|
|
533
|
+
"declarations": [
|
|
534
|
+
{
|
|
535
|
+
"kind": "function",
|
|
536
|
+
"name": "hasOnlyNestedOverlays",
|
|
537
|
+
"parameters": [
|
|
538
|
+
{
|
|
539
|
+
"name": "overlay"
|
|
540
|
+
}
|
|
541
|
+
],
|
|
542
|
+
"description": "Returns true if all the instances on top of the overlay are nested overlays.",
|
|
543
|
+
"privacy": "private"
|
|
544
|
+
},
|
|
545
|
+
{
|
|
546
|
+
"kind": "function",
|
|
547
|
+
"name": "isLastOverlay",
|
|
548
|
+
"parameters": [
|
|
549
|
+
{
|
|
550
|
+
"name": "overlay",
|
|
551
|
+
"type": {
|
|
552
|
+
"text": "HTMLElement"
|
|
553
|
+
}
|
|
554
|
+
},
|
|
555
|
+
{
|
|
556
|
+
"name": "filter",
|
|
557
|
+
"default": "(_overlay) => true",
|
|
558
|
+
"type": {
|
|
559
|
+
"text": "function(HTMLElement): boolean"
|
|
560
|
+
}
|
|
561
|
+
}
|
|
562
|
+
],
|
|
563
|
+
"description": "Returns true if the overlay is the last one in the opened overlays stack.",
|
|
564
|
+
"return": {
|
|
565
|
+
"type": {
|
|
566
|
+
"text": "boolean"
|
|
567
|
+
}
|
|
568
|
+
},
|
|
569
|
+
"privacy": "protected"
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
"kind": "mixin",
|
|
573
|
+
"description": "",
|
|
574
|
+
"name": "OverlayStackMixin",
|
|
575
|
+
"members": [
|
|
576
|
+
{
|
|
577
|
+
"kind": "method",
|
|
578
|
+
"name": "bringToFront",
|
|
579
|
+
"description": "Brings the overlay as visually the frontmost one."
|
|
580
|
+
}
|
|
581
|
+
],
|
|
582
|
+
"parameters": [
|
|
583
|
+
{
|
|
584
|
+
"name": "superClass"
|
|
585
|
+
}
|
|
586
|
+
]
|
|
587
|
+
}
|
|
588
|
+
],
|
|
589
|
+
"exports": [
|
|
590
|
+
{
|
|
591
|
+
"kind": "js",
|
|
592
|
+
"name": "hasOnlyNestedOverlays",
|
|
593
|
+
"declaration": {
|
|
594
|
+
"name": "hasOnlyNestedOverlays",
|
|
595
|
+
"module": "src/vaadin-overlay-stack-mixin.js"
|
|
596
|
+
}
|
|
597
|
+
},
|
|
598
|
+
{
|
|
599
|
+
"kind": "js",
|
|
600
|
+
"name": "isLastOverlay",
|
|
601
|
+
"declaration": {
|
|
602
|
+
"name": "isLastOverlay",
|
|
603
|
+
"module": "src/vaadin-overlay-stack-mixin.js"
|
|
604
|
+
}
|
|
605
|
+
},
|
|
606
|
+
{
|
|
607
|
+
"kind": "js",
|
|
608
|
+
"name": "OverlayStackMixin",
|
|
609
|
+
"declaration": {
|
|
610
|
+
"name": "OverlayStackMixin",
|
|
611
|
+
"module": "src/vaadin-overlay-stack-mixin.js"
|
|
612
|
+
}
|
|
613
|
+
}
|
|
614
|
+
]
|
|
615
|
+
},
|
|
616
|
+
{
|
|
617
|
+
"kind": "javascript-module",
|
|
618
|
+
"path": "src/vaadin-overlay-utils.js",
|
|
619
|
+
"declarations": [
|
|
620
|
+
{
|
|
621
|
+
"kind": "function",
|
|
622
|
+
"name": "observeMove",
|
|
623
|
+
"parameters": [
|
|
624
|
+
{
|
|
625
|
+
"name": "element",
|
|
626
|
+
"type": {
|
|
627
|
+
"text": "HTMLElement"
|
|
628
|
+
}
|
|
629
|
+
},
|
|
630
|
+
{
|
|
631
|
+
"name": "callback",
|
|
632
|
+
"type": {
|
|
633
|
+
"text": "Function"
|
|
634
|
+
}
|
|
635
|
+
}
|
|
636
|
+
],
|
|
637
|
+
"description": "Observe moving an element around on a page.\n\nBased on the idea from https://samthor.au/2021/observing-dom/ as implemented in Floating UI\nhttps://github.com/floating-ui/floating-ui/blob/58ed169/packages/dom/src/autoUpdate.ts#L45",
|
|
638
|
+
"return": {
|
|
639
|
+
"type": {
|
|
640
|
+
"text": "Function"
|
|
641
|
+
}
|
|
642
|
+
}
|
|
643
|
+
},
|
|
644
|
+
{
|
|
645
|
+
"kind": "variable",
|
|
646
|
+
"name": "rootMargin",
|
|
647
|
+
"default": "`${-insetTop}px ${-insetRight}px ${-insetBottom}px ${-insetLeft}px`"
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
"kind": "function",
|
|
651
|
+
"name": "setOverlayStateAttribute",
|
|
652
|
+
"parameters": [
|
|
653
|
+
{
|
|
654
|
+
"name": "overlay",
|
|
655
|
+
"description": "The overlay element on which to toggle the attribute.",
|
|
656
|
+
"type": {
|
|
657
|
+
"text": "HTMLElement"
|
|
658
|
+
}
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
"name": "name",
|
|
662
|
+
"description": "The name of the attribute to toggle.",
|
|
663
|
+
"type": {
|
|
664
|
+
"text": "string"
|
|
665
|
+
}
|
|
666
|
+
},
|
|
667
|
+
{
|
|
668
|
+
"name": "value",
|
|
669
|
+
"description": "The value of the attribute. If a string is provided, it will be set as the attribute\nvalue. Otherwise, the attribute will be added or removed depending on whether `value` is truthy or falsy.",
|
|
670
|
+
"type": {
|
|
671
|
+
"text": "string|boolean"
|
|
672
|
+
}
|
|
673
|
+
}
|
|
674
|
+
],
|
|
675
|
+
"description": "Toggle the state attribute on the overlay element and also its owner element. This allows targeting state attributes\nin the light DOM in case the overlay is in the shadow DOM of its owner."
|
|
676
|
+
}
|
|
677
|
+
],
|
|
678
|
+
"exports": [
|
|
679
|
+
{
|
|
680
|
+
"kind": "js",
|
|
681
|
+
"name": "observeMove",
|
|
682
|
+
"declaration": {
|
|
683
|
+
"name": "observeMove",
|
|
684
|
+
"module": "src/vaadin-overlay-utils.js"
|
|
685
|
+
}
|
|
686
|
+
},
|
|
687
|
+
{
|
|
688
|
+
"kind": "js",
|
|
689
|
+
"name": "setOverlayStateAttribute",
|
|
690
|
+
"declaration": {
|
|
691
|
+
"name": "setOverlayStateAttribute",
|
|
692
|
+
"module": "src/vaadin-overlay-utils.js"
|
|
693
|
+
}
|
|
694
|
+
}
|
|
695
|
+
]
|
|
696
|
+
},
|
|
697
|
+
{
|
|
698
|
+
"kind": "javascript-module",
|
|
699
|
+
"path": "src/vaadin-overlay.js",
|
|
700
|
+
"declarations": [
|
|
701
|
+
{
|
|
702
|
+
"kind": "class",
|
|
703
|
+
"description": "`<vaadin-overlay>` is a Web Component for creating overlays. The content of the overlay\ncan be populated imperatively by using `renderer` callback function.\n\n### Rendering\n\nThe renderer function provides `root`, `owner`, `model` arguments when applicable.\nGenerate DOM content by using `model` object properties if needed, append it to the `root`\nelement and control the state of the host element by accessing `owner`. Before generating new\ncontent, users are able to check if there is already content in `root` for reusing it.\n\n```html\n<vaadin-overlay id=\"overlay\"></vaadin-overlay>\n```\n```js\nconst overlay = document.querySelector('#overlay');\noverlay.renderer = function(root) {\n root.textContent = \"Overlay content\";\n};\n```\n\nRenderer is called on the opening of the overlay and each time the related model is updated.\nDOM generated during the renderer call can be reused\nin the next renderer call and will be provided with the `root` argument.\nOn first call it will be empty.\n\n### Styling\n\nThe following Shadow DOM parts are available for styling:\n\nPart name | Description\n-----------|---------------------------------------------------------|\n`backdrop` | Backdrop of the overlay\n`overlay` | Container for position/sizing/alignment of the content\n`content` | Content of the overlay\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n----------|------------\n`opening` | Applied just after the overlay is opened. You can apply a CSS animation for this state.\n`closing` | Applied just before the overlay is closed. You can apply a CSS animation for this state.\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property | Description | Default value\n---|---|---\n`--vaadin-overlay-viewport-bottom` | Bottom offset of the visible viewport area | `0` or detected offset\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
704
|
+
"name": "Overlay",
|
|
705
|
+
"members": [
|
|
706
|
+
{
|
|
707
|
+
"kind": "method",
|
|
708
|
+
"name": "bringToFront",
|
|
709
|
+
"description": "Brings the overlay as visually the frontmost one.",
|
|
710
|
+
"inheritedFrom": {
|
|
711
|
+
"name": "OverlayStackMixin",
|
|
712
|
+
"module": "src/vaadin-overlay-stack-mixin.js"
|
|
713
|
+
}
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
"kind": "method",
|
|
717
|
+
"name": "close",
|
|
718
|
+
"parameters": [
|
|
719
|
+
{
|
|
720
|
+
"name": "sourceEvent",
|
|
721
|
+
"type": {
|
|
722
|
+
"text": "Event="
|
|
723
|
+
}
|
|
724
|
+
}
|
|
725
|
+
],
|
|
726
|
+
"inheritedFrom": {
|
|
727
|
+
"name": "OverlayMixin",
|
|
728
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
729
|
+
}
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
"kind": "field",
|
|
733
|
+
"name": "focusTrap",
|
|
734
|
+
"privacy": "public",
|
|
735
|
+
"type": {
|
|
736
|
+
"text": "boolean"
|
|
737
|
+
},
|
|
738
|
+
"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.",
|
|
739
|
+
"attribute": "focus-trap",
|
|
740
|
+
"inheritedFrom": {
|
|
741
|
+
"name": "OverlayFocusMixin",
|
|
742
|
+
"module": "src/vaadin-overlay-focus-mixin.js"
|
|
743
|
+
}
|
|
744
|
+
},
|
|
745
|
+
{
|
|
746
|
+
"kind": "field",
|
|
747
|
+
"name": "hidden",
|
|
748
|
+
"privacy": "public",
|
|
749
|
+
"type": {
|
|
750
|
+
"text": "boolean"
|
|
751
|
+
},
|
|
752
|
+
"description": "When set to true, the overlay is hidden. This also closes the overlay\nimmediately in case there is a closing animation in progress.",
|
|
753
|
+
"attribute": "hidden",
|
|
754
|
+
"inheritedFrom": {
|
|
755
|
+
"name": "OverlayMixin",
|
|
756
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
757
|
+
}
|
|
758
|
+
},
|
|
759
|
+
{
|
|
760
|
+
"kind": "field",
|
|
761
|
+
"name": "model",
|
|
762
|
+
"privacy": "public",
|
|
763
|
+
"type": {
|
|
764
|
+
"text": "object"
|
|
765
|
+
},
|
|
766
|
+
"description": "Object with properties that is passed to `renderer` function",
|
|
767
|
+
"attribute": "model",
|
|
768
|
+
"inheritedFrom": {
|
|
769
|
+
"name": "OverlayMixin",
|
|
770
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
771
|
+
}
|
|
772
|
+
},
|
|
773
|
+
{
|
|
774
|
+
"kind": "field",
|
|
775
|
+
"name": "modeless",
|
|
776
|
+
"privacy": "public",
|
|
777
|
+
"type": {
|
|
778
|
+
"text": "boolean"
|
|
779
|
+
},
|
|
780
|
+
"description": "When true the overlay won't disable the main content, showing\nit doesn't change the functionality of the user interface.",
|
|
781
|
+
"attribute": "modeless",
|
|
782
|
+
"inheritedFrom": {
|
|
783
|
+
"name": "OverlayMixin",
|
|
784
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
785
|
+
}
|
|
786
|
+
},
|
|
787
|
+
{
|
|
788
|
+
"kind": "field",
|
|
789
|
+
"name": "opened",
|
|
790
|
+
"privacy": "public",
|
|
791
|
+
"type": {
|
|
792
|
+
"text": "boolean"
|
|
793
|
+
},
|
|
794
|
+
"description": "When true, the overlay is visible and attached to body.",
|
|
795
|
+
"attribute": "opened",
|
|
796
|
+
"inheritedFrom": {
|
|
797
|
+
"name": "OverlayMixin",
|
|
798
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
799
|
+
}
|
|
800
|
+
},
|
|
801
|
+
{
|
|
802
|
+
"kind": "field",
|
|
803
|
+
"name": "owner",
|
|
804
|
+
"privacy": "public",
|
|
805
|
+
"type": {
|
|
806
|
+
"text": "HTMLElement"
|
|
807
|
+
},
|
|
808
|
+
"description": "Owner element passed with renderer function",
|
|
809
|
+
"attribute": "owner",
|
|
810
|
+
"inheritedFrom": {
|
|
811
|
+
"name": "OverlayMixin",
|
|
812
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
813
|
+
}
|
|
814
|
+
},
|
|
815
|
+
{
|
|
816
|
+
"kind": "field",
|
|
817
|
+
"name": "renderer",
|
|
818
|
+
"privacy": "public",
|
|
819
|
+
"type": {
|
|
820
|
+
"text": "OverlayRenderer | null | undefined"
|
|
821
|
+
},
|
|
822
|
+
"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.",
|
|
823
|
+
"attribute": "renderer",
|
|
824
|
+
"inheritedFrom": {
|
|
825
|
+
"name": "OverlayMixin",
|
|
826
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
827
|
+
}
|
|
828
|
+
},
|
|
829
|
+
{
|
|
830
|
+
"kind": "method",
|
|
831
|
+
"name": "requestContentUpdate",
|
|
832
|
+
"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.",
|
|
833
|
+
"inheritedFrom": {
|
|
834
|
+
"name": "OverlayMixin",
|
|
835
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
836
|
+
}
|
|
837
|
+
},
|
|
838
|
+
{
|
|
839
|
+
"kind": "field",
|
|
840
|
+
"name": "restoreFocusNode",
|
|
841
|
+
"privacy": "public",
|
|
842
|
+
"type": {
|
|
843
|
+
"text": "HTMLElement"
|
|
844
|
+
},
|
|
845
|
+
"description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.",
|
|
846
|
+
"attribute": "restore-focus-node",
|
|
847
|
+
"inheritedFrom": {
|
|
848
|
+
"name": "OverlayFocusMixin",
|
|
849
|
+
"module": "src/vaadin-overlay-focus-mixin.js"
|
|
850
|
+
}
|
|
851
|
+
},
|
|
852
|
+
{
|
|
853
|
+
"kind": "field",
|
|
854
|
+
"name": "restoreFocusOnClose",
|
|
855
|
+
"privacy": "public",
|
|
856
|
+
"type": {
|
|
857
|
+
"text": "boolean"
|
|
858
|
+
},
|
|
859
|
+
"description": "Set to true to enable restoring of focus when overlay is closed.",
|
|
860
|
+
"attribute": "restore-focus-on-close",
|
|
861
|
+
"inheritedFrom": {
|
|
862
|
+
"name": "OverlayFocusMixin",
|
|
863
|
+
"module": "src/vaadin-overlay-focus-mixin.js"
|
|
864
|
+
}
|
|
865
|
+
},
|
|
866
|
+
{
|
|
867
|
+
"kind": "method",
|
|
868
|
+
"name": "setBounds",
|
|
869
|
+
"parameters": [
|
|
870
|
+
{
|
|
871
|
+
"name": "bounds",
|
|
872
|
+
"type": {
|
|
873
|
+
"text": "!OverlayBoundsParam"
|
|
874
|
+
}
|
|
875
|
+
},
|
|
876
|
+
{
|
|
877
|
+
"name": "absolute",
|
|
878
|
+
"default": "true",
|
|
879
|
+
"type": {
|
|
880
|
+
"text": "boolean"
|
|
881
|
+
}
|
|
882
|
+
}
|
|
883
|
+
],
|
|
884
|
+
"description": "Updates the coordinates of the overlay.",
|
|
885
|
+
"inheritedFrom": {
|
|
886
|
+
"name": "OverlayMixin",
|
|
887
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
888
|
+
}
|
|
889
|
+
},
|
|
890
|
+
{
|
|
891
|
+
"kind": "field",
|
|
892
|
+
"name": "withBackdrop",
|
|
893
|
+
"privacy": "public",
|
|
894
|
+
"type": {
|
|
895
|
+
"text": "boolean"
|
|
896
|
+
},
|
|
897
|
+
"description": "When true the overlay has backdrop on top of content when opened.",
|
|
898
|
+
"attribute": "with-backdrop",
|
|
899
|
+
"inheritedFrom": {
|
|
900
|
+
"name": "OverlayMixin",
|
|
901
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
902
|
+
}
|
|
903
|
+
}
|
|
904
|
+
],
|
|
905
|
+
"events": [
|
|
906
|
+
{
|
|
907
|
+
"type": {
|
|
908
|
+
"text": "CustomEvent"
|
|
909
|
+
},
|
|
910
|
+
"description": "Fired when the `opened` property changes.",
|
|
911
|
+
"name": "opened-changed"
|
|
912
|
+
},
|
|
913
|
+
{
|
|
914
|
+
"type": {
|
|
915
|
+
"text": "CustomEvent"
|
|
916
|
+
},
|
|
917
|
+
"description": "Fired when the opened overlay is about to be closed. Calling `preventDefault()` on the event cancels the closing.",
|
|
918
|
+
"name": "vaadin-overlay-close"
|
|
919
|
+
},
|
|
920
|
+
{
|
|
921
|
+
"name": "vaadin-overlay-closed",
|
|
922
|
+
"type": {
|
|
923
|
+
"text": "CustomEvent"
|
|
924
|
+
},
|
|
925
|
+
"description": "Fired after the overlay is closed.",
|
|
926
|
+
"inheritedFrom": {
|
|
927
|
+
"name": "OverlayMixin",
|
|
928
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
929
|
+
}
|
|
930
|
+
},
|
|
931
|
+
{
|
|
932
|
+
"name": "vaadin-overlay-closing",
|
|
933
|
+
"type": {
|
|
934
|
+
"text": "CustomEvent"
|
|
935
|
+
},
|
|
936
|
+
"description": "Fired when the overlay starts to close. Closing the overlay can be asynchronous depending on the animation.",
|
|
937
|
+
"inheritedFrom": {
|
|
938
|
+
"name": "OverlayMixin",
|
|
939
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
940
|
+
}
|
|
941
|
+
},
|
|
942
|
+
{
|
|
943
|
+
"type": {
|
|
944
|
+
"text": "CustomEvent"
|
|
945
|
+
},
|
|
946
|
+
"description": "Fired before the overlay is closed on Escape key press. Calling `preventDefault()` on the event cancels the closing.",
|
|
947
|
+
"name": "vaadin-overlay-escape-press"
|
|
948
|
+
},
|
|
949
|
+
{
|
|
950
|
+
"type": {
|
|
951
|
+
"text": "CustomEvent"
|
|
952
|
+
},
|
|
953
|
+
"description": "Fired after the overlay is opened.",
|
|
954
|
+
"name": "vaadin-overlay-open"
|
|
955
|
+
},
|
|
956
|
+
{
|
|
957
|
+
"type": {
|
|
958
|
+
"text": "CustomEvent"
|
|
959
|
+
},
|
|
960
|
+
"description": "Fired before the overlay is closed on outside click. Calling `preventDefault()` on the event cancels the closing.",
|
|
961
|
+
"name": "vaadin-overlay-outside-click"
|
|
962
|
+
}
|
|
963
|
+
],
|
|
964
|
+
"mixins": [
|
|
965
|
+
{
|
|
966
|
+
"name": "OverlayMixin",
|
|
967
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
968
|
+
},
|
|
969
|
+
{
|
|
970
|
+
"name": "DirMixin",
|
|
971
|
+
"package": "@vaadin/component-base/src/dir-mixin.js"
|
|
972
|
+
},
|
|
973
|
+
{
|
|
974
|
+
"name": "ThemableMixin",
|
|
975
|
+
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
976
|
+
},
|
|
977
|
+
{
|
|
978
|
+
"name": "PolylitMixin",
|
|
979
|
+
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
980
|
+
},
|
|
981
|
+
{
|
|
982
|
+
"name": "LumoInjectionMixin",
|
|
983
|
+
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
984
|
+
}
|
|
985
|
+
],
|
|
986
|
+
"superclass": {
|
|
987
|
+
"name": "LitElement",
|
|
988
|
+
"package": "lit"
|
|
989
|
+
},
|
|
990
|
+
"tagName": "vaadin-overlay",
|
|
991
|
+
"customElement": true,
|
|
992
|
+
"attributes": [
|
|
993
|
+
{
|
|
994
|
+
"name": "focus-trap",
|
|
995
|
+
"type": {
|
|
996
|
+
"text": "boolean"
|
|
997
|
+
},
|
|
998
|
+
"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.",
|
|
999
|
+
"fieldName": "focusTrap",
|
|
1000
|
+
"inheritedFrom": {
|
|
1001
|
+
"name": "OverlayFocusMixin",
|
|
1002
|
+
"module": "src/vaadin-overlay-focus-mixin.js"
|
|
1003
|
+
}
|
|
1004
|
+
},
|
|
1005
|
+
{
|
|
1006
|
+
"name": "hidden",
|
|
1007
|
+
"type": {
|
|
1008
|
+
"text": "boolean"
|
|
1009
|
+
},
|
|
1010
|
+
"description": "When set to true, the overlay is hidden. This also closes the overlay\nimmediately in case there is a closing animation in progress.",
|
|
1011
|
+
"fieldName": "hidden",
|
|
1012
|
+
"inheritedFrom": {
|
|
1013
|
+
"name": "OverlayMixin",
|
|
1014
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
1015
|
+
}
|
|
1016
|
+
},
|
|
1017
|
+
{
|
|
1018
|
+
"name": "modeless",
|
|
1019
|
+
"type": {
|
|
1020
|
+
"text": "boolean"
|
|
1021
|
+
},
|
|
1022
|
+
"description": "When true the overlay won't disable the main content, showing\nit doesn't change the functionality of the user interface.",
|
|
1023
|
+
"fieldName": "modeless",
|
|
1024
|
+
"inheritedFrom": {
|
|
1025
|
+
"name": "OverlayMixin",
|
|
1026
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
1027
|
+
}
|
|
1028
|
+
},
|
|
1029
|
+
{
|
|
1030
|
+
"name": "opened",
|
|
1031
|
+
"type": {
|
|
1032
|
+
"text": "boolean"
|
|
1033
|
+
},
|
|
1034
|
+
"description": "When true, the overlay is visible and attached to body.",
|
|
1035
|
+
"fieldName": "opened",
|
|
1036
|
+
"inheritedFrom": {
|
|
1037
|
+
"name": "OverlayMixin",
|
|
1038
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
1039
|
+
}
|
|
1040
|
+
},
|
|
1041
|
+
{
|
|
1042
|
+
"name": "owner",
|
|
1043
|
+
"type": {
|
|
1044
|
+
"text": "HTMLElement"
|
|
1045
|
+
},
|
|
1046
|
+
"description": "Owner element passed with renderer function",
|
|
1047
|
+
"fieldName": "owner",
|
|
1048
|
+
"inheritedFrom": {
|
|
1049
|
+
"name": "OverlayMixin",
|
|
1050
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
1051
|
+
}
|
|
1052
|
+
},
|
|
1053
|
+
{
|
|
1054
|
+
"name": "renderer",
|
|
1055
|
+
"type": {
|
|
1056
|
+
"text": "OverlayRenderer | null | undefined"
|
|
1057
|
+
},
|
|
1058
|
+
"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.",
|
|
1059
|
+
"fieldName": "renderer",
|
|
1060
|
+
"inheritedFrom": {
|
|
1061
|
+
"name": "OverlayMixin",
|
|
1062
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
1063
|
+
}
|
|
1064
|
+
},
|
|
1065
|
+
{
|
|
1066
|
+
"name": "restore-focus-node",
|
|
1067
|
+
"type": {
|
|
1068
|
+
"text": "HTMLElement"
|
|
1069
|
+
},
|
|
1070
|
+
"description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.",
|
|
1071
|
+
"fieldName": "restoreFocusNode",
|
|
1072
|
+
"inheritedFrom": {
|
|
1073
|
+
"name": "OverlayFocusMixin",
|
|
1074
|
+
"module": "src/vaadin-overlay-focus-mixin.js"
|
|
1075
|
+
}
|
|
1076
|
+
},
|
|
1077
|
+
{
|
|
1078
|
+
"name": "restore-focus-on-close",
|
|
1079
|
+
"type": {
|
|
1080
|
+
"text": "boolean"
|
|
1081
|
+
},
|
|
1082
|
+
"description": "Set to true to enable restoring of focus when overlay is closed.",
|
|
1083
|
+
"fieldName": "restoreFocusOnClose",
|
|
1084
|
+
"inheritedFrom": {
|
|
1085
|
+
"name": "OverlayFocusMixin",
|
|
1086
|
+
"module": "src/vaadin-overlay-focus-mixin.js"
|
|
1087
|
+
}
|
|
1088
|
+
},
|
|
1089
|
+
{
|
|
1090
|
+
"name": "with-backdrop",
|
|
1091
|
+
"type": {
|
|
1092
|
+
"text": "boolean"
|
|
1093
|
+
},
|
|
1094
|
+
"description": "When true the overlay has backdrop on top of content when opened.",
|
|
1095
|
+
"fieldName": "withBackdrop",
|
|
1096
|
+
"inheritedFrom": {
|
|
1097
|
+
"name": "OverlayMixin",
|
|
1098
|
+
"module": "src/vaadin-overlay-mixin.js"
|
|
1099
|
+
}
|
|
1100
|
+
}
|
|
1101
|
+
]
|
|
1102
|
+
}
|
|
1103
|
+
],
|
|
1104
|
+
"exports": [
|
|
1105
|
+
{
|
|
1106
|
+
"kind": "js",
|
|
1107
|
+
"name": "Overlay",
|
|
1108
|
+
"declaration": {
|
|
1109
|
+
"name": "Overlay",
|
|
1110
|
+
"module": "src/vaadin-overlay.js"
|
|
1111
|
+
}
|
|
1112
|
+
}
|
|
1113
|
+
]
|
|
1114
|
+
}
|
|
1115
|
+
]
|
|
1116
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/overlay",
|
|
3
|
-
"version": "25.1.0-
|
|
3
|
+
"version": "25.1.0-alpha8",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -22,7 +22,8 @@
|
|
|
22
22
|
"files": [
|
|
23
23
|
"src",
|
|
24
24
|
"vaadin-*.d.ts",
|
|
25
|
-
"vaadin-*.js"
|
|
25
|
+
"vaadin-*.js",
|
|
26
|
+
"custom-elements.json"
|
|
26
27
|
],
|
|
27
28
|
"keywords": [
|
|
28
29
|
"Vaadin",
|
|
@@ -33,18 +34,19 @@
|
|
|
33
34
|
],
|
|
34
35
|
"dependencies": {
|
|
35
36
|
"@open-wc/dedupe-mixin": "^1.3.0",
|
|
36
|
-
"@vaadin/a11y-base": "25.1.0-
|
|
37
|
-
"@vaadin/component-base": "25.1.0-
|
|
38
|
-
"@vaadin/vaadin-themable-mixin": "25.1.0-
|
|
37
|
+
"@vaadin/a11y-base": "25.1.0-alpha8",
|
|
38
|
+
"@vaadin/component-base": "25.1.0-alpha8",
|
|
39
|
+
"@vaadin/vaadin-themable-mixin": "25.1.0-alpha8",
|
|
39
40
|
"lit": "^3.0.0"
|
|
40
41
|
},
|
|
41
42
|
"devDependencies": {
|
|
42
|
-
"@vaadin/aura": "25.1.0-
|
|
43
|
-
"@vaadin/chai-plugins": "25.1.0-
|
|
44
|
-
"@vaadin/test-runner-commands": "25.1.0-
|
|
43
|
+
"@vaadin/aura": "25.1.0-alpha8",
|
|
44
|
+
"@vaadin/chai-plugins": "25.1.0-alpha8",
|
|
45
|
+
"@vaadin/test-runner-commands": "25.1.0-alpha8",
|
|
45
46
|
"@vaadin/testing-helpers": "^2.0.0",
|
|
46
|
-
"@vaadin/vaadin-lumo-styles": "25.1.0-
|
|
47
|
+
"@vaadin/vaadin-lumo-styles": "25.1.0-alpha8",
|
|
47
48
|
"sinon": "^21.0.0"
|
|
48
49
|
},
|
|
49
|
-
"
|
|
50
|
+
"customElements": "custom-elements.json",
|
|
51
|
+
"gitHead": "810590c9c7682a9326c9352df795b5ea4891a71f"
|
|
50
52
|
}
|
|
@@ -164,6 +164,11 @@ export const OverlayMixin = (superClass) =>
|
|
|
164
164
|
this._detectIosNavbar();
|
|
165
165
|
window.addEventListener('resize', this._boundIosResizeListener);
|
|
166
166
|
}
|
|
167
|
+
|
|
168
|
+
// Show popover again if overlay was just moved in the DOM
|
|
169
|
+
if (this.opened) {
|
|
170
|
+
this._attachOverlay();
|
|
171
|
+
}
|
|
167
172
|
}
|
|
168
173
|
|
|
169
174
|
/** @protected */
|
|
@@ -252,7 +257,7 @@ export const OverlayMixin = (superClass) =>
|
|
|
252
257
|
if (landscape && clientHeight > innerHeight) {
|
|
253
258
|
this.style.setProperty('--vaadin-overlay-viewport-bottom', `${clientHeight - innerHeight}px`);
|
|
254
259
|
} else {
|
|
255
|
-
this.style.setProperty('--vaadin-overlay-viewport-bottom', '
|
|
260
|
+
this.style.setProperty('--vaadin-overlay-viewport-bottom', '0px');
|
|
256
261
|
}
|
|
257
262
|
}
|
|
258
263
|
|
|
@@ -468,7 +473,9 @@ export const OverlayMixin = (superClass) =>
|
|
|
468
473
|
|
|
469
474
|
/** @private */
|
|
470
475
|
_attachOverlay() {
|
|
471
|
-
this.
|
|
476
|
+
if (!this.matches(':popover-open')) {
|
|
477
|
+
this.showPopover();
|
|
478
|
+
}
|
|
472
479
|
}
|
|
473
480
|
|
|
474
481
|
/** @private */
|
package/src/vaadin-overlay.js
CHANGED
|
@@ -71,7 +71,7 @@ import { OverlayMixin } from './vaadin-overlay-mixin.js';
|
|
|
71
71
|
* @fires {CustomEvent} vaadin-overlay-outside-click - Fired before the overlay is closed on outside click. Calling `preventDefault()` on the event cancels the closing.
|
|
72
72
|
* @fires {CustomEvent} vaadin-overlay-escape-press - Fired before the overlay is closed on Escape key press. Calling `preventDefault()` on the event cancels the closing.
|
|
73
73
|
*
|
|
74
|
-
* @customElement
|
|
74
|
+
* @customElement vaadin-overlay
|
|
75
75
|
* @extends HTMLElement
|
|
76
76
|
* @mixes ThemableMixin
|
|
77
77
|
* @mixes DirMixin
|