@vaadin/dialog 24.2.0-alpha4 → 24.2.0-alpha5
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/package.json +15 -11
- package/src/lit/renderer-directives.d.ts +2 -2
- package/src/vaadin-dialog-base-mixin.d.ts +34 -0
- package/src/vaadin-dialog-base-mixin.js +123 -0
- package/src/vaadin-dialog-draggable-mixin.js +4 -1
- package/src/vaadin-dialog-overlay-mixin.d.ts +56 -0
- package/src/vaadin-dialog-overlay-mixin.js +257 -0
- package/src/vaadin-dialog-overlay.d.ts +5 -27
- package/src/vaadin-dialog-overlay.js +27 -361
- package/src/vaadin-dialog-renderer-mixin.d.ts +68 -0
- package/src/vaadin-dialog-renderer-mixin.js +84 -0
- package/src/vaadin-dialog-resizable-mixin.js +4 -102
- package/src/vaadin-dialog-styles.d.ts +10 -0
- package/src/vaadin-dialog-styles.js +181 -0
- package/src/vaadin-dialog.d.ts +6 -79
- package/src/vaadin-dialog.js +9 -168
- package/theme/lumo/vaadin-dialog-styles.js +2 -0
- package/theme/material/vaadin-dialog-styles.js +2 -0
- package/web-types.json +62 -62
- package/web-types.lit.json +20 -20
package/web-types.json
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/web-types",
|
|
3
3
|
"name": "@vaadin/dialog",
|
|
4
|
-
"version": "24.2.0-
|
|
4
|
+
"version": "24.2.0-alpha5",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
8
8
|
"elements": [
|
|
9
9
|
{
|
|
10
10
|
"name": "vaadin-dialog",
|
|
11
|
-
"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\n`<vaadin-dialog>` uses `<vaadin-dialog-overlay>` internal\nthemable component as the actual visible dialog overlay.\n\nSee [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-
|
|
11
|
+
"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\n`<vaadin-dialog>` uses `<vaadin-dialog-overlay>` internal\nthemable component as the actual visible dialog overlay.\n\nSee [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-alpha5/#/elements/vaadin-overlay) documentation.\nfor `<vaadin-dialog-overlay>` parts.\n\nIn addition to `<vaadin-overlay>` parts, the following parts are available for styling:\n\nPart name | Description\n-----------------|-------------------------------------------\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\nNote: the `theme` attribute value set on `<vaadin-dialog>` is\npropagated to the internal `<vaadin-dialog-overlay>` component.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
12
12
|
"attributes": [
|
|
13
13
|
{
|
|
14
|
-
"name": "
|
|
15
|
-
"description": "
|
|
14
|
+
"name": "opened",
|
|
15
|
+
"description": "True if the overlay is currently displayed.",
|
|
16
16
|
"value": {
|
|
17
17
|
"type": [
|
|
18
18
|
"boolean"
|
|
@@ -20,8 +20,8 @@
|
|
|
20
20
|
}
|
|
21
21
|
},
|
|
22
22
|
{
|
|
23
|
-
"name": "
|
|
24
|
-
"description": "Set to true to
|
|
23
|
+
"name": "no-close-on-outside-click",
|
|
24
|
+
"description": "Set to true to disable closing dialog on outside click",
|
|
25
25
|
"value": {
|
|
26
26
|
"type": [
|
|
27
27
|
"boolean"
|
|
@@ -29,19 +29,17 @@
|
|
|
29
29
|
}
|
|
30
30
|
},
|
|
31
31
|
{
|
|
32
|
-
"name": "
|
|
33
|
-
"description": "
|
|
32
|
+
"name": "no-close-on-esc",
|
|
33
|
+
"description": "Set to true to disable closing dialog on Escape press",
|
|
34
34
|
"value": {
|
|
35
35
|
"type": [
|
|
36
|
-
"
|
|
37
|
-
"null",
|
|
38
|
-
"undefined"
|
|
36
|
+
"boolean"
|
|
39
37
|
]
|
|
40
38
|
}
|
|
41
39
|
},
|
|
42
40
|
{
|
|
43
|
-
"name": "
|
|
44
|
-
"description": "
|
|
41
|
+
"name": "modeless",
|
|
42
|
+
"description": "Set to true to remove backdrop and allow click events on background elements.",
|
|
45
43
|
"value": {
|
|
46
44
|
"type": [
|
|
47
45
|
"boolean"
|
|
@@ -49,8 +47,8 @@
|
|
|
49
47
|
}
|
|
50
48
|
},
|
|
51
49
|
{
|
|
52
|
-
"name": "
|
|
53
|
-
"description": "Set to true to
|
|
50
|
+
"name": "draggable",
|
|
51
|
+
"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.",
|
|
54
52
|
"value": {
|
|
55
53
|
"type": [
|
|
56
54
|
"boolean"
|
|
@@ -58,28 +56,28 @@
|
|
|
58
56
|
}
|
|
59
57
|
},
|
|
60
58
|
{
|
|
61
|
-
"name": "
|
|
62
|
-
"description": "
|
|
59
|
+
"name": "header-title",
|
|
60
|
+
"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 added to the overlay element.",
|
|
63
61
|
"value": {
|
|
64
62
|
"type": [
|
|
65
|
-
"
|
|
63
|
+
"string",
|
|
64
|
+
"null",
|
|
65
|
+
"undefined"
|
|
66
66
|
]
|
|
67
67
|
}
|
|
68
68
|
},
|
|
69
69
|
{
|
|
70
|
-
"name": "
|
|
71
|
-
"description": "Set
|
|
70
|
+
"name": "resizable",
|
|
71
|
+
"description": "Set to true to enable resizing the dialog by dragging the corners and edges.",
|
|
72
72
|
"value": {
|
|
73
73
|
"type": [
|
|
74
|
-
"
|
|
75
|
-
"null",
|
|
76
|
-
"undefined"
|
|
74
|
+
"boolean"
|
|
77
75
|
]
|
|
78
76
|
}
|
|
79
77
|
},
|
|
80
78
|
{
|
|
81
|
-
"name": "
|
|
82
|
-
"description": "
|
|
79
|
+
"name": "overlay-class",
|
|
80
|
+
"description": "A space-delimited list of CSS class names to set on the overlay element.\nThis property does not affect other CSS class names set manually via JS.\n\nNote, if the CSS class name was set with this property, clearing it will\nremove it from the overlay, even if the same class name was also added\nmanually, e.g. by using `classList.add()` in the `renderer` function.",
|
|
83
81
|
"value": {
|
|
84
82
|
"type": [
|
|
85
83
|
"string",
|
|
@@ -89,11 +87,13 @@
|
|
|
89
87
|
}
|
|
90
88
|
},
|
|
91
89
|
{
|
|
92
|
-
"name": "
|
|
93
|
-
"description": "Set
|
|
90
|
+
"name": "aria-label",
|
|
91
|
+
"description": "Set the `aria-label` attribute for assistive technologies like\nscreen readers. An empty string value for this property (the\ndefault) means that the `aria-label` attribute is not present.",
|
|
94
92
|
"value": {
|
|
95
93
|
"type": [
|
|
96
|
-
"
|
|
94
|
+
"string",
|
|
95
|
+
"null",
|
|
96
|
+
"undefined"
|
|
97
97
|
]
|
|
98
98
|
}
|
|
99
99
|
},
|
|
@@ -112,8 +112,8 @@
|
|
|
112
112
|
"js": {
|
|
113
113
|
"properties": [
|
|
114
114
|
{
|
|
115
|
-
"name": "
|
|
116
|
-
"description": "
|
|
115
|
+
"name": "opened",
|
|
116
|
+
"description": "True if the overlay is currently displayed.",
|
|
117
117
|
"value": {
|
|
118
118
|
"type": [
|
|
119
119
|
"boolean"
|
|
@@ -121,8 +121,8 @@
|
|
|
121
121
|
}
|
|
122
122
|
},
|
|
123
123
|
{
|
|
124
|
-
"name": "
|
|
125
|
-
"description": "Set to true to
|
|
124
|
+
"name": "noCloseOnOutsideClick",
|
|
125
|
+
"description": "Set to true to disable closing dialog on outside click",
|
|
126
126
|
"value": {
|
|
127
127
|
"type": [
|
|
128
128
|
"boolean"
|
|
@@ -130,19 +130,8 @@
|
|
|
130
130
|
}
|
|
131
131
|
},
|
|
132
132
|
{
|
|
133
|
-
"name": "
|
|
134
|
-
"description": "
|
|
135
|
-
"value": {
|
|
136
|
-
"type": [
|
|
137
|
-
"string",
|
|
138
|
-
"null",
|
|
139
|
-
"undefined"
|
|
140
|
-
]
|
|
141
|
-
}
|
|
142
|
-
},
|
|
143
|
-
{
|
|
144
|
-
"name": "opened",
|
|
145
|
-
"description": "True if the overlay is currently displayed.",
|
|
133
|
+
"name": "noCloseOnEsc",
|
|
134
|
+
"description": "Set to true to disable closing dialog on Escape press",
|
|
146
135
|
"value": {
|
|
147
136
|
"type": [
|
|
148
137
|
"boolean"
|
|
@@ -150,8 +139,8 @@
|
|
|
150
139
|
}
|
|
151
140
|
},
|
|
152
141
|
{
|
|
153
|
-
"name": "
|
|
154
|
-
"description": "Set to true to
|
|
142
|
+
"name": "modeless",
|
|
143
|
+
"description": "Set to true to remove backdrop and allow click events on background elements.",
|
|
155
144
|
"value": {
|
|
156
145
|
"type": [
|
|
157
146
|
"boolean"
|
|
@@ -159,25 +148,14 @@
|
|
|
159
148
|
}
|
|
160
149
|
},
|
|
161
150
|
{
|
|
162
|
-
"name": "
|
|
163
|
-
"description": "Set to true to
|
|
151
|
+
"name": "draggable",
|
|
152
|
+
"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.",
|
|
164
153
|
"value": {
|
|
165
154
|
"type": [
|
|
166
155
|
"boolean"
|
|
167
156
|
]
|
|
168
157
|
}
|
|
169
158
|
},
|
|
170
|
-
{
|
|
171
|
-
"name": "ariaLabel",
|
|
172
|
-
"description": "Set the `aria-label` attribute for assistive technologies like\nscreen readers. An empty string value for this property (the\ndefault) means that the `aria-label` attribute is not present.",
|
|
173
|
-
"value": {
|
|
174
|
-
"type": [
|
|
175
|
-
"string",
|
|
176
|
-
"null",
|
|
177
|
-
"undefined"
|
|
178
|
-
]
|
|
179
|
-
}
|
|
180
|
-
},
|
|
181
159
|
{
|
|
182
160
|
"name": "renderer",
|
|
183
161
|
"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.",
|
|
@@ -220,13 +198,35 @@
|
|
|
220
198
|
}
|
|
221
199
|
},
|
|
222
200
|
{
|
|
223
|
-
"name": "
|
|
224
|
-
"description": "Set to true to
|
|
201
|
+
"name": "resizable",
|
|
202
|
+
"description": "Set to true to enable resizing the dialog by dragging the corners and edges.",
|
|
225
203
|
"value": {
|
|
226
204
|
"type": [
|
|
227
205
|
"boolean"
|
|
228
206
|
]
|
|
229
207
|
}
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
"name": "overlayClass",
|
|
211
|
+
"description": "A space-delimited list of CSS class names to set on the overlay element.\nThis property does not affect other CSS class names set manually via JS.\n\nNote, if the CSS class name was set with this property, clearing it will\nremove it from the overlay, even if the same class name was also added\nmanually, e.g. by using `classList.add()` in the `renderer` function.",
|
|
212
|
+
"value": {
|
|
213
|
+
"type": [
|
|
214
|
+
"string",
|
|
215
|
+
"null",
|
|
216
|
+
"undefined"
|
|
217
|
+
]
|
|
218
|
+
}
|
|
219
|
+
},
|
|
220
|
+
{
|
|
221
|
+
"name": "ariaLabel",
|
|
222
|
+
"description": "Set the `aria-label` attribute for assistive technologies like\nscreen readers. An empty string value for this property (the\ndefault) means that the `aria-label` attribute is not present.",
|
|
223
|
+
"value": {
|
|
224
|
+
"type": [
|
|
225
|
+
"string",
|
|
226
|
+
"null",
|
|
227
|
+
"undefined"
|
|
228
|
+
]
|
|
229
|
+
}
|
|
230
230
|
}
|
|
231
231
|
],
|
|
232
232
|
"events": [
|
package/web-types.lit.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/web-types",
|
|
3
3
|
"name": "@vaadin/dialog",
|
|
4
|
-
"version": "24.2.0-
|
|
4
|
+
"version": "24.2.0-alpha5",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"framework": "lit",
|
|
7
7
|
"framework-config": {
|
|
@@ -16,23 +16,9 @@
|
|
|
16
16
|
"elements": [
|
|
17
17
|
{
|
|
18
18
|
"name": "vaadin-dialog",
|
|
19
|
-
"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\n`<vaadin-dialog>` uses `<vaadin-dialog-overlay>` internal\nthemable component as the actual visible dialog overlay.\n\nSee [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-
|
|
19
|
+
"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\n`<vaadin-dialog>` uses `<vaadin-dialog-overlay>` internal\nthemable component as the actual visible dialog overlay.\n\nSee [`<vaadin-overlay>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-alpha5/#/elements/vaadin-overlay) documentation.\nfor `<vaadin-dialog-overlay>` parts.\n\nIn addition to `<vaadin-overlay>` parts, the following parts are available for styling:\n\nPart name | Description\n-----------------|-------------------------------------------\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\nNote: the `theme` attribute value set on `<vaadin-dialog>` is\npropagated to the internal `<vaadin-dialog-overlay>` component.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
20
20
|
"extension": true,
|
|
21
21
|
"attributes": [
|
|
22
|
-
{
|
|
23
|
-
"name": "?draggable",
|
|
24
|
-
"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.",
|
|
25
|
-
"value": {
|
|
26
|
-
"kind": "expression"
|
|
27
|
-
}
|
|
28
|
-
},
|
|
29
|
-
{
|
|
30
|
-
"name": "?resizable",
|
|
31
|
-
"description": "Set to true to enable resizing the dialog by dragging the corners and edges.",
|
|
32
|
-
"value": {
|
|
33
|
-
"kind": "expression"
|
|
34
|
-
}
|
|
35
|
-
},
|
|
36
22
|
{
|
|
37
23
|
"name": "?opened",
|
|
38
24
|
"description": "True if the overlay is currently displayed.",
|
|
@@ -62,15 +48,15 @@
|
|
|
62
48
|
}
|
|
63
49
|
},
|
|
64
50
|
{
|
|
65
|
-
"name": "
|
|
66
|
-
"description": "
|
|
51
|
+
"name": "?draggable",
|
|
52
|
+
"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.",
|
|
67
53
|
"value": {
|
|
68
54
|
"kind": "expression"
|
|
69
55
|
}
|
|
70
56
|
},
|
|
71
57
|
{
|
|
72
|
-
"name": "
|
|
73
|
-
"description": "Set
|
|
58
|
+
"name": "?resizable",
|
|
59
|
+
"description": "Set to true to enable resizing the dialog by dragging the corners and edges.",
|
|
74
60
|
"value": {
|
|
75
61
|
"kind": "expression"
|
|
76
62
|
}
|
|
@@ -103,6 +89,20 @@
|
|
|
103
89
|
"kind": "expression"
|
|
104
90
|
}
|
|
105
91
|
},
|
|
92
|
+
{
|
|
93
|
+
"name": ".overlayClass",
|
|
94
|
+
"description": "A space-delimited list of CSS class names to set on the overlay element.\nThis property does not affect other CSS class names set manually via JS.\n\nNote, if the CSS class name was set with this property, clearing it will\nremove it from the overlay, even if the same class name was also added\nmanually, e.g. by using `classList.add()` in the `renderer` function.",
|
|
95
|
+
"value": {
|
|
96
|
+
"kind": "expression"
|
|
97
|
+
}
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"name": ".ariaLabel",
|
|
101
|
+
"description": "Set the `aria-label` attribute for assistive technologies like\nscreen readers. An empty string value for this property (the\ndefault) means that the `aria-label` attribute is not present.",
|
|
102
|
+
"value": {
|
|
103
|
+
"kind": "expression"
|
|
104
|
+
}
|
|
105
|
+
},
|
|
106
106
|
{
|
|
107
107
|
"name": "@opened-changed",
|
|
108
108
|
"description": "Fired when the `opened` property changes.",
|