@vaadin/dialog 25.1.0-alpha6 → 25.1.0-alpha7
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 +2021 -0
- package/package.json +13 -11
- package/src/vaadin-dialog-overlay-mixin.js +14 -6
- package/src/vaadin-dialog-overlay.js +1 -1
- package/src/vaadin-dialog.js +1 -1
- package/web-types.json +1 -1
- package/web-types.lit.json +1 -1
|
@@ -0,0 +1,2021 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": "1.0.0",
|
|
3
|
+
"readme": "",
|
|
4
|
+
"modules": [
|
|
5
|
+
{
|
|
6
|
+
"kind": "javascript-module",
|
|
7
|
+
"path": "vaadin-dialog.js",
|
|
8
|
+
"declarations": [],
|
|
9
|
+
"exports": [
|
|
10
|
+
{
|
|
11
|
+
"kind": "js",
|
|
12
|
+
"name": "*",
|
|
13
|
+
"declaration": {
|
|
14
|
+
"name": "*",
|
|
15
|
+
"module": "src/vaadin-dialog.js"
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
]
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"kind": "javascript-module",
|
|
22
|
+
"path": "src/vaadin-dialog-base-mixin.js",
|
|
23
|
+
"declarations": [
|
|
24
|
+
{
|
|
25
|
+
"kind": "mixin",
|
|
26
|
+
"description": "",
|
|
27
|
+
"name": "DialogBaseMixin",
|
|
28
|
+
"members": [
|
|
29
|
+
{
|
|
30
|
+
"kind": "field",
|
|
31
|
+
"name": "left",
|
|
32
|
+
"privacy": "public",
|
|
33
|
+
"type": {
|
|
34
|
+
"text": "string"
|
|
35
|
+
},
|
|
36
|
+
"description": "Set the distance of the dialog from the left of the viewport.\nIf a unitless number is provided, pixels are assumed.\n\nNote that the dialog uses an internal container that has some\nadditional spacing, which can be overridden by the theme.",
|
|
37
|
+
"attribute": "left"
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"kind": "field",
|
|
41
|
+
"name": "modeless",
|
|
42
|
+
"privacy": "public",
|
|
43
|
+
"type": {
|
|
44
|
+
"text": "boolean"
|
|
45
|
+
},
|
|
46
|
+
"description": "Set to true to remove backdrop and allow click events on background elements.",
|
|
47
|
+
"attribute": "modeless"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"kind": "field",
|
|
51
|
+
"name": "noCloseOnEsc",
|
|
52
|
+
"privacy": "public",
|
|
53
|
+
"type": {
|
|
54
|
+
"text": "boolean"
|
|
55
|
+
},
|
|
56
|
+
"description": "Set to true to disable closing dialog on Escape press",
|
|
57
|
+
"attribute": "no-close-on-esc"
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"kind": "field",
|
|
61
|
+
"name": "noCloseOnOutsideClick",
|
|
62
|
+
"privacy": "public",
|
|
63
|
+
"type": {
|
|
64
|
+
"text": "boolean"
|
|
65
|
+
},
|
|
66
|
+
"description": "Set to true to disable closing dialog on outside click",
|
|
67
|
+
"attribute": "no-close-on-outside-click"
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"kind": "field",
|
|
71
|
+
"name": "noFocusTrap",
|
|
72
|
+
"privacy": "public",
|
|
73
|
+
"type": {
|
|
74
|
+
"text": "boolean"
|
|
75
|
+
},
|
|
76
|
+
"description": "Set to true to disable focus trapping.",
|
|
77
|
+
"attribute": "no-focus-trap"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"kind": "field",
|
|
81
|
+
"name": "opened",
|
|
82
|
+
"privacy": "public",
|
|
83
|
+
"type": {
|
|
84
|
+
"text": "boolean"
|
|
85
|
+
},
|
|
86
|
+
"description": "True if the dialog is visible and available for interaction.",
|
|
87
|
+
"attribute": "opened"
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
"kind": "field",
|
|
91
|
+
"name": "overlayRole",
|
|
92
|
+
"privacy": "public",
|
|
93
|
+
"type": {
|
|
94
|
+
"text": "string"
|
|
95
|
+
},
|
|
96
|
+
"description": "The `role` attribute value to be set on the dialog. Defaults to \"dialog\".",
|
|
97
|
+
"deprecated": "Use standard `role` attribute on the dialog instead",
|
|
98
|
+
"attribute": "overlay-role"
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
"kind": "field",
|
|
102
|
+
"name": "top",
|
|
103
|
+
"privacy": "public",
|
|
104
|
+
"type": {
|
|
105
|
+
"text": "string"
|
|
106
|
+
},
|
|
107
|
+
"description": "Set the distance of the dialog from the top of the viewport.\nIf a unitless number is provided, pixels are assumed.\n\nNote that the dialog uses an internal container that has some\nadditional spacing, which can be overridden by the theme.",
|
|
108
|
+
"attribute": "top"
|
|
109
|
+
}
|
|
110
|
+
],
|
|
111
|
+
"events": [
|
|
112
|
+
{
|
|
113
|
+
"name": "closed",
|
|
114
|
+
"type": {
|
|
115
|
+
"text": "CustomEvent"
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
],
|
|
119
|
+
"attributes": [
|
|
120
|
+
{
|
|
121
|
+
"name": "left",
|
|
122
|
+
"type": {
|
|
123
|
+
"text": "string"
|
|
124
|
+
},
|
|
125
|
+
"description": "Set the distance of the dialog from the left of the viewport.\nIf a unitless number is provided, pixels are assumed.\n\nNote that the dialog uses an internal container that has some\nadditional spacing, which can be overridden by the theme.",
|
|
126
|
+
"fieldName": "left"
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
"name": "modeless",
|
|
130
|
+
"type": {
|
|
131
|
+
"text": "boolean"
|
|
132
|
+
},
|
|
133
|
+
"description": "Set to true to remove backdrop and allow click events on background elements.",
|
|
134
|
+
"fieldName": "modeless"
|
|
135
|
+
},
|
|
136
|
+
{
|
|
137
|
+
"name": "no-close-on-esc",
|
|
138
|
+
"type": {
|
|
139
|
+
"text": "boolean"
|
|
140
|
+
},
|
|
141
|
+
"description": "Set to true to disable closing dialog on Escape press",
|
|
142
|
+
"fieldName": "noCloseOnEsc"
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
"name": "no-close-on-outside-click",
|
|
146
|
+
"type": {
|
|
147
|
+
"text": "boolean"
|
|
148
|
+
},
|
|
149
|
+
"description": "Set to true to disable closing dialog on outside click",
|
|
150
|
+
"fieldName": "noCloseOnOutsideClick"
|
|
151
|
+
},
|
|
152
|
+
{
|
|
153
|
+
"name": "no-focus-trap",
|
|
154
|
+
"type": {
|
|
155
|
+
"text": "boolean"
|
|
156
|
+
},
|
|
157
|
+
"description": "Set to true to disable focus trapping.",
|
|
158
|
+
"fieldName": "noFocusTrap"
|
|
159
|
+
},
|
|
160
|
+
{
|
|
161
|
+
"name": "opened",
|
|
162
|
+
"type": {
|
|
163
|
+
"text": "boolean"
|
|
164
|
+
},
|
|
165
|
+
"description": "True if the dialog is visible and available for interaction.",
|
|
166
|
+
"fieldName": "opened"
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
"name": "overlay-role",
|
|
170
|
+
"type": {
|
|
171
|
+
"text": "string"
|
|
172
|
+
},
|
|
173
|
+
"description": "The `role` attribute value to be set on the dialog. Defaults to \"dialog\".",
|
|
174
|
+
"deprecated": "Use standard `role` attribute on the dialog instead",
|
|
175
|
+
"fieldName": "overlayRole"
|
|
176
|
+
},
|
|
177
|
+
{
|
|
178
|
+
"name": "top",
|
|
179
|
+
"type": {
|
|
180
|
+
"text": "string"
|
|
181
|
+
},
|
|
182
|
+
"description": "Set the distance of the dialog from the top of the viewport.\nIf a unitless number is provided, pixels are assumed.\n\nNote that the dialog uses an internal container that has some\nadditional spacing, which can be overridden by the theme.",
|
|
183
|
+
"fieldName": "top"
|
|
184
|
+
}
|
|
185
|
+
],
|
|
186
|
+
"parameters": [
|
|
187
|
+
{
|
|
188
|
+
"name": "superClass"
|
|
189
|
+
}
|
|
190
|
+
]
|
|
191
|
+
}
|
|
192
|
+
],
|
|
193
|
+
"exports": [
|
|
194
|
+
{
|
|
195
|
+
"kind": "js",
|
|
196
|
+
"name": "DialogBaseMixin",
|
|
197
|
+
"declaration": {
|
|
198
|
+
"name": "DialogBaseMixin",
|
|
199
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
]
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
"kind": "javascript-module",
|
|
206
|
+
"path": "src/vaadin-dialog-draggable-mixin.js",
|
|
207
|
+
"declarations": [
|
|
208
|
+
{
|
|
209
|
+
"kind": "mixin",
|
|
210
|
+
"description": "",
|
|
211
|
+
"name": "DialogDraggableMixin",
|
|
212
|
+
"members": [
|
|
213
|
+
{
|
|
214
|
+
"kind": "field",
|
|
215
|
+
"name": "draggable",
|
|
216
|
+
"privacy": "public",
|
|
217
|
+
"type": {
|
|
218
|
+
"text": "boolean"
|
|
219
|
+
},
|
|
220
|
+
"description": "Set to true to enable repositioning the dialog by clicking and dragging.\n\nBy default, only the overlay area can be used to drag the element. But,\na child element can be marked as a draggable area by adding a\n\"`draggable`\" class to it, this will by default make all of its children draggable also.\nIf you want a child element to be draggable\nbut still have its children non-draggable (by default), mark it with\n\"`draggable-leaf-only`\" class name.",
|
|
221
|
+
"attribute": "draggable"
|
|
222
|
+
},
|
|
223
|
+
{
|
|
224
|
+
"kind": "field",
|
|
225
|
+
"name": "keepInViewport",
|
|
226
|
+
"privacy": "public",
|
|
227
|
+
"type": {
|
|
228
|
+
"text": "boolean"
|
|
229
|
+
},
|
|
230
|
+
"description": "Set to true to prevent dragging the dialog outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible during dragging.\nThe dialog may still become partially hidden when the viewport is resized.",
|
|
231
|
+
"attribute": "keep-in-viewport"
|
|
232
|
+
}
|
|
233
|
+
],
|
|
234
|
+
"events": [
|
|
235
|
+
{
|
|
236
|
+
"name": "drag-start",
|
|
237
|
+
"type": {
|
|
238
|
+
"text": "CustomEvent"
|
|
239
|
+
}
|
|
240
|
+
},
|
|
241
|
+
{
|
|
242
|
+
"name": "dragged",
|
|
243
|
+
"type": {
|
|
244
|
+
"text": "CustomEvent"
|
|
245
|
+
}
|
|
246
|
+
}
|
|
247
|
+
],
|
|
248
|
+
"attributes": [
|
|
249
|
+
{
|
|
250
|
+
"name": "draggable",
|
|
251
|
+
"type": {
|
|
252
|
+
"text": "boolean"
|
|
253
|
+
},
|
|
254
|
+
"description": "Set to true to enable repositioning the dialog by clicking and dragging.\n\nBy default, only the overlay area can be used to drag the element. But,\na child element can be marked as a draggable area by adding a\n\"`draggable`\" class to it, this will by default make all of its children draggable also.\nIf you want a child element to be draggable\nbut still have its children non-draggable (by default), mark it with\n\"`draggable-leaf-only`\" class name.",
|
|
255
|
+
"fieldName": "draggable"
|
|
256
|
+
},
|
|
257
|
+
{
|
|
258
|
+
"name": "keep-in-viewport",
|
|
259
|
+
"type": {
|
|
260
|
+
"text": "boolean"
|
|
261
|
+
},
|
|
262
|
+
"description": "Set to true to prevent dragging the dialog outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible during dragging.\nThe dialog may still become partially hidden when the viewport is resized.",
|
|
263
|
+
"fieldName": "keepInViewport"
|
|
264
|
+
}
|
|
265
|
+
],
|
|
266
|
+
"parameters": [
|
|
267
|
+
{
|
|
268
|
+
"name": "superClass"
|
|
269
|
+
}
|
|
270
|
+
]
|
|
271
|
+
}
|
|
272
|
+
],
|
|
273
|
+
"exports": [
|
|
274
|
+
{
|
|
275
|
+
"kind": "js",
|
|
276
|
+
"name": "DialogDraggableMixin",
|
|
277
|
+
"declaration": {
|
|
278
|
+
"name": "DialogDraggableMixin",
|
|
279
|
+
"module": "src/vaadin-dialog-draggable-mixin.js"
|
|
280
|
+
}
|
|
281
|
+
}
|
|
282
|
+
]
|
|
283
|
+
},
|
|
284
|
+
{
|
|
285
|
+
"kind": "javascript-module",
|
|
286
|
+
"path": "src/vaadin-dialog-overlay-mixin.js",
|
|
287
|
+
"declarations": [
|
|
288
|
+
{
|
|
289
|
+
"kind": "mixin",
|
|
290
|
+
"description": "",
|
|
291
|
+
"name": "DialogOverlayMixin",
|
|
292
|
+
"members": [
|
|
293
|
+
{
|
|
294
|
+
"kind": "method",
|
|
295
|
+
"name": "bringToFront",
|
|
296
|
+
"description": "Brings the overlay as visually the frontmost one.",
|
|
297
|
+
"inheritedFrom": {
|
|
298
|
+
"name": "OverlayStackMixin",
|
|
299
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-stack-mixin.js"
|
|
300
|
+
}
|
|
301
|
+
},
|
|
302
|
+
{
|
|
303
|
+
"kind": "method",
|
|
304
|
+
"name": "close",
|
|
305
|
+
"parameters": [
|
|
306
|
+
{
|
|
307
|
+
"name": "sourceEvent",
|
|
308
|
+
"type": {
|
|
309
|
+
"text": "Event="
|
|
310
|
+
}
|
|
311
|
+
}
|
|
312
|
+
],
|
|
313
|
+
"inheritedFrom": {
|
|
314
|
+
"name": "OverlayMixin",
|
|
315
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
316
|
+
}
|
|
317
|
+
},
|
|
318
|
+
{
|
|
319
|
+
"kind": "field",
|
|
320
|
+
"name": "focusTrap",
|
|
321
|
+
"privacy": "public",
|
|
322
|
+
"type": {
|
|
323
|
+
"text": "boolean"
|
|
324
|
+
},
|
|
325
|
+
"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.",
|
|
326
|
+
"attribute": "focus-trap",
|
|
327
|
+
"inheritedFrom": {
|
|
328
|
+
"name": "OverlayFocusMixin",
|
|
329
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
330
|
+
}
|
|
331
|
+
},
|
|
332
|
+
{
|
|
333
|
+
"kind": "field",
|
|
334
|
+
"name": "footerRenderer",
|
|
335
|
+
"privacy": "public",
|
|
336
|
+
"type": {
|
|
337
|
+
"text": "object"
|
|
338
|
+
},
|
|
339
|
+
"description": "Custom function for rendering the dialog footer.",
|
|
340
|
+
"attribute": "footer-renderer"
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
"kind": "method",
|
|
344
|
+
"name": "getBounds",
|
|
345
|
+
"description": "Retrieves the coordinates of the overlay.",
|
|
346
|
+
"return": {
|
|
347
|
+
"type": {
|
|
348
|
+
"text": "!DialogOverlayBounds"
|
|
349
|
+
}
|
|
350
|
+
}
|
|
351
|
+
},
|
|
352
|
+
{
|
|
353
|
+
"kind": "field",
|
|
354
|
+
"name": "headerRenderer",
|
|
355
|
+
"privacy": "public",
|
|
356
|
+
"type": {
|
|
357
|
+
"text": "object"
|
|
358
|
+
},
|
|
359
|
+
"description": "Custom function for rendering the dialog header.",
|
|
360
|
+
"attribute": "header-renderer"
|
|
361
|
+
},
|
|
362
|
+
{
|
|
363
|
+
"kind": "field",
|
|
364
|
+
"name": "headerTitle",
|
|
365
|
+
"privacy": "public",
|
|
366
|
+
"type": {
|
|
367
|
+
"text": "string"
|
|
368
|
+
},
|
|
369
|
+
"description": "String used for rendering a dialog title.",
|
|
370
|
+
"attribute": "header-title"
|
|
371
|
+
},
|
|
372
|
+
{
|
|
373
|
+
"kind": "field",
|
|
374
|
+
"name": "hidden",
|
|
375
|
+
"privacy": "public",
|
|
376
|
+
"type": {
|
|
377
|
+
"text": "boolean"
|
|
378
|
+
},
|
|
379
|
+
"description": "When set to true, the overlay is hidden. This also closes the overlay\nimmediately in case there is a closing animation in progress.",
|
|
380
|
+
"attribute": "hidden",
|
|
381
|
+
"inheritedFrom": {
|
|
382
|
+
"name": "OverlayMixin",
|
|
383
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
384
|
+
}
|
|
385
|
+
},
|
|
386
|
+
{
|
|
387
|
+
"kind": "field",
|
|
388
|
+
"name": "model",
|
|
389
|
+
"privacy": "public",
|
|
390
|
+
"type": {
|
|
391
|
+
"text": "object"
|
|
392
|
+
},
|
|
393
|
+
"description": "Object with properties that is passed to `renderer` function",
|
|
394
|
+
"attribute": "model",
|
|
395
|
+
"inheritedFrom": {
|
|
396
|
+
"name": "OverlayMixin",
|
|
397
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
398
|
+
}
|
|
399
|
+
},
|
|
400
|
+
{
|
|
401
|
+
"kind": "field",
|
|
402
|
+
"name": "modeless",
|
|
403
|
+
"privacy": "public",
|
|
404
|
+
"type": {
|
|
405
|
+
"text": "boolean"
|
|
406
|
+
},
|
|
407
|
+
"description": "When true the overlay won't disable the main content, showing\nit doesn't change the functionality of the user interface.",
|
|
408
|
+
"attribute": "modeless",
|
|
409
|
+
"inheritedFrom": {
|
|
410
|
+
"name": "OverlayMixin",
|
|
411
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
412
|
+
}
|
|
413
|
+
},
|
|
414
|
+
{
|
|
415
|
+
"kind": "field",
|
|
416
|
+
"name": "opened",
|
|
417
|
+
"privacy": "public",
|
|
418
|
+
"type": {
|
|
419
|
+
"text": "boolean"
|
|
420
|
+
},
|
|
421
|
+
"description": "When true, the overlay is visible and attached to body.",
|
|
422
|
+
"attribute": "opened",
|
|
423
|
+
"inheritedFrom": {
|
|
424
|
+
"name": "OverlayMixin",
|
|
425
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
426
|
+
}
|
|
427
|
+
},
|
|
428
|
+
{
|
|
429
|
+
"kind": "field",
|
|
430
|
+
"name": "owner",
|
|
431
|
+
"privacy": "public",
|
|
432
|
+
"type": {
|
|
433
|
+
"text": "HTMLElement"
|
|
434
|
+
},
|
|
435
|
+
"description": "Owner element passed with renderer function",
|
|
436
|
+
"attribute": "owner",
|
|
437
|
+
"inheritedFrom": {
|
|
438
|
+
"name": "OverlayMixin",
|
|
439
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
440
|
+
}
|
|
441
|
+
},
|
|
442
|
+
{
|
|
443
|
+
"kind": "field",
|
|
444
|
+
"name": "renderer",
|
|
445
|
+
"privacy": "public",
|
|
446
|
+
"type": {
|
|
447
|
+
"text": "OverlayRenderer | null | undefined"
|
|
448
|
+
},
|
|
449
|
+
"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.",
|
|
450
|
+
"attribute": "renderer",
|
|
451
|
+
"inheritedFrom": {
|
|
452
|
+
"name": "OverlayMixin",
|
|
453
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
454
|
+
}
|
|
455
|
+
},
|
|
456
|
+
{
|
|
457
|
+
"kind": "method",
|
|
458
|
+
"name": "requestContentUpdate",
|
|
459
|
+
"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.",
|
|
460
|
+
"inheritedFrom": {
|
|
461
|
+
"name": "OverlayMixin",
|
|
462
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
463
|
+
}
|
|
464
|
+
},
|
|
465
|
+
{
|
|
466
|
+
"kind": "field",
|
|
467
|
+
"name": "restoreFocusNode",
|
|
468
|
+
"privacy": "public",
|
|
469
|
+
"type": {
|
|
470
|
+
"text": "HTMLElement"
|
|
471
|
+
},
|
|
472
|
+
"description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.",
|
|
473
|
+
"attribute": "restore-focus-node",
|
|
474
|
+
"inheritedFrom": {
|
|
475
|
+
"name": "OverlayFocusMixin",
|
|
476
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
477
|
+
}
|
|
478
|
+
},
|
|
479
|
+
{
|
|
480
|
+
"kind": "field",
|
|
481
|
+
"name": "restoreFocusOnClose",
|
|
482
|
+
"privacy": "public",
|
|
483
|
+
"type": {
|
|
484
|
+
"text": "boolean"
|
|
485
|
+
},
|
|
486
|
+
"description": "Set to true to enable restoring of focus when overlay is closed.",
|
|
487
|
+
"attribute": "restore-focus-on-close",
|
|
488
|
+
"inheritedFrom": {
|
|
489
|
+
"name": "OverlayFocusMixin",
|
|
490
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
491
|
+
}
|
|
492
|
+
},
|
|
493
|
+
{
|
|
494
|
+
"kind": "method",
|
|
495
|
+
"name": "setBounds",
|
|
496
|
+
"parameters": [
|
|
497
|
+
{
|
|
498
|
+
"name": "bounds",
|
|
499
|
+
"type": {
|
|
500
|
+
"text": "!OverlayBoundsParam"
|
|
501
|
+
}
|
|
502
|
+
},
|
|
503
|
+
{
|
|
504
|
+
"name": "absolute",
|
|
505
|
+
"default": "true",
|
|
506
|
+
"type": {
|
|
507
|
+
"text": "boolean"
|
|
508
|
+
}
|
|
509
|
+
}
|
|
510
|
+
],
|
|
511
|
+
"description": "Updates the coordinates of the overlay.",
|
|
512
|
+
"inheritedFrom": {
|
|
513
|
+
"name": "OverlayMixin",
|
|
514
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
515
|
+
}
|
|
516
|
+
},
|
|
517
|
+
{
|
|
518
|
+
"kind": "field",
|
|
519
|
+
"name": "withBackdrop",
|
|
520
|
+
"privacy": "public",
|
|
521
|
+
"type": {
|
|
522
|
+
"text": "boolean"
|
|
523
|
+
},
|
|
524
|
+
"description": "When true the overlay has backdrop on top of content when opened.",
|
|
525
|
+
"attribute": "with-backdrop",
|
|
526
|
+
"inheritedFrom": {
|
|
527
|
+
"name": "OverlayMixin",
|
|
528
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
529
|
+
}
|
|
530
|
+
}
|
|
531
|
+
],
|
|
532
|
+
"attributes": [
|
|
533
|
+
{
|
|
534
|
+
"name": "focus-trap",
|
|
535
|
+
"type": {
|
|
536
|
+
"text": "boolean"
|
|
537
|
+
},
|
|
538
|
+
"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.",
|
|
539
|
+
"fieldName": "focusTrap",
|
|
540
|
+
"inheritedFrom": {
|
|
541
|
+
"name": "OverlayFocusMixin",
|
|
542
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
543
|
+
}
|
|
544
|
+
},
|
|
545
|
+
{
|
|
546
|
+
"name": "header-title",
|
|
547
|
+
"type": {
|
|
548
|
+
"text": "string"
|
|
549
|
+
},
|
|
550
|
+
"description": "String used for rendering a dialog title.",
|
|
551
|
+
"fieldName": "headerTitle"
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
"name": "hidden",
|
|
555
|
+
"type": {
|
|
556
|
+
"text": "boolean"
|
|
557
|
+
},
|
|
558
|
+
"description": "When set to true, the overlay is hidden. This also closes the overlay\nimmediately in case there is a closing animation in progress.",
|
|
559
|
+
"fieldName": "hidden",
|
|
560
|
+
"inheritedFrom": {
|
|
561
|
+
"name": "OverlayMixin",
|
|
562
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
563
|
+
}
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
"name": "modeless",
|
|
567
|
+
"type": {
|
|
568
|
+
"text": "boolean"
|
|
569
|
+
},
|
|
570
|
+
"description": "When true the overlay won't disable the main content, showing\nit doesn't change the functionality of the user interface.",
|
|
571
|
+
"fieldName": "modeless",
|
|
572
|
+
"inheritedFrom": {
|
|
573
|
+
"name": "OverlayMixin",
|
|
574
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
575
|
+
}
|
|
576
|
+
},
|
|
577
|
+
{
|
|
578
|
+
"name": "opened",
|
|
579
|
+
"type": {
|
|
580
|
+
"text": "boolean"
|
|
581
|
+
},
|
|
582
|
+
"description": "When true, the overlay is visible and attached to body.",
|
|
583
|
+
"fieldName": "opened",
|
|
584
|
+
"inheritedFrom": {
|
|
585
|
+
"name": "OverlayMixin",
|
|
586
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
587
|
+
}
|
|
588
|
+
},
|
|
589
|
+
{
|
|
590
|
+
"name": "owner",
|
|
591
|
+
"type": {
|
|
592
|
+
"text": "HTMLElement"
|
|
593
|
+
},
|
|
594
|
+
"description": "Owner element passed with renderer function",
|
|
595
|
+
"fieldName": "owner",
|
|
596
|
+
"inheritedFrom": {
|
|
597
|
+
"name": "OverlayMixin",
|
|
598
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
599
|
+
}
|
|
600
|
+
},
|
|
601
|
+
{
|
|
602
|
+
"name": "renderer",
|
|
603
|
+
"type": {
|
|
604
|
+
"text": "OverlayRenderer | null | undefined"
|
|
605
|
+
},
|
|
606
|
+
"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.",
|
|
607
|
+
"fieldName": "renderer",
|
|
608
|
+
"inheritedFrom": {
|
|
609
|
+
"name": "OverlayMixin",
|
|
610
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
611
|
+
}
|
|
612
|
+
},
|
|
613
|
+
{
|
|
614
|
+
"name": "restore-focus-node",
|
|
615
|
+
"type": {
|
|
616
|
+
"text": "HTMLElement"
|
|
617
|
+
},
|
|
618
|
+
"description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.",
|
|
619
|
+
"fieldName": "restoreFocusNode",
|
|
620
|
+
"inheritedFrom": {
|
|
621
|
+
"name": "OverlayFocusMixin",
|
|
622
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
623
|
+
}
|
|
624
|
+
},
|
|
625
|
+
{
|
|
626
|
+
"name": "restore-focus-on-close",
|
|
627
|
+
"type": {
|
|
628
|
+
"text": "boolean"
|
|
629
|
+
},
|
|
630
|
+
"description": "Set to true to enable restoring of focus when overlay is closed.",
|
|
631
|
+
"fieldName": "restoreFocusOnClose",
|
|
632
|
+
"inheritedFrom": {
|
|
633
|
+
"name": "OverlayFocusMixin",
|
|
634
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
635
|
+
}
|
|
636
|
+
},
|
|
637
|
+
{
|
|
638
|
+
"name": "with-backdrop",
|
|
639
|
+
"type": {
|
|
640
|
+
"text": "boolean"
|
|
641
|
+
},
|
|
642
|
+
"description": "When true the overlay has backdrop on top of content when opened.",
|
|
643
|
+
"fieldName": "withBackdrop",
|
|
644
|
+
"inheritedFrom": {
|
|
645
|
+
"name": "OverlayMixin",
|
|
646
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
647
|
+
}
|
|
648
|
+
}
|
|
649
|
+
],
|
|
650
|
+
"mixins": [
|
|
651
|
+
{
|
|
652
|
+
"name": "OverlayMixin",
|
|
653
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
654
|
+
}
|
|
655
|
+
],
|
|
656
|
+
"parameters": [
|
|
657
|
+
{
|
|
658
|
+
"name": "superClass"
|
|
659
|
+
}
|
|
660
|
+
],
|
|
661
|
+
"events": [
|
|
662
|
+
{
|
|
663
|
+
"name": "vaadin-overlay-closed",
|
|
664
|
+
"type": {
|
|
665
|
+
"text": "CustomEvent"
|
|
666
|
+
},
|
|
667
|
+
"inheritedFrom": {
|
|
668
|
+
"name": "OverlayMixin",
|
|
669
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
670
|
+
}
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
"name": "vaadin-overlay-closing",
|
|
674
|
+
"type": {
|
|
675
|
+
"text": "CustomEvent"
|
|
676
|
+
},
|
|
677
|
+
"inheritedFrom": {
|
|
678
|
+
"name": "OverlayMixin",
|
|
679
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
680
|
+
}
|
|
681
|
+
}
|
|
682
|
+
]
|
|
683
|
+
}
|
|
684
|
+
],
|
|
685
|
+
"exports": [
|
|
686
|
+
{
|
|
687
|
+
"kind": "js",
|
|
688
|
+
"name": "DialogOverlayMixin",
|
|
689
|
+
"declaration": {
|
|
690
|
+
"name": "DialogOverlayMixin",
|
|
691
|
+
"module": "src/vaadin-dialog-overlay-mixin.js"
|
|
692
|
+
}
|
|
693
|
+
}
|
|
694
|
+
]
|
|
695
|
+
},
|
|
696
|
+
{
|
|
697
|
+
"kind": "javascript-module",
|
|
698
|
+
"path": "src/vaadin-dialog-overlay.js",
|
|
699
|
+
"declarations": [
|
|
700
|
+
{
|
|
701
|
+
"kind": "class",
|
|
702
|
+
"description": "An element used internally by `<vaadin-dialog>`. Not intended to be used separately.",
|
|
703
|
+
"name": "DialogOverlay",
|
|
704
|
+
"members": [
|
|
705
|
+
{
|
|
706
|
+
"kind": "method",
|
|
707
|
+
"name": "bringToFront",
|
|
708
|
+
"description": "Brings the overlay as visually the frontmost one.",
|
|
709
|
+
"inheritedFrom": {
|
|
710
|
+
"name": "OverlayStackMixin",
|
|
711
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-stack-mixin.js"
|
|
712
|
+
}
|
|
713
|
+
},
|
|
714
|
+
{
|
|
715
|
+
"kind": "method",
|
|
716
|
+
"name": "close",
|
|
717
|
+
"parameters": [
|
|
718
|
+
{
|
|
719
|
+
"name": "sourceEvent",
|
|
720
|
+
"type": {
|
|
721
|
+
"text": "Event="
|
|
722
|
+
}
|
|
723
|
+
}
|
|
724
|
+
],
|
|
725
|
+
"inheritedFrom": {
|
|
726
|
+
"name": "OverlayMixin",
|
|
727
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
728
|
+
}
|
|
729
|
+
},
|
|
730
|
+
{
|
|
731
|
+
"kind": "field",
|
|
732
|
+
"name": "focusTrap",
|
|
733
|
+
"privacy": "public",
|
|
734
|
+
"type": {
|
|
735
|
+
"text": "boolean"
|
|
736
|
+
},
|
|
737
|
+
"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.",
|
|
738
|
+
"attribute": "focus-trap",
|
|
739
|
+
"inheritedFrom": {
|
|
740
|
+
"name": "OverlayFocusMixin",
|
|
741
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
742
|
+
}
|
|
743
|
+
},
|
|
744
|
+
{
|
|
745
|
+
"kind": "field",
|
|
746
|
+
"name": "footerRenderer",
|
|
747
|
+
"privacy": "public",
|
|
748
|
+
"type": {
|
|
749
|
+
"text": "object"
|
|
750
|
+
},
|
|
751
|
+
"description": "Custom function for rendering the dialog footer.",
|
|
752
|
+
"attribute": "footer-renderer",
|
|
753
|
+
"inheritedFrom": {
|
|
754
|
+
"name": "DialogOverlayMixin",
|
|
755
|
+
"module": "src/vaadin-dialog-overlay-mixin.js"
|
|
756
|
+
}
|
|
757
|
+
},
|
|
758
|
+
{
|
|
759
|
+
"kind": "method",
|
|
760
|
+
"name": "getBounds",
|
|
761
|
+
"description": "Retrieves the coordinates of the overlay.",
|
|
762
|
+
"return": {
|
|
763
|
+
"type": {
|
|
764
|
+
"text": "!DialogOverlayBounds"
|
|
765
|
+
}
|
|
766
|
+
},
|
|
767
|
+
"inheritedFrom": {
|
|
768
|
+
"name": "DialogOverlayMixin",
|
|
769
|
+
"module": "src/vaadin-dialog-overlay-mixin.js"
|
|
770
|
+
}
|
|
771
|
+
},
|
|
772
|
+
{
|
|
773
|
+
"kind": "field",
|
|
774
|
+
"name": "headerRenderer",
|
|
775
|
+
"privacy": "public",
|
|
776
|
+
"type": {
|
|
777
|
+
"text": "object"
|
|
778
|
+
},
|
|
779
|
+
"description": "Custom function for rendering the dialog header.",
|
|
780
|
+
"attribute": "header-renderer",
|
|
781
|
+
"inheritedFrom": {
|
|
782
|
+
"name": "DialogOverlayMixin",
|
|
783
|
+
"module": "src/vaadin-dialog-overlay-mixin.js"
|
|
784
|
+
}
|
|
785
|
+
},
|
|
786
|
+
{
|
|
787
|
+
"kind": "field",
|
|
788
|
+
"name": "headerTitle",
|
|
789
|
+
"privacy": "public",
|
|
790
|
+
"type": {
|
|
791
|
+
"text": "string"
|
|
792
|
+
},
|
|
793
|
+
"description": "String used for rendering a dialog title.",
|
|
794
|
+
"attribute": "header-title",
|
|
795
|
+
"inheritedFrom": {
|
|
796
|
+
"name": "DialogOverlayMixin",
|
|
797
|
+
"module": "src/vaadin-dialog-overlay-mixin.js"
|
|
798
|
+
}
|
|
799
|
+
},
|
|
800
|
+
{
|
|
801
|
+
"kind": "field",
|
|
802
|
+
"name": "hidden",
|
|
803
|
+
"privacy": "public",
|
|
804
|
+
"type": {
|
|
805
|
+
"text": "boolean"
|
|
806
|
+
},
|
|
807
|
+
"description": "When set to true, the overlay is hidden. This also closes the overlay\nimmediately in case there is a closing animation in progress.",
|
|
808
|
+
"attribute": "hidden",
|
|
809
|
+
"inheritedFrom": {
|
|
810
|
+
"name": "OverlayMixin",
|
|
811
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
812
|
+
}
|
|
813
|
+
},
|
|
814
|
+
{
|
|
815
|
+
"kind": "field",
|
|
816
|
+
"name": "model",
|
|
817
|
+
"privacy": "public",
|
|
818
|
+
"type": {
|
|
819
|
+
"text": "object"
|
|
820
|
+
},
|
|
821
|
+
"description": "Object with properties that is passed to `renderer` function",
|
|
822
|
+
"attribute": "model",
|
|
823
|
+
"inheritedFrom": {
|
|
824
|
+
"name": "OverlayMixin",
|
|
825
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
826
|
+
}
|
|
827
|
+
},
|
|
828
|
+
{
|
|
829
|
+
"kind": "field",
|
|
830
|
+
"name": "modeless",
|
|
831
|
+
"privacy": "public",
|
|
832
|
+
"type": {
|
|
833
|
+
"text": "boolean"
|
|
834
|
+
},
|
|
835
|
+
"description": "When true the overlay won't disable the main content, showing\nit doesn't change the functionality of the user interface.",
|
|
836
|
+
"attribute": "modeless",
|
|
837
|
+
"inheritedFrom": {
|
|
838
|
+
"name": "OverlayMixin",
|
|
839
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
840
|
+
}
|
|
841
|
+
},
|
|
842
|
+
{
|
|
843
|
+
"kind": "field",
|
|
844
|
+
"name": "opened",
|
|
845
|
+
"privacy": "public",
|
|
846
|
+
"type": {
|
|
847
|
+
"text": "boolean"
|
|
848
|
+
},
|
|
849
|
+
"description": "When true, the overlay is visible and attached to body.",
|
|
850
|
+
"attribute": "opened",
|
|
851
|
+
"inheritedFrom": {
|
|
852
|
+
"name": "OverlayMixin",
|
|
853
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
854
|
+
}
|
|
855
|
+
},
|
|
856
|
+
{
|
|
857
|
+
"kind": "field",
|
|
858
|
+
"name": "owner",
|
|
859
|
+
"privacy": "public",
|
|
860
|
+
"type": {
|
|
861
|
+
"text": "HTMLElement"
|
|
862
|
+
},
|
|
863
|
+
"description": "Owner element passed with renderer function",
|
|
864
|
+
"attribute": "owner",
|
|
865
|
+
"inheritedFrom": {
|
|
866
|
+
"name": "OverlayMixin",
|
|
867
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
868
|
+
}
|
|
869
|
+
},
|
|
870
|
+
{
|
|
871
|
+
"kind": "field",
|
|
872
|
+
"name": "renderer",
|
|
873
|
+
"privacy": "public",
|
|
874
|
+
"type": {
|
|
875
|
+
"text": "OverlayRenderer | null | undefined"
|
|
876
|
+
},
|
|
877
|
+
"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.",
|
|
878
|
+
"attribute": "renderer",
|
|
879
|
+
"inheritedFrom": {
|
|
880
|
+
"name": "OverlayMixin",
|
|
881
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
882
|
+
}
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"kind": "method",
|
|
886
|
+
"name": "requestContentUpdate",
|
|
887
|
+
"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.",
|
|
888
|
+
"inheritedFrom": {
|
|
889
|
+
"name": "OverlayMixin",
|
|
890
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
891
|
+
}
|
|
892
|
+
},
|
|
893
|
+
{
|
|
894
|
+
"kind": "field",
|
|
895
|
+
"name": "restoreFocusNode",
|
|
896
|
+
"privacy": "public",
|
|
897
|
+
"type": {
|
|
898
|
+
"text": "HTMLElement"
|
|
899
|
+
},
|
|
900
|
+
"description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.",
|
|
901
|
+
"attribute": "restore-focus-node",
|
|
902
|
+
"inheritedFrom": {
|
|
903
|
+
"name": "OverlayFocusMixin",
|
|
904
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
905
|
+
}
|
|
906
|
+
},
|
|
907
|
+
{
|
|
908
|
+
"kind": "field",
|
|
909
|
+
"name": "restoreFocusOnClose",
|
|
910
|
+
"privacy": "public",
|
|
911
|
+
"type": {
|
|
912
|
+
"text": "boolean"
|
|
913
|
+
},
|
|
914
|
+
"description": "Set to true to enable restoring of focus when overlay is closed.",
|
|
915
|
+
"attribute": "restore-focus-on-close",
|
|
916
|
+
"inheritedFrom": {
|
|
917
|
+
"name": "OverlayFocusMixin",
|
|
918
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
919
|
+
}
|
|
920
|
+
},
|
|
921
|
+
{
|
|
922
|
+
"kind": "method",
|
|
923
|
+
"name": "setBounds",
|
|
924
|
+
"parameters": [
|
|
925
|
+
{
|
|
926
|
+
"name": "bounds",
|
|
927
|
+
"type": {
|
|
928
|
+
"text": "!OverlayBoundsParam"
|
|
929
|
+
}
|
|
930
|
+
},
|
|
931
|
+
{
|
|
932
|
+
"name": "absolute",
|
|
933
|
+
"default": "true",
|
|
934
|
+
"type": {
|
|
935
|
+
"text": "boolean"
|
|
936
|
+
}
|
|
937
|
+
}
|
|
938
|
+
],
|
|
939
|
+
"description": "Updates the coordinates of the overlay.",
|
|
940
|
+
"inheritedFrom": {
|
|
941
|
+
"name": "OverlayMixin",
|
|
942
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
943
|
+
}
|
|
944
|
+
},
|
|
945
|
+
{
|
|
946
|
+
"kind": "field",
|
|
947
|
+
"name": "withBackdrop",
|
|
948
|
+
"privacy": "public",
|
|
949
|
+
"type": {
|
|
950
|
+
"text": "boolean"
|
|
951
|
+
},
|
|
952
|
+
"description": "When true the overlay has backdrop on top of content when opened.",
|
|
953
|
+
"attribute": "with-backdrop",
|
|
954
|
+
"inheritedFrom": {
|
|
955
|
+
"name": "OverlayMixin",
|
|
956
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
957
|
+
}
|
|
958
|
+
}
|
|
959
|
+
],
|
|
960
|
+
"mixins": [
|
|
961
|
+
{
|
|
962
|
+
"name": "DialogOverlayMixin",
|
|
963
|
+
"module": "src/vaadin-dialog-overlay-mixin.js"
|
|
964
|
+
},
|
|
965
|
+
{
|
|
966
|
+
"name": "DirMixin",
|
|
967
|
+
"package": "@vaadin/component-base/src/dir-mixin.js"
|
|
968
|
+
},
|
|
969
|
+
{
|
|
970
|
+
"name": "ThemableMixin",
|
|
971
|
+
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
972
|
+
},
|
|
973
|
+
{
|
|
974
|
+
"name": "PolylitMixin",
|
|
975
|
+
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
976
|
+
},
|
|
977
|
+
{
|
|
978
|
+
"name": "LumoInjectionMixin",
|
|
979
|
+
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
980
|
+
}
|
|
981
|
+
],
|
|
982
|
+
"superclass": {
|
|
983
|
+
"name": "LitElement",
|
|
984
|
+
"package": "lit"
|
|
985
|
+
},
|
|
986
|
+
"tagName": "vaadin-dialog-overlay",
|
|
987
|
+
"customElement": true,
|
|
988
|
+
"attributes": [
|
|
989
|
+
{
|
|
990
|
+
"name": "focus-trap",
|
|
991
|
+
"type": {
|
|
992
|
+
"text": "boolean"
|
|
993
|
+
},
|
|
994
|
+
"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.",
|
|
995
|
+
"fieldName": "focusTrap",
|
|
996
|
+
"inheritedFrom": {
|
|
997
|
+
"name": "OverlayFocusMixin",
|
|
998
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
999
|
+
}
|
|
1000
|
+
},
|
|
1001
|
+
{
|
|
1002
|
+
"name": "header-title",
|
|
1003
|
+
"type": {
|
|
1004
|
+
"text": "string"
|
|
1005
|
+
},
|
|
1006
|
+
"description": "String used for rendering a dialog title.",
|
|
1007
|
+
"fieldName": "headerTitle",
|
|
1008
|
+
"inheritedFrom": {
|
|
1009
|
+
"name": "DialogOverlayMixin",
|
|
1010
|
+
"module": "src/vaadin-dialog-overlay-mixin.js"
|
|
1011
|
+
}
|
|
1012
|
+
},
|
|
1013
|
+
{
|
|
1014
|
+
"name": "hidden",
|
|
1015
|
+
"type": {
|
|
1016
|
+
"text": "boolean"
|
|
1017
|
+
},
|
|
1018
|
+
"description": "When set to true, the overlay is hidden. This also closes the overlay\nimmediately in case there is a closing animation in progress.",
|
|
1019
|
+
"fieldName": "hidden",
|
|
1020
|
+
"inheritedFrom": {
|
|
1021
|
+
"name": "OverlayMixin",
|
|
1022
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1023
|
+
}
|
|
1024
|
+
},
|
|
1025
|
+
{
|
|
1026
|
+
"name": "modeless",
|
|
1027
|
+
"type": {
|
|
1028
|
+
"text": "boolean"
|
|
1029
|
+
},
|
|
1030
|
+
"description": "When true the overlay won't disable the main content, showing\nit doesn't change the functionality of the user interface.",
|
|
1031
|
+
"fieldName": "modeless",
|
|
1032
|
+
"inheritedFrom": {
|
|
1033
|
+
"name": "OverlayMixin",
|
|
1034
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1035
|
+
}
|
|
1036
|
+
},
|
|
1037
|
+
{
|
|
1038
|
+
"name": "opened",
|
|
1039
|
+
"type": {
|
|
1040
|
+
"text": "boolean"
|
|
1041
|
+
},
|
|
1042
|
+
"description": "When true, the overlay is visible and attached to body.",
|
|
1043
|
+
"fieldName": "opened",
|
|
1044
|
+
"inheritedFrom": {
|
|
1045
|
+
"name": "OverlayMixin",
|
|
1046
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1047
|
+
}
|
|
1048
|
+
},
|
|
1049
|
+
{
|
|
1050
|
+
"name": "owner",
|
|
1051
|
+
"type": {
|
|
1052
|
+
"text": "HTMLElement"
|
|
1053
|
+
},
|
|
1054
|
+
"description": "Owner element passed with renderer function",
|
|
1055
|
+
"fieldName": "owner",
|
|
1056
|
+
"inheritedFrom": {
|
|
1057
|
+
"name": "OverlayMixin",
|
|
1058
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1059
|
+
}
|
|
1060
|
+
},
|
|
1061
|
+
{
|
|
1062
|
+
"name": "renderer",
|
|
1063
|
+
"type": {
|
|
1064
|
+
"text": "OverlayRenderer | null | undefined"
|
|
1065
|
+
},
|
|
1066
|
+
"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.",
|
|
1067
|
+
"fieldName": "renderer",
|
|
1068
|
+
"inheritedFrom": {
|
|
1069
|
+
"name": "OverlayMixin",
|
|
1070
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1071
|
+
}
|
|
1072
|
+
},
|
|
1073
|
+
{
|
|
1074
|
+
"name": "restore-focus-node",
|
|
1075
|
+
"type": {
|
|
1076
|
+
"text": "HTMLElement"
|
|
1077
|
+
},
|
|
1078
|
+
"description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.",
|
|
1079
|
+
"fieldName": "restoreFocusNode",
|
|
1080
|
+
"inheritedFrom": {
|
|
1081
|
+
"name": "OverlayFocusMixin",
|
|
1082
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
1083
|
+
}
|
|
1084
|
+
},
|
|
1085
|
+
{
|
|
1086
|
+
"name": "restore-focus-on-close",
|
|
1087
|
+
"type": {
|
|
1088
|
+
"text": "boolean"
|
|
1089
|
+
},
|
|
1090
|
+
"description": "Set to true to enable restoring of focus when overlay is closed.",
|
|
1091
|
+
"fieldName": "restoreFocusOnClose",
|
|
1092
|
+
"inheritedFrom": {
|
|
1093
|
+
"name": "OverlayFocusMixin",
|
|
1094
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
1095
|
+
}
|
|
1096
|
+
},
|
|
1097
|
+
{
|
|
1098
|
+
"name": "with-backdrop",
|
|
1099
|
+
"type": {
|
|
1100
|
+
"text": "boolean"
|
|
1101
|
+
},
|
|
1102
|
+
"description": "When true the overlay has backdrop on top of content when opened.",
|
|
1103
|
+
"fieldName": "withBackdrop",
|
|
1104
|
+
"inheritedFrom": {
|
|
1105
|
+
"name": "OverlayMixin",
|
|
1106
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1107
|
+
}
|
|
1108
|
+
}
|
|
1109
|
+
],
|
|
1110
|
+
"events": [
|
|
1111
|
+
{
|
|
1112
|
+
"name": "vaadin-overlay-closed",
|
|
1113
|
+
"type": {
|
|
1114
|
+
"text": "CustomEvent"
|
|
1115
|
+
},
|
|
1116
|
+
"inheritedFrom": {
|
|
1117
|
+
"name": "OverlayMixin",
|
|
1118
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1119
|
+
}
|
|
1120
|
+
},
|
|
1121
|
+
{
|
|
1122
|
+
"name": "vaadin-overlay-closing",
|
|
1123
|
+
"type": {
|
|
1124
|
+
"text": "CustomEvent"
|
|
1125
|
+
},
|
|
1126
|
+
"inheritedFrom": {
|
|
1127
|
+
"name": "OverlayMixin",
|
|
1128
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1129
|
+
}
|
|
1130
|
+
}
|
|
1131
|
+
]
|
|
1132
|
+
}
|
|
1133
|
+
],
|
|
1134
|
+
"exports": [
|
|
1135
|
+
{
|
|
1136
|
+
"kind": "js",
|
|
1137
|
+
"name": "DialogOverlay",
|
|
1138
|
+
"declaration": {
|
|
1139
|
+
"name": "DialogOverlay",
|
|
1140
|
+
"module": "src/vaadin-dialog-overlay.js"
|
|
1141
|
+
}
|
|
1142
|
+
}
|
|
1143
|
+
]
|
|
1144
|
+
},
|
|
1145
|
+
{
|
|
1146
|
+
"kind": "javascript-module",
|
|
1147
|
+
"path": "src/vaadin-dialog-renderer-mixin.js",
|
|
1148
|
+
"declarations": [
|
|
1149
|
+
{
|
|
1150
|
+
"kind": "mixin",
|
|
1151
|
+
"description": "",
|
|
1152
|
+
"name": "DialogRendererMixin",
|
|
1153
|
+
"members": [
|
|
1154
|
+
{
|
|
1155
|
+
"kind": "field",
|
|
1156
|
+
"name": "footerRenderer",
|
|
1157
|
+
"privacy": "public",
|
|
1158
|
+
"type": {
|
|
1159
|
+
"text": "DialogRenderer | undefined"
|
|
1160
|
+
},
|
|
1161
|
+
"description": "Custom function for rendering the dialog footer.\nReceives two arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `dialog` The reference to the `<vaadin-dialog>` element.\n\nWhen `footerRenderer` is set, the attribute `has-footer` is set on the dialog.",
|
|
1162
|
+
"attribute": "footer-renderer"
|
|
1163
|
+
},
|
|
1164
|
+
{
|
|
1165
|
+
"kind": "field",
|
|
1166
|
+
"name": "headerRenderer",
|
|
1167
|
+
"privacy": "public",
|
|
1168
|
+
"type": {
|
|
1169
|
+
"text": "DialogRenderer | undefined"
|
|
1170
|
+
},
|
|
1171
|
+
"description": "Custom function for rendering the dialog header.\nReceives two arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `dialog` The reference to the `<vaadin-dialog>` element.\n\nIf both `headerTitle` and `headerRenderer` are defined, the title\nand the elements created by the renderer will be placed next to\neach other, with the title coming first.\n\nWhen `headerRenderer` is set, the attribute `has-header` is set on the dialog.",
|
|
1172
|
+
"attribute": "header-renderer"
|
|
1173
|
+
},
|
|
1174
|
+
{
|
|
1175
|
+
"kind": "field",
|
|
1176
|
+
"name": "headerTitle",
|
|
1177
|
+
"privacy": "public",
|
|
1178
|
+
"description": "String used for rendering a dialog title.\n\nIf both `headerTitle` and `headerRenderer` are defined, the title\nand the elements created by the renderer will be placed next to\neach other, with the title coming first.\n\nWhen `headerTitle` is set, the attribute `has-title` is set on the dialog.",
|
|
1179
|
+
"attribute": "header-title"
|
|
1180
|
+
},
|
|
1181
|
+
{
|
|
1182
|
+
"kind": "field",
|
|
1183
|
+
"name": "renderer",
|
|
1184
|
+
"privacy": "public",
|
|
1185
|
+
"type": {
|
|
1186
|
+
"text": "DialogRenderer | undefined"
|
|
1187
|
+
},
|
|
1188
|
+
"description": "Custom function for rendering the content of the dialog.\nReceives two arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `dialog` The reference to the `<vaadin-dialog>` element.",
|
|
1189
|
+
"attribute": "renderer"
|
|
1190
|
+
},
|
|
1191
|
+
{
|
|
1192
|
+
"kind": "method",
|
|
1193
|
+
"name": "requestContentUpdate",
|
|
1194
|
+
"description": "Requests an update for the content of the dialog.\nWhile performing the update, it invokes the renderer passed in the `renderer` property,\nas well as `headerRender` and `footerRenderer` properties, if these are defined.\n\nIt is not guaranteed that the update happens immediately (synchronously) after it is requested."
|
|
1195
|
+
}
|
|
1196
|
+
],
|
|
1197
|
+
"attributes": [
|
|
1198
|
+
{
|
|
1199
|
+
"name": "footer-renderer",
|
|
1200
|
+
"type": {
|
|
1201
|
+
"text": "DialogRenderer | undefined"
|
|
1202
|
+
},
|
|
1203
|
+
"description": "Custom function for rendering the dialog footer.\nReceives two arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `dialog` The reference to the `<vaadin-dialog>` element.\n\nWhen `footerRenderer` is set, the attribute `has-footer` is set on the dialog.",
|
|
1204
|
+
"fieldName": "footerRenderer"
|
|
1205
|
+
},
|
|
1206
|
+
{
|
|
1207
|
+
"name": "header-renderer",
|
|
1208
|
+
"type": {
|
|
1209
|
+
"text": "DialogRenderer | undefined"
|
|
1210
|
+
},
|
|
1211
|
+
"description": "Custom function for rendering the dialog header.\nReceives two arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `dialog` The reference to the `<vaadin-dialog>` element.\n\nIf both `headerTitle` and `headerRenderer` are defined, the title\nand the elements created by the renderer will be placed next to\neach other, with the title coming first.\n\nWhen `headerRenderer` is set, the attribute `has-header` is set on the dialog.",
|
|
1212
|
+
"fieldName": "headerRenderer"
|
|
1213
|
+
},
|
|
1214
|
+
{
|
|
1215
|
+
"name": "header-title",
|
|
1216
|
+
"description": "String used for rendering a dialog title.\n\nIf both `headerTitle` and `headerRenderer` are defined, the title\nand the elements created by the renderer will be placed next to\neach other, with the title coming first.\n\nWhen `headerTitle` is set, the attribute `has-title` is set on the dialog.",
|
|
1217
|
+
"fieldName": "headerTitle"
|
|
1218
|
+
},
|
|
1219
|
+
{
|
|
1220
|
+
"name": "renderer",
|
|
1221
|
+
"type": {
|
|
1222
|
+
"text": "DialogRenderer | undefined"
|
|
1223
|
+
},
|
|
1224
|
+
"description": "Custom function for rendering the content of the dialog.\nReceives two arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `dialog` The reference to the `<vaadin-dialog>` element.",
|
|
1225
|
+
"fieldName": "renderer"
|
|
1226
|
+
}
|
|
1227
|
+
],
|
|
1228
|
+
"parameters": [
|
|
1229
|
+
{
|
|
1230
|
+
"name": "superClass"
|
|
1231
|
+
}
|
|
1232
|
+
]
|
|
1233
|
+
}
|
|
1234
|
+
],
|
|
1235
|
+
"exports": [
|
|
1236
|
+
{
|
|
1237
|
+
"kind": "js",
|
|
1238
|
+
"name": "DialogRendererMixin",
|
|
1239
|
+
"declaration": {
|
|
1240
|
+
"name": "DialogRendererMixin",
|
|
1241
|
+
"module": "src/vaadin-dialog-renderer-mixin.js"
|
|
1242
|
+
}
|
|
1243
|
+
}
|
|
1244
|
+
]
|
|
1245
|
+
},
|
|
1246
|
+
{
|
|
1247
|
+
"kind": "javascript-module",
|
|
1248
|
+
"path": "src/vaadin-dialog-resizable-mixin.js",
|
|
1249
|
+
"declarations": [
|
|
1250
|
+
{
|
|
1251
|
+
"kind": "mixin",
|
|
1252
|
+
"description": "",
|
|
1253
|
+
"name": "DialogResizableMixin",
|
|
1254
|
+
"members": [
|
|
1255
|
+
{
|
|
1256
|
+
"kind": "field",
|
|
1257
|
+
"name": "resizable",
|
|
1258
|
+
"privacy": "public",
|
|
1259
|
+
"type": {
|
|
1260
|
+
"text": "boolean"
|
|
1261
|
+
},
|
|
1262
|
+
"description": "Set to true to enable resizing the dialog by dragging the corners and edges.",
|
|
1263
|
+
"attribute": "resizable"
|
|
1264
|
+
}
|
|
1265
|
+
],
|
|
1266
|
+
"events": [
|
|
1267
|
+
{
|
|
1268
|
+
"name": "resize",
|
|
1269
|
+
"type": {
|
|
1270
|
+
"text": "CustomEvent"
|
|
1271
|
+
}
|
|
1272
|
+
},
|
|
1273
|
+
{
|
|
1274
|
+
"name": "resize-start",
|
|
1275
|
+
"type": {
|
|
1276
|
+
"text": "CustomEvent"
|
|
1277
|
+
}
|
|
1278
|
+
}
|
|
1279
|
+
],
|
|
1280
|
+
"attributes": [
|
|
1281
|
+
{
|
|
1282
|
+
"name": "resizable",
|
|
1283
|
+
"type": {
|
|
1284
|
+
"text": "boolean"
|
|
1285
|
+
},
|
|
1286
|
+
"description": "Set to true to enable resizing the dialog by dragging the corners and edges.",
|
|
1287
|
+
"fieldName": "resizable"
|
|
1288
|
+
}
|
|
1289
|
+
],
|
|
1290
|
+
"parameters": [
|
|
1291
|
+
{
|
|
1292
|
+
"name": "superClass"
|
|
1293
|
+
}
|
|
1294
|
+
]
|
|
1295
|
+
}
|
|
1296
|
+
],
|
|
1297
|
+
"exports": [
|
|
1298
|
+
{
|
|
1299
|
+
"kind": "js",
|
|
1300
|
+
"name": "DialogResizableMixin",
|
|
1301
|
+
"declaration": {
|
|
1302
|
+
"name": "DialogResizableMixin",
|
|
1303
|
+
"module": "src/vaadin-dialog-resizable-mixin.js"
|
|
1304
|
+
}
|
|
1305
|
+
}
|
|
1306
|
+
]
|
|
1307
|
+
},
|
|
1308
|
+
{
|
|
1309
|
+
"kind": "javascript-module",
|
|
1310
|
+
"path": "src/vaadin-dialog-size-mixin.js",
|
|
1311
|
+
"declarations": [
|
|
1312
|
+
{
|
|
1313
|
+
"kind": "mixin",
|
|
1314
|
+
"description": "",
|
|
1315
|
+
"name": "DialogSizeMixin",
|
|
1316
|
+
"members": [
|
|
1317
|
+
{
|
|
1318
|
+
"kind": "field",
|
|
1319
|
+
"name": "height",
|
|
1320
|
+
"privacy": "public",
|
|
1321
|
+
"type": {
|
|
1322
|
+
"text": "string"
|
|
1323
|
+
},
|
|
1324
|
+
"description": "Set the height of the dialog.\nIf a unitless number is provided, pixels are assumed.",
|
|
1325
|
+
"attribute": "height"
|
|
1326
|
+
},
|
|
1327
|
+
{
|
|
1328
|
+
"kind": "field",
|
|
1329
|
+
"name": "width",
|
|
1330
|
+
"privacy": "public",
|
|
1331
|
+
"type": {
|
|
1332
|
+
"text": "string"
|
|
1333
|
+
},
|
|
1334
|
+
"description": "Set the width of the dialog.\nIf a unitless number is provided, pixels are assumed.",
|
|
1335
|
+
"attribute": "width"
|
|
1336
|
+
}
|
|
1337
|
+
],
|
|
1338
|
+
"attributes": [
|
|
1339
|
+
{
|
|
1340
|
+
"name": "height",
|
|
1341
|
+
"type": {
|
|
1342
|
+
"text": "string"
|
|
1343
|
+
},
|
|
1344
|
+
"description": "Set the height of the dialog.\nIf a unitless number is provided, pixels are assumed.",
|
|
1345
|
+
"fieldName": "height"
|
|
1346
|
+
},
|
|
1347
|
+
{
|
|
1348
|
+
"name": "width",
|
|
1349
|
+
"type": {
|
|
1350
|
+
"text": "string"
|
|
1351
|
+
},
|
|
1352
|
+
"description": "Set the width of the dialog.\nIf a unitless number is provided, pixels are assumed.",
|
|
1353
|
+
"fieldName": "width"
|
|
1354
|
+
}
|
|
1355
|
+
],
|
|
1356
|
+
"parameters": [
|
|
1357
|
+
{
|
|
1358
|
+
"name": "superClass"
|
|
1359
|
+
}
|
|
1360
|
+
]
|
|
1361
|
+
}
|
|
1362
|
+
],
|
|
1363
|
+
"exports": [
|
|
1364
|
+
{
|
|
1365
|
+
"kind": "js",
|
|
1366
|
+
"name": "DialogSizeMixin",
|
|
1367
|
+
"declaration": {
|
|
1368
|
+
"name": "DialogSizeMixin",
|
|
1369
|
+
"module": "src/vaadin-dialog-size-mixin.js"
|
|
1370
|
+
}
|
|
1371
|
+
}
|
|
1372
|
+
]
|
|
1373
|
+
},
|
|
1374
|
+
{
|
|
1375
|
+
"kind": "javascript-module",
|
|
1376
|
+
"path": "src/vaadin-dialog-utils.js",
|
|
1377
|
+
"declarations": [
|
|
1378
|
+
{
|
|
1379
|
+
"kind": "function",
|
|
1380
|
+
"name": "getMouseOrFirstTouchEvent",
|
|
1381
|
+
"parameters": [
|
|
1382
|
+
{
|
|
1383
|
+
"name": "e",
|
|
1384
|
+
"type": {
|
|
1385
|
+
"text": "!MouseEvent | !TouchEvent"
|
|
1386
|
+
}
|
|
1387
|
+
}
|
|
1388
|
+
],
|
|
1389
|
+
"description": "Checks if the argument is a touch event and if so, returns a first touch.\nOtherwise, if the mouse event was passed, returns it as is.",
|
|
1390
|
+
"return": {
|
|
1391
|
+
"type": {
|
|
1392
|
+
"text": "!MouseEvent | !Touch"
|
|
1393
|
+
}
|
|
1394
|
+
},
|
|
1395
|
+
"privacy": "protected"
|
|
1396
|
+
},
|
|
1397
|
+
{
|
|
1398
|
+
"kind": "function",
|
|
1399
|
+
"name": "eventInWindow",
|
|
1400
|
+
"parameters": [
|
|
1401
|
+
{
|
|
1402
|
+
"name": "e",
|
|
1403
|
+
"type": {
|
|
1404
|
+
"text": "!MouseEvent | !TouchEvent"
|
|
1405
|
+
}
|
|
1406
|
+
}
|
|
1407
|
+
],
|
|
1408
|
+
"description": "Checks whether a mouse or touch event is in window.",
|
|
1409
|
+
"return": {
|
|
1410
|
+
"type": {
|
|
1411
|
+
"text": "boolean"
|
|
1412
|
+
}
|
|
1413
|
+
},
|
|
1414
|
+
"privacy": "protected"
|
|
1415
|
+
}
|
|
1416
|
+
],
|
|
1417
|
+
"exports": [
|
|
1418
|
+
{
|
|
1419
|
+
"kind": "js",
|
|
1420
|
+
"name": "getMouseOrFirstTouchEvent",
|
|
1421
|
+
"declaration": {
|
|
1422
|
+
"name": "getMouseOrFirstTouchEvent",
|
|
1423
|
+
"module": "src/vaadin-dialog-utils.js"
|
|
1424
|
+
}
|
|
1425
|
+
},
|
|
1426
|
+
{
|
|
1427
|
+
"kind": "js",
|
|
1428
|
+
"name": "eventInWindow",
|
|
1429
|
+
"declaration": {
|
|
1430
|
+
"name": "eventInWindow",
|
|
1431
|
+
"module": "src/vaadin-dialog-utils.js"
|
|
1432
|
+
}
|
|
1433
|
+
}
|
|
1434
|
+
]
|
|
1435
|
+
},
|
|
1436
|
+
{
|
|
1437
|
+
"kind": "javascript-module",
|
|
1438
|
+
"path": "src/vaadin-dialog.js",
|
|
1439
|
+
"declarations": [
|
|
1440
|
+
{
|
|
1441
|
+
"kind": "class",
|
|
1442
|
+
"description": "`<vaadin-dialog>` is a Web Component for creating customized modal dialogs.\n\n### Rendering\n\nThe content of the dialog can be populated by using the renderer callback function.\n\nThe renderer function provides `root`, `dialog` arguments.\nGenerate DOM content, append it to the `root` element and control the state\nof the host element by accessing `dialog`. Before generating new content,\nusers are able to check if there is already content in `root` for reusing it.\n\n```html\n<vaadin-dialog id=\"dialog\"></vaadin-dialog>\n```\n```js\nconst dialog = document.querySelector('#dialog');\ndialog.renderer = function(root, dialog) {\n root.textContent = \"Sample dialog\";\n};\n```\n\nRenderer is called on the opening of the dialog.\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` | The overlay container\n`content` | The overlay content\n`header` | Element wrapping title and header content\n`header-content` | Element wrapping the header content slot\n`title` | Element wrapping the title slot\n`footer` | Element wrapping the footer slot\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n-----------------|--------------------------------------------\n`has-title` | Set when the element has a title\n`has-header` | Set when the element has header renderer\n`has-footer` | Set when the element has footer renderer\n`overflow` | Set to `top`, `bottom`, none or both\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:----------------------------------------|\n|`--vaadin-dialog-background` |\n|`--vaadin-dialog-border-color` |\n|`--vaadin-dialog-border-radius` |\n|`--vaadin-dialog-border-width` |\n|`--vaadin-dialog-max-width` |\n|`--vaadin-dialog-min-width` |\n|`--vaadin-dialog-padding` |\n|`--vaadin-dialog-shadow` |\n|`--vaadin-dialog-title-color` |\n|`--vaadin-dialog-title-font-size` |\n|`--vaadin-dialog-title-font-weight` |\n|`--vaadin-dialog-title-line-height` |\n|`--vaadin-overlay-backdrop-background` |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
1443
|
+
"name": "Dialog",
|
|
1444
|
+
"members": [
|
|
1445
|
+
{
|
|
1446
|
+
"kind": "field",
|
|
1447
|
+
"name": "draggable",
|
|
1448
|
+
"privacy": "public",
|
|
1449
|
+
"type": {
|
|
1450
|
+
"text": "boolean"
|
|
1451
|
+
},
|
|
1452
|
+
"description": "Set to true to enable repositioning the dialog by clicking and dragging.\n\nBy default, only the overlay area can be used to drag the element. But,\na child element can be marked as a draggable area by adding a\n\"`draggable`\" class to it, this will by default make all of its children draggable also.\nIf you want a child element to be draggable\nbut still have its children non-draggable (by default), mark it with\n\"`draggable-leaf-only`\" class name.",
|
|
1453
|
+
"attribute": "draggable",
|
|
1454
|
+
"inheritedFrom": {
|
|
1455
|
+
"name": "DialogDraggableMixin",
|
|
1456
|
+
"module": "src/vaadin-dialog-draggable-mixin.js"
|
|
1457
|
+
}
|
|
1458
|
+
},
|
|
1459
|
+
{
|
|
1460
|
+
"kind": "field",
|
|
1461
|
+
"name": "footerRenderer",
|
|
1462
|
+
"privacy": "public",
|
|
1463
|
+
"type": {
|
|
1464
|
+
"text": "DialogRenderer | undefined"
|
|
1465
|
+
},
|
|
1466
|
+
"description": "Custom function for rendering the dialog footer.\nReceives two arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `dialog` The reference to the `<vaadin-dialog>` element.\n\nWhen `footerRenderer` is set, the attribute `has-footer` is set on the dialog.",
|
|
1467
|
+
"attribute": "footer-renderer",
|
|
1468
|
+
"inheritedFrom": {
|
|
1469
|
+
"name": "DialogRendererMixin",
|
|
1470
|
+
"module": "src/vaadin-dialog-renderer-mixin.js"
|
|
1471
|
+
}
|
|
1472
|
+
},
|
|
1473
|
+
{
|
|
1474
|
+
"kind": "field",
|
|
1475
|
+
"name": "headerRenderer",
|
|
1476
|
+
"privacy": "public",
|
|
1477
|
+
"type": {
|
|
1478
|
+
"text": "DialogRenderer | undefined"
|
|
1479
|
+
},
|
|
1480
|
+
"description": "Custom function for rendering the dialog header.\nReceives two arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `dialog` The reference to the `<vaadin-dialog>` element.\n\nIf both `headerTitle` and `headerRenderer` are defined, the title\nand the elements created by the renderer will be placed next to\neach other, with the title coming first.\n\nWhen `headerRenderer` is set, the attribute `has-header` is set on the dialog.",
|
|
1481
|
+
"attribute": "header-renderer",
|
|
1482
|
+
"inheritedFrom": {
|
|
1483
|
+
"name": "DialogRendererMixin",
|
|
1484
|
+
"module": "src/vaadin-dialog-renderer-mixin.js"
|
|
1485
|
+
}
|
|
1486
|
+
},
|
|
1487
|
+
{
|
|
1488
|
+
"kind": "field",
|
|
1489
|
+
"name": "headerTitle",
|
|
1490
|
+
"privacy": "public",
|
|
1491
|
+
"description": "String used for rendering a dialog title.\n\nIf both `headerTitle` and `headerRenderer` are defined, the title\nand the elements created by the renderer will be placed next to\neach other, with the title coming first.\n\nWhen `headerTitle` is set, the attribute `has-title` is set on the dialog.",
|
|
1492
|
+
"attribute": "header-title",
|
|
1493
|
+
"inheritedFrom": {
|
|
1494
|
+
"name": "DialogRendererMixin",
|
|
1495
|
+
"module": "src/vaadin-dialog-renderer-mixin.js"
|
|
1496
|
+
}
|
|
1497
|
+
},
|
|
1498
|
+
{
|
|
1499
|
+
"kind": "field",
|
|
1500
|
+
"name": "height",
|
|
1501
|
+
"privacy": "public",
|
|
1502
|
+
"type": {
|
|
1503
|
+
"text": "string"
|
|
1504
|
+
},
|
|
1505
|
+
"description": "Set the height of the dialog.\nIf a unitless number is provided, pixels are assumed.",
|
|
1506
|
+
"attribute": "height",
|
|
1507
|
+
"inheritedFrom": {
|
|
1508
|
+
"name": "DialogSizeMixin",
|
|
1509
|
+
"module": "src/vaadin-dialog-size-mixin.js"
|
|
1510
|
+
}
|
|
1511
|
+
},
|
|
1512
|
+
{
|
|
1513
|
+
"kind": "field",
|
|
1514
|
+
"name": "keepInViewport",
|
|
1515
|
+
"privacy": "public",
|
|
1516
|
+
"type": {
|
|
1517
|
+
"text": "boolean"
|
|
1518
|
+
},
|
|
1519
|
+
"description": "Set to true to prevent dragging the dialog outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible during dragging.\nThe dialog may still become partially hidden when the viewport is resized.",
|
|
1520
|
+
"attribute": "keep-in-viewport",
|
|
1521
|
+
"inheritedFrom": {
|
|
1522
|
+
"name": "DialogDraggableMixin",
|
|
1523
|
+
"module": "src/vaadin-dialog-draggable-mixin.js"
|
|
1524
|
+
}
|
|
1525
|
+
},
|
|
1526
|
+
{
|
|
1527
|
+
"kind": "field",
|
|
1528
|
+
"name": "left",
|
|
1529
|
+
"privacy": "public",
|
|
1530
|
+
"type": {
|
|
1531
|
+
"text": "string"
|
|
1532
|
+
},
|
|
1533
|
+
"description": "Set the distance of the dialog from the left of the viewport.\nIf a unitless number is provided, pixels are assumed.\n\nNote that the dialog uses an internal container that has some\nadditional spacing, which can be overridden by the theme.",
|
|
1534
|
+
"attribute": "left",
|
|
1535
|
+
"inheritedFrom": {
|
|
1536
|
+
"name": "DialogBaseMixin",
|
|
1537
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1538
|
+
}
|
|
1539
|
+
},
|
|
1540
|
+
{
|
|
1541
|
+
"kind": "field",
|
|
1542
|
+
"name": "modeless",
|
|
1543
|
+
"privacy": "public",
|
|
1544
|
+
"type": {
|
|
1545
|
+
"text": "boolean"
|
|
1546
|
+
},
|
|
1547
|
+
"description": "Set to true to remove backdrop and allow click events on background elements.",
|
|
1548
|
+
"attribute": "modeless",
|
|
1549
|
+
"inheritedFrom": {
|
|
1550
|
+
"name": "DialogBaseMixin",
|
|
1551
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1552
|
+
}
|
|
1553
|
+
},
|
|
1554
|
+
{
|
|
1555
|
+
"kind": "field",
|
|
1556
|
+
"name": "noCloseOnEsc",
|
|
1557
|
+
"privacy": "public",
|
|
1558
|
+
"type": {
|
|
1559
|
+
"text": "boolean"
|
|
1560
|
+
},
|
|
1561
|
+
"description": "Set to true to disable closing dialog on Escape press",
|
|
1562
|
+
"attribute": "no-close-on-esc",
|
|
1563
|
+
"inheritedFrom": {
|
|
1564
|
+
"name": "DialogBaseMixin",
|
|
1565
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1566
|
+
}
|
|
1567
|
+
},
|
|
1568
|
+
{
|
|
1569
|
+
"kind": "field",
|
|
1570
|
+
"name": "noCloseOnOutsideClick",
|
|
1571
|
+
"privacy": "public",
|
|
1572
|
+
"type": {
|
|
1573
|
+
"text": "boolean"
|
|
1574
|
+
},
|
|
1575
|
+
"description": "Set to true to disable closing dialog on outside click",
|
|
1576
|
+
"attribute": "no-close-on-outside-click",
|
|
1577
|
+
"inheritedFrom": {
|
|
1578
|
+
"name": "DialogBaseMixin",
|
|
1579
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1580
|
+
}
|
|
1581
|
+
},
|
|
1582
|
+
{
|
|
1583
|
+
"kind": "field",
|
|
1584
|
+
"name": "noFocusTrap",
|
|
1585
|
+
"privacy": "public",
|
|
1586
|
+
"type": {
|
|
1587
|
+
"text": "boolean"
|
|
1588
|
+
},
|
|
1589
|
+
"description": "Set to true to disable focus trapping.",
|
|
1590
|
+
"attribute": "no-focus-trap",
|
|
1591
|
+
"inheritedFrom": {
|
|
1592
|
+
"name": "DialogBaseMixin",
|
|
1593
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1594
|
+
}
|
|
1595
|
+
},
|
|
1596
|
+
{
|
|
1597
|
+
"kind": "field",
|
|
1598
|
+
"name": "opened",
|
|
1599
|
+
"privacy": "public",
|
|
1600
|
+
"type": {
|
|
1601
|
+
"text": "boolean"
|
|
1602
|
+
},
|
|
1603
|
+
"description": "True if the dialog is visible and available for interaction.",
|
|
1604
|
+
"attribute": "opened",
|
|
1605
|
+
"inheritedFrom": {
|
|
1606
|
+
"name": "DialogBaseMixin",
|
|
1607
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1608
|
+
}
|
|
1609
|
+
},
|
|
1610
|
+
{
|
|
1611
|
+
"kind": "field",
|
|
1612
|
+
"name": "overlayRole",
|
|
1613
|
+
"privacy": "public",
|
|
1614
|
+
"type": {
|
|
1615
|
+
"text": "string"
|
|
1616
|
+
},
|
|
1617
|
+
"description": "The `role` attribute value to be set on the dialog. Defaults to \"dialog\".",
|
|
1618
|
+
"deprecated": "Use standard `role` attribute on the dialog instead",
|
|
1619
|
+
"attribute": "overlay-role",
|
|
1620
|
+
"inheritedFrom": {
|
|
1621
|
+
"name": "DialogBaseMixin",
|
|
1622
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1623
|
+
}
|
|
1624
|
+
},
|
|
1625
|
+
{
|
|
1626
|
+
"kind": "field",
|
|
1627
|
+
"name": "renderer",
|
|
1628
|
+
"privacy": "public",
|
|
1629
|
+
"type": {
|
|
1630
|
+
"text": "DialogRenderer | undefined"
|
|
1631
|
+
},
|
|
1632
|
+
"description": "Custom function for rendering the content of the dialog.\nReceives two arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `dialog` The reference to the `<vaadin-dialog>` element.",
|
|
1633
|
+
"attribute": "renderer",
|
|
1634
|
+
"inheritedFrom": {
|
|
1635
|
+
"name": "DialogRendererMixin",
|
|
1636
|
+
"module": "src/vaadin-dialog-renderer-mixin.js"
|
|
1637
|
+
}
|
|
1638
|
+
},
|
|
1639
|
+
{
|
|
1640
|
+
"kind": "method",
|
|
1641
|
+
"name": "requestContentUpdate",
|
|
1642
|
+
"description": "Requests an update for the content of the dialog.\nWhile performing the update, it invokes the renderer passed in the `renderer` property,\nas well as `headerRender` and `footerRenderer` properties, if these are defined.\n\nIt is not guaranteed that the update happens immediately (synchronously) after it is requested.",
|
|
1643
|
+
"inheritedFrom": {
|
|
1644
|
+
"name": "DialogRendererMixin",
|
|
1645
|
+
"module": "src/vaadin-dialog-renderer-mixin.js"
|
|
1646
|
+
}
|
|
1647
|
+
},
|
|
1648
|
+
{
|
|
1649
|
+
"kind": "field",
|
|
1650
|
+
"name": "resizable",
|
|
1651
|
+
"privacy": "public",
|
|
1652
|
+
"type": {
|
|
1653
|
+
"text": "boolean"
|
|
1654
|
+
},
|
|
1655
|
+
"description": "Set to true to enable resizing the dialog by dragging the corners and edges.",
|
|
1656
|
+
"attribute": "resizable",
|
|
1657
|
+
"inheritedFrom": {
|
|
1658
|
+
"name": "DialogResizableMixin",
|
|
1659
|
+
"module": "src/vaadin-dialog-resizable-mixin.js"
|
|
1660
|
+
}
|
|
1661
|
+
},
|
|
1662
|
+
{
|
|
1663
|
+
"kind": "field",
|
|
1664
|
+
"name": "top",
|
|
1665
|
+
"privacy": "public",
|
|
1666
|
+
"type": {
|
|
1667
|
+
"text": "string"
|
|
1668
|
+
},
|
|
1669
|
+
"description": "Set the distance of the dialog from the top of the viewport.\nIf a unitless number is provided, pixels are assumed.\n\nNote that the dialog uses an internal container that has some\nadditional spacing, which can be overridden by the theme.",
|
|
1670
|
+
"attribute": "top",
|
|
1671
|
+
"inheritedFrom": {
|
|
1672
|
+
"name": "DialogBaseMixin",
|
|
1673
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1674
|
+
}
|
|
1675
|
+
},
|
|
1676
|
+
{
|
|
1677
|
+
"kind": "field",
|
|
1678
|
+
"name": "width",
|
|
1679
|
+
"privacy": "public",
|
|
1680
|
+
"type": {
|
|
1681
|
+
"text": "string"
|
|
1682
|
+
},
|
|
1683
|
+
"description": "Set the width of the dialog.\nIf a unitless number is provided, pixels are assumed.",
|
|
1684
|
+
"attribute": "width",
|
|
1685
|
+
"inheritedFrom": {
|
|
1686
|
+
"name": "DialogSizeMixin",
|
|
1687
|
+
"module": "src/vaadin-dialog-size-mixin.js"
|
|
1688
|
+
}
|
|
1689
|
+
}
|
|
1690
|
+
],
|
|
1691
|
+
"events": [
|
|
1692
|
+
{
|
|
1693
|
+
"name": "closed",
|
|
1694
|
+
"type": {
|
|
1695
|
+
"text": "CustomEvent"
|
|
1696
|
+
},
|
|
1697
|
+
"description": "Fired when the dialog is closed.",
|
|
1698
|
+
"inheritedFrom": {
|
|
1699
|
+
"name": "DialogBaseMixin",
|
|
1700
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1701
|
+
}
|
|
1702
|
+
},
|
|
1703
|
+
{
|
|
1704
|
+
"name": "drag-start",
|
|
1705
|
+
"type": {
|
|
1706
|
+
"text": "CustomEvent"
|
|
1707
|
+
},
|
|
1708
|
+
"description": "Fired when the dialog drag is started.",
|
|
1709
|
+
"inheritedFrom": {
|
|
1710
|
+
"name": "DialogDraggableMixin",
|
|
1711
|
+
"module": "src/vaadin-dialog-draggable-mixin.js"
|
|
1712
|
+
}
|
|
1713
|
+
},
|
|
1714
|
+
{
|
|
1715
|
+
"name": "dragged",
|
|
1716
|
+
"type": {
|
|
1717
|
+
"text": "CustomEvent"
|
|
1718
|
+
},
|
|
1719
|
+
"description": "Fired when the dialog drag is finished.",
|
|
1720
|
+
"inheritedFrom": {
|
|
1721
|
+
"name": "DialogDraggableMixin",
|
|
1722
|
+
"module": "src/vaadin-dialog-draggable-mixin.js"
|
|
1723
|
+
}
|
|
1724
|
+
},
|
|
1725
|
+
{
|
|
1726
|
+
"type": {
|
|
1727
|
+
"text": "CustomEvent"
|
|
1728
|
+
},
|
|
1729
|
+
"description": "Fired when the `opened` property changes.",
|
|
1730
|
+
"name": "opened-changed"
|
|
1731
|
+
},
|
|
1732
|
+
{
|
|
1733
|
+
"name": "resize",
|
|
1734
|
+
"type": {
|
|
1735
|
+
"text": "CustomEvent"
|
|
1736
|
+
},
|
|
1737
|
+
"description": "Fired when the dialog resize is finished.",
|
|
1738
|
+
"inheritedFrom": {
|
|
1739
|
+
"name": "DialogResizableMixin",
|
|
1740
|
+
"module": "src/vaadin-dialog-resizable-mixin.js"
|
|
1741
|
+
}
|
|
1742
|
+
},
|
|
1743
|
+
{
|
|
1744
|
+
"name": "resize-start",
|
|
1745
|
+
"type": {
|
|
1746
|
+
"text": "CustomEvent"
|
|
1747
|
+
},
|
|
1748
|
+
"description": "Fired when the dialog resize is started.",
|
|
1749
|
+
"inheritedFrom": {
|
|
1750
|
+
"name": "DialogResizableMixin",
|
|
1751
|
+
"module": "src/vaadin-dialog-resizable-mixin.js"
|
|
1752
|
+
}
|
|
1753
|
+
}
|
|
1754
|
+
],
|
|
1755
|
+
"mixins": [
|
|
1756
|
+
{
|
|
1757
|
+
"name": "DialogSizeMixin",
|
|
1758
|
+
"module": "src/vaadin-dialog-size-mixin.js"
|
|
1759
|
+
},
|
|
1760
|
+
{
|
|
1761
|
+
"name": "DialogDraggableMixin",
|
|
1762
|
+
"module": "src/vaadin-dialog-draggable-mixin.js"
|
|
1763
|
+
},
|
|
1764
|
+
{
|
|
1765
|
+
"name": "DialogResizableMixin",
|
|
1766
|
+
"module": "src/vaadin-dialog-resizable-mixin.js"
|
|
1767
|
+
},
|
|
1768
|
+
{
|
|
1769
|
+
"name": "DialogRendererMixin",
|
|
1770
|
+
"module": "src/vaadin-dialog-renderer-mixin.js"
|
|
1771
|
+
},
|
|
1772
|
+
{
|
|
1773
|
+
"name": "DialogBaseMixin",
|
|
1774
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1775
|
+
},
|
|
1776
|
+
{
|
|
1777
|
+
"name": "ThemePropertyMixin",
|
|
1778
|
+
"package": "@vaadin/vaadin-themable-mixin/vaadin-theme-property-mixin.js"
|
|
1779
|
+
},
|
|
1780
|
+
{
|
|
1781
|
+
"name": "ElementMixin",
|
|
1782
|
+
"package": "@vaadin/component-base/src/element-mixin.js"
|
|
1783
|
+
},
|
|
1784
|
+
{
|
|
1785
|
+
"name": "PolylitMixin",
|
|
1786
|
+
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
1787
|
+
}
|
|
1788
|
+
],
|
|
1789
|
+
"superclass": {
|
|
1790
|
+
"name": "LitElement",
|
|
1791
|
+
"package": "lit"
|
|
1792
|
+
},
|
|
1793
|
+
"tagName": "vaadin-dialog",
|
|
1794
|
+
"customElement": true,
|
|
1795
|
+
"attributes": [
|
|
1796
|
+
{
|
|
1797
|
+
"name": "draggable",
|
|
1798
|
+
"type": {
|
|
1799
|
+
"text": "boolean"
|
|
1800
|
+
},
|
|
1801
|
+
"description": "Set to true to enable repositioning the dialog by clicking and dragging.\n\nBy default, only the overlay area can be used to drag the element. But,\na child element can be marked as a draggable area by adding a\n\"`draggable`\" class to it, this will by default make all of its children draggable also.\nIf you want a child element to be draggable\nbut still have its children non-draggable (by default), mark it with\n\"`draggable-leaf-only`\" class name.",
|
|
1802
|
+
"fieldName": "draggable",
|
|
1803
|
+
"inheritedFrom": {
|
|
1804
|
+
"name": "DialogDraggableMixin",
|
|
1805
|
+
"module": "src/vaadin-dialog-draggable-mixin.js"
|
|
1806
|
+
}
|
|
1807
|
+
},
|
|
1808
|
+
{
|
|
1809
|
+
"name": "footer-renderer",
|
|
1810
|
+
"type": {
|
|
1811
|
+
"text": "DialogRenderer | undefined"
|
|
1812
|
+
},
|
|
1813
|
+
"description": "Custom function for rendering the dialog footer.\nReceives two arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `dialog` The reference to the `<vaadin-dialog>` element.\n\nWhen `footerRenderer` is set, the attribute `has-footer` is set on the dialog.",
|
|
1814
|
+
"fieldName": "footerRenderer",
|
|
1815
|
+
"inheritedFrom": {
|
|
1816
|
+
"name": "DialogRendererMixin",
|
|
1817
|
+
"module": "src/vaadin-dialog-renderer-mixin.js"
|
|
1818
|
+
}
|
|
1819
|
+
},
|
|
1820
|
+
{
|
|
1821
|
+
"name": "header-renderer",
|
|
1822
|
+
"type": {
|
|
1823
|
+
"text": "DialogRenderer | undefined"
|
|
1824
|
+
},
|
|
1825
|
+
"description": "Custom function for rendering the dialog header.\nReceives two arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `dialog` The reference to the `<vaadin-dialog>` element.\n\nIf both `headerTitle` and `headerRenderer` are defined, the title\nand the elements created by the renderer will be placed next to\neach other, with the title coming first.\n\nWhen `headerRenderer` is set, the attribute `has-header` is set on the dialog.",
|
|
1826
|
+
"fieldName": "headerRenderer",
|
|
1827
|
+
"inheritedFrom": {
|
|
1828
|
+
"name": "DialogRendererMixin",
|
|
1829
|
+
"module": "src/vaadin-dialog-renderer-mixin.js"
|
|
1830
|
+
}
|
|
1831
|
+
},
|
|
1832
|
+
{
|
|
1833
|
+
"name": "header-title",
|
|
1834
|
+
"description": "String used for rendering a dialog title.\n\nIf both `headerTitle` and `headerRenderer` are defined, the title\nand the elements created by the renderer will be placed next to\neach other, with the title coming first.\n\nWhen `headerTitle` is set, the attribute `has-title` is set on the dialog.",
|
|
1835
|
+
"fieldName": "headerTitle",
|
|
1836
|
+
"inheritedFrom": {
|
|
1837
|
+
"name": "DialogRendererMixin",
|
|
1838
|
+
"module": "src/vaadin-dialog-renderer-mixin.js"
|
|
1839
|
+
}
|
|
1840
|
+
},
|
|
1841
|
+
{
|
|
1842
|
+
"name": "height",
|
|
1843
|
+
"type": {
|
|
1844
|
+
"text": "string"
|
|
1845
|
+
},
|
|
1846
|
+
"description": "Set the height of the dialog.\nIf a unitless number is provided, pixels are assumed.",
|
|
1847
|
+
"fieldName": "height",
|
|
1848
|
+
"inheritedFrom": {
|
|
1849
|
+
"name": "DialogSizeMixin",
|
|
1850
|
+
"module": "src/vaadin-dialog-size-mixin.js"
|
|
1851
|
+
}
|
|
1852
|
+
},
|
|
1853
|
+
{
|
|
1854
|
+
"name": "keep-in-viewport",
|
|
1855
|
+
"type": {
|
|
1856
|
+
"text": "boolean"
|
|
1857
|
+
},
|
|
1858
|
+
"description": "Set to true to prevent dragging the dialog outside the viewport bounds.\nWhen enabled, all four edges of the dialog will remain visible during dragging.\nThe dialog may still become partially hidden when the viewport is resized.",
|
|
1859
|
+
"fieldName": "keepInViewport",
|
|
1860
|
+
"inheritedFrom": {
|
|
1861
|
+
"name": "DialogDraggableMixin",
|
|
1862
|
+
"module": "src/vaadin-dialog-draggable-mixin.js"
|
|
1863
|
+
}
|
|
1864
|
+
},
|
|
1865
|
+
{
|
|
1866
|
+
"name": "left",
|
|
1867
|
+
"type": {
|
|
1868
|
+
"text": "string"
|
|
1869
|
+
},
|
|
1870
|
+
"description": "Set the distance of the dialog from the left of the viewport.\nIf a unitless number is provided, pixels are assumed.\n\nNote that the dialog uses an internal container that has some\nadditional spacing, which can be overridden by the theme.",
|
|
1871
|
+
"fieldName": "left",
|
|
1872
|
+
"inheritedFrom": {
|
|
1873
|
+
"name": "DialogBaseMixin",
|
|
1874
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1875
|
+
}
|
|
1876
|
+
},
|
|
1877
|
+
{
|
|
1878
|
+
"name": "modeless",
|
|
1879
|
+
"type": {
|
|
1880
|
+
"text": "boolean"
|
|
1881
|
+
},
|
|
1882
|
+
"description": "Set to true to remove backdrop and allow click events on background elements.",
|
|
1883
|
+
"fieldName": "modeless",
|
|
1884
|
+
"inheritedFrom": {
|
|
1885
|
+
"name": "DialogBaseMixin",
|
|
1886
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1887
|
+
}
|
|
1888
|
+
},
|
|
1889
|
+
{
|
|
1890
|
+
"name": "no-close-on-esc",
|
|
1891
|
+
"type": {
|
|
1892
|
+
"text": "boolean"
|
|
1893
|
+
},
|
|
1894
|
+
"description": "Set to true to disable closing dialog on Escape press",
|
|
1895
|
+
"fieldName": "noCloseOnEsc",
|
|
1896
|
+
"inheritedFrom": {
|
|
1897
|
+
"name": "DialogBaseMixin",
|
|
1898
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1899
|
+
}
|
|
1900
|
+
},
|
|
1901
|
+
{
|
|
1902
|
+
"name": "no-close-on-outside-click",
|
|
1903
|
+
"type": {
|
|
1904
|
+
"text": "boolean"
|
|
1905
|
+
},
|
|
1906
|
+
"description": "Set to true to disable closing dialog on outside click",
|
|
1907
|
+
"fieldName": "noCloseOnOutsideClick",
|
|
1908
|
+
"inheritedFrom": {
|
|
1909
|
+
"name": "DialogBaseMixin",
|
|
1910
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1911
|
+
}
|
|
1912
|
+
},
|
|
1913
|
+
{
|
|
1914
|
+
"name": "no-focus-trap",
|
|
1915
|
+
"type": {
|
|
1916
|
+
"text": "boolean"
|
|
1917
|
+
},
|
|
1918
|
+
"description": "Set to true to disable focus trapping.",
|
|
1919
|
+
"fieldName": "noFocusTrap",
|
|
1920
|
+
"inheritedFrom": {
|
|
1921
|
+
"name": "DialogBaseMixin",
|
|
1922
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1923
|
+
}
|
|
1924
|
+
},
|
|
1925
|
+
{
|
|
1926
|
+
"name": "opened",
|
|
1927
|
+
"type": {
|
|
1928
|
+
"text": "boolean"
|
|
1929
|
+
},
|
|
1930
|
+
"description": "True if the dialog is visible and available for interaction.",
|
|
1931
|
+
"fieldName": "opened",
|
|
1932
|
+
"inheritedFrom": {
|
|
1933
|
+
"name": "DialogBaseMixin",
|
|
1934
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1935
|
+
}
|
|
1936
|
+
},
|
|
1937
|
+
{
|
|
1938
|
+
"name": "overlay-role",
|
|
1939
|
+
"type": {
|
|
1940
|
+
"text": "string"
|
|
1941
|
+
},
|
|
1942
|
+
"description": "The `role` attribute value to be set on the dialog. Defaults to \"dialog\".",
|
|
1943
|
+
"deprecated": "Use standard `role` attribute on the dialog instead",
|
|
1944
|
+
"fieldName": "overlayRole",
|
|
1945
|
+
"inheritedFrom": {
|
|
1946
|
+
"name": "DialogBaseMixin",
|
|
1947
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1948
|
+
}
|
|
1949
|
+
},
|
|
1950
|
+
{
|
|
1951
|
+
"name": "renderer",
|
|
1952
|
+
"type": {
|
|
1953
|
+
"text": "DialogRenderer | undefined"
|
|
1954
|
+
},
|
|
1955
|
+
"description": "Custom function for rendering the content of the dialog.\nReceives two arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `dialog` The reference to the `<vaadin-dialog>` element.",
|
|
1956
|
+
"fieldName": "renderer",
|
|
1957
|
+
"inheritedFrom": {
|
|
1958
|
+
"name": "DialogRendererMixin",
|
|
1959
|
+
"module": "src/vaadin-dialog-renderer-mixin.js"
|
|
1960
|
+
}
|
|
1961
|
+
},
|
|
1962
|
+
{
|
|
1963
|
+
"name": "resizable",
|
|
1964
|
+
"type": {
|
|
1965
|
+
"text": "boolean"
|
|
1966
|
+
},
|
|
1967
|
+
"description": "Set to true to enable resizing the dialog by dragging the corners and edges.",
|
|
1968
|
+
"fieldName": "resizable",
|
|
1969
|
+
"inheritedFrom": {
|
|
1970
|
+
"name": "DialogResizableMixin",
|
|
1971
|
+
"module": "src/vaadin-dialog-resizable-mixin.js"
|
|
1972
|
+
}
|
|
1973
|
+
},
|
|
1974
|
+
{
|
|
1975
|
+
"name": "top",
|
|
1976
|
+
"type": {
|
|
1977
|
+
"text": "string"
|
|
1978
|
+
},
|
|
1979
|
+
"description": "Set the distance of the dialog from the top of the viewport.\nIf a unitless number is provided, pixels are assumed.\n\nNote that the dialog uses an internal container that has some\nadditional spacing, which can be overridden by the theme.",
|
|
1980
|
+
"fieldName": "top",
|
|
1981
|
+
"inheritedFrom": {
|
|
1982
|
+
"name": "DialogBaseMixin",
|
|
1983
|
+
"module": "src/vaadin-dialog-base-mixin.js"
|
|
1984
|
+
}
|
|
1985
|
+
},
|
|
1986
|
+
{
|
|
1987
|
+
"name": "width",
|
|
1988
|
+
"type": {
|
|
1989
|
+
"text": "string"
|
|
1990
|
+
},
|
|
1991
|
+
"description": "Set the width of the dialog.\nIf a unitless number is provided, pixels are assumed.",
|
|
1992
|
+
"fieldName": "width",
|
|
1993
|
+
"inheritedFrom": {
|
|
1994
|
+
"name": "DialogSizeMixin",
|
|
1995
|
+
"module": "src/vaadin-dialog-size-mixin.js"
|
|
1996
|
+
}
|
|
1997
|
+
}
|
|
1998
|
+
]
|
|
1999
|
+
}
|
|
2000
|
+
],
|
|
2001
|
+
"exports": [
|
|
2002
|
+
{
|
|
2003
|
+
"kind": "js",
|
|
2004
|
+
"name": "DialogOverlay",
|
|
2005
|
+
"declaration": {
|
|
2006
|
+
"name": "DialogOverlay",
|
|
2007
|
+
"module": "./vaadin-dialog-overlay.js"
|
|
2008
|
+
}
|
|
2009
|
+
},
|
|
2010
|
+
{
|
|
2011
|
+
"kind": "js",
|
|
2012
|
+
"name": "Dialog",
|
|
2013
|
+
"declaration": {
|
|
2014
|
+
"name": "Dialog",
|
|
2015
|
+
"module": "src/vaadin-dialog.js"
|
|
2016
|
+
}
|
|
2017
|
+
}
|
|
2018
|
+
]
|
|
2019
|
+
}
|
|
2020
|
+
]
|
|
2021
|
+
}
|