@vaadin/dialog 25.0.0-alpha13 → 25.0.0-alpha15

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vaadin/dialog",
3
- "version": "25.0.0-alpha13",
3
+ "version": "25.0.0-alpha15",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -36,23 +36,23 @@
36
36
  ],
37
37
  "dependencies": {
38
38
  "@open-wc/dedupe-mixin": "^1.3.0",
39
- "@vaadin/component-base": "25.0.0-alpha13",
40
- "@vaadin/lit-renderer": "25.0.0-alpha13",
41
- "@vaadin/overlay": "25.0.0-alpha13",
42
- "@vaadin/vaadin-themable-mixin": "25.0.0-alpha13",
39
+ "@vaadin/component-base": "25.0.0-alpha15",
40
+ "@vaadin/lit-renderer": "25.0.0-alpha15",
41
+ "@vaadin/overlay": "25.0.0-alpha15",
42
+ "@vaadin/vaadin-themable-mixin": "25.0.0-alpha15",
43
43
  "lit": "^3.0.0"
44
44
  },
45
45
  "devDependencies": {
46
- "@vaadin/a11y-base": "25.0.0-alpha13",
47
- "@vaadin/chai-plugins": "25.0.0-alpha13",
48
- "@vaadin/test-runner-commands": "25.0.0-alpha13",
46
+ "@vaadin/a11y-base": "25.0.0-alpha15",
47
+ "@vaadin/chai-plugins": "25.0.0-alpha15",
48
+ "@vaadin/test-runner-commands": "25.0.0-alpha15",
49
49
  "@vaadin/testing-helpers": "^2.0.0",
50
- "@vaadin/vaadin-lumo-styles": "25.0.0-alpha13",
50
+ "@vaadin/vaadin-lumo-styles": "25.0.0-alpha15",
51
51
  "sinon": "^18.0.0"
52
52
  },
53
53
  "web-types": [
54
54
  "web-types.json",
55
55
  "web-types.lit.json"
56
56
  ],
57
- "gitHead": "182de596226343392135468f021bbce9e6402011"
57
+ "gitHead": "1ad98437e7600769bf66f870929feefbeef16edf"
58
58
  }
@@ -11,7 +11,7 @@ export declare function DialogBaseMixin<T extends Constructor<HTMLElement>>(
11
11
 
12
12
  export declare class DialogBaseMixinClass {
13
13
  /**
14
- * True if the overlay is currently displayed.
14
+ * True if the dialog is visible and available for interaction.
15
15
  */
16
16
  opened: boolean;
17
17
 
@@ -41,22 +41,20 @@ export declare class DialogBaseMixinClass {
41
41
  overlayRole: string;
42
42
 
43
43
  /**
44
- * Set the distance of the overlay from the top of its container.
44
+ * Set the distance of the dialog from the top of the viewport.
45
45
  * If a unitless number is provided, pixels are assumed.
46
46
  *
47
- * Note that the overlay top edge may not be the same as the viewport
48
- * top edge (e.g. the Lumo theme defines some spacing to prevent the
49
- * overlay from stretching all the way to the top of the viewport).
47
+ * Note that the dialog uses an internal container that has some
48
+ * additional spacing, which can be overridden by the theme.
50
49
  */
51
50
  top: string;
52
51
 
53
52
  /**
54
- * Set the distance of the overlay from the left of its container.
53
+ * Set the distance of the dialog from the left of the viewport.
55
54
  * If a unitless number is provided, pixels are assumed.
56
55
  *
57
- * Note that the overlay left edge may not be the same as the viewport
58
- * left edge (e.g. the Lumo theme defines some spacing to prevent the
59
- * overlay from stretching all the way to the left of the viewport).
56
+ * Note that the dialog uses an internal container that has some
57
+ * additional spacing, which can be overridden by the theme.
60
58
  */
61
59
  left: string;
62
60
  }
@@ -12,7 +12,7 @@ export const DialogBaseMixin = (superClass) =>
12
12
  static get properties() {
13
13
  return {
14
14
  /**
15
- * True if the overlay is currently displayed.
15
+ * True if the dialog is visible and available for interaction.
16
16
  * @type {boolean}
17
17
  */
18
18
  opened: {
@@ -53,24 +53,22 @@ export const DialogBaseMixin = (superClass) =>
53
53
  },
54
54
 
55
55
  /**
56
- * Set the distance of the overlay from the top of its container.
56
+ * Set the distance of the dialog from the top of the viewport.
57
57
  * If a unitless number is provided, pixels are assumed.
58
58
  *
59
- * Note that the overlay top edge may not be the same as the viewport
60
- * top edge (e.g. the Lumo theme defines some spacing to prevent the
61
- * overlay from stretching all the way to the top of the viewport).
59
+ * Note that the dialog uses an internal container that has some
60
+ * additional spacing, which can be overridden by the theme.
62
61
  */
63
62
  top: {
64
63
  type: String,
65
64
  },
66
65
 
67
66
  /**
68
- * Set the distance of the overlay from the left of its container.
67
+ * Set the distance of the dialog from the left of the viewport.
69
68
  * If a unitless number is provided, pixels are assumed.
70
69
  *
71
- * Note that the overlay left edge may not be the same as the viewport
72
- * left edge (e.g. the Lumo theme defines some spacing to prevent the
73
- * overlay from stretching all the way to the left of the viewport).
70
+ * Note that the dialog uses an internal container that has some
71
+ * additional spacing, which can be overridden by the theme.
74
72
  */
75
73
  left: {
76
74
  type: String,
@@ -27,7 +27,7 @@ export declare class DialogRendererMixinClass {
27
27
  * and the elements created by the renderer will be placed next to
28
28
  * each other, with the title coming first.
29
29
  *
30
- * When `headerTitle` is set, the attribute `has-title` is added to the overlay element.
30
+ * When `headerTitle` is set, the attribute `has-title` is set on the dialog.
31
31
  * @attr {string} header-title
32
32
  */
33
33
  headerTitle: string | null | undefined;
@@ -43,7 +43,7 @@ export declare class DialogRendererMixinClass {
43
43
  * and the elements created by the renderer will be placed next to
44
44
  * each other, with the title coming first.
45
45
  *
46
- * When `headerRenderer` is set, the attribute `has-header` is added to the overlay element.
46
+ * When `headerRenderer` is set, the attribute `has-header` is set on the dialog.
47
47
  */
48
48
  headerRenderer: DialogRenderer | null | undefined;
49
49
 
@@ -54,7 +54,7 @@ export declare class DialogRendererMixinClass {
54
54
  * - `root` The root container DOM element. Append your content to it.
55
55
  * - `dialog` The reference to the `<vaadin-dialog>` element.
56
56
  *
57
- * When `footerRenderer` is set, the attribute `has-footer` is added to the overlay element.
57
+ * When `footerRenderer` is set, the attribute `has-footer` is set on the dialog.
58
58
  */
59
59
  footerRenderer: DialogRenderer | null | undefined;
60
60
 
@@ -30,7 +30,7 @@ export const DialogRendererMixin = (superClass) =>
30
30
  * and the elements created by the renderer will be placed next to
31
31
  * each other, with the title coming first.
32
32
  *
33
- * When `headerTitle` is set, the attribute `has-title` is added to the overlay element.
33
+ * When `headerTitle` is set, the attribute `has-title` is set on the dialog.
34
34
  * @attr {string} header-title
35
35
  */
36
36
  headerTitle: String,
@@ -46,7 +46,7 @@ export const DialogRendererMixin = (superClass) =>
46
46
  * and the elements created by the renderer will be placed next to
47
47
  * each other, with the title coming first.
48
48
  *
49
- * When `headerRenderer` is set, the attribute `has-header` is added to the overlay element.
49
+ * When `headerRenderer` is set, the attribute `has-header` is set on the dialog.
50
50
  * @type {DialogRenderer | undefined}
51
51
  */
52
52
  headerRenderer: {
@@ -60,7 +60,7 @@ export const DialogRendererMixin = (superClass) =>
60
60
  * - `root` The root container DOM element. Append your content to it.
61
61
  * - `dialog` The reference to the `<vaadin-dialog>` element.
62
62
  *
63
- * When `footerRenderer` is set, the attribute `has-footer` is added to the overlay element.
63
+ * When `footerRenderer` is set, the attribute `has-footer` is set on the dialog.
64
64
  * @type {DialogRenderer | undefined}
65
65
  */
66
66
  footerRenderer: {
@@ -11,13 +11,13 @@ export declare function DialogSizeMixin<T extends Constructor<HTMLElement>>(
11
11
 
12
12
  export declare class DialogSizeMixinClass {
13
13
  /**
14
- * Set the width of the overlay.
14
+ * Set the width of the dialog.
15
15
  * If a unitless number is provided, pixels are assumed.
16
16
  */
17
17
  width: string | null;
18
18
 
19
19
  /**
20
- * Set the height of the overlay.
20
+ * Set the height of the dialog.
21
21
  * If a unitless number is provided, pixels are assumed.
22
22
  */
23
23
  height: string | null;
@@ -12,7 +12,7 @@ export const DialogSizeMixin = (superClass) =>
12
12
  static get properties() {
13
13
  return {
14
14
  /**
15
- * Set the width of the overlay.
15
+ * Set the width of the dialog.
16
16
  * If a unitless number is provided, pixels are assumed.
17
17
  */
18
18
  width: {
@@ -20,7 +20,7 @@ export const DialogSizeMixin = (superClass) =>
20
20
  },
21
21
 
22
22
  /**
23
- * Set the height of the overlay.
23
+ * Set the height of the dialog.
24
24
  * If a unitless number is provided, pixels are assumed.
25
25
  */
26
26
  height: {
package/web-types.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/web-types",
3
3
  "name": "@vaadin/dialog",
4
- "version": "25.0.0-alpha13",
4
+ "version": "25.0.0-alpha15",
5
5
  "description-markup": "markdown",
6
6
  "contributions": {
7
7
  "html": {
@@ -12,7 +12,7 @@
12
12
  "attributes": [
13
13
  {
14
14
  "name": "opened",
15
- "description": "True if the overlay is currently displayed.",
15
+ "description": "True if the dialog is visible and available for interaction.",
16
16
  "value": {
17
17
  "type": [
18
18
  "boolean"
@@ -48,7 +48,7 @@
48
48
  },
49
49
  {
50
50
  "name": "top",
51
- "description": "Set the distance of the overlay from the top of its container.\nIf a unitless number is provided, pixels are assumed.\n\nNote that the overlay top edge may not be the same as the viewport\ntop edge (e.g. the Lumo theme defines some spacing to prevent the\noverlay from stretching all the way to the top of the viewport).",
51
+ "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.",
52
52
  "value": {
53
53
  "type": [
54
54
  "string",
@@ -59,7 +59,7 @@
59
59
  },
60
60
  {
61
61
  "name": "left",
62
- "description": "Set the distance of the overlay from the left of its container.\nIf a unitless number is provided, pixels are assumed.\n\nNote that the overlay left edge may not be the same as the viewport\nleft edge (e.g. the Lumo theme defines some spacing to prevent the\noverlay from stretching all the way to the left of the viewport).",
62
+ "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.",
63
63
  "value": {
64
64
  "type": [
65
65
  "string",
@@ -90,7 +90,7 @@
90
90
  },
91
91
  {
92
92
  "name": "header-title",
93
- "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.",
93
+ "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.",
94
94
  "value": {
95
95
  "type": [
96
96
  "string",
@@ -110,7 +110,7 @@
110
110
  },
111
111
  {
112
112
  "name": "width",
113
- "description": "Set the width of the overlay.\nIf a unitless number is provided, pixels are assumed.",
113
+ "description": "Set the width of the dialog.\nIf a unitless number is provided, pixels are assumed.",
114
114
  "value": {
115
115
  "type": [
116
116
  "string",
@@ -121,7 +121,7 @@
121
121
  },
122
122
  {
123
123
  "name": "height",
124
- "description": "Set the height of the overlay.\nIf a unitless number is provided, pixels are assumed.",
124
+ "description": "Set the height of the dialog.\nIf a unitless number is provided, pixels are assumed.",
125
125
  "value": {
126
126
  "type": [
127
127
  "string",
@@ -146,7 +146,7 @@
146
146
  "properties": [
147
147
  {
148
148
  "name": "opened",
149
- "description": "True if the overlay is currently displayed.",
149
+ "description": "True if the dialog is visible and available for interaction.",
150
150
  "value": {
151
151
  "type": [
152
152
  "boolean"
@@ -182,7 +182,7 @@
182
182
  },
183
183
  {
184
184
  "name": "top",
185
- "description": "Set the distance of the overlay from the top of its container.\nIf a unitless number is provided, pixels are assumed.\n\nNote that the overlay top edge may not be the same as the viewport\ntop edge (e.g. the Lumo theme defines some spacing to prevent the\noverlay from stretching all the way to the top of the viewport).",
185
+ "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.",
186
186
  "value": {
187
187
  "type": [
188
188
  "string",
@@ -193,7 +193,7 @@
193
193
  },
194
194
  {
195
195
  "name": "left",
196
- "description": "Set the distance of the overlay from the left of its container.\nIf a unitless number is provided, pixels are assumed.\n\nNote that the overlay left edge may not be the same as the viewport\nleft edge (e.g. the Lumo theme defines some spacing to prevent the\noverlay from stretching all the way to the left of the viewport).",
196
+ "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.",
197
197
  "value": {
198
198
  "type": [
199
199
  "string",
@@ -234,7 +234,7 @@
234
234
  },
235
235
  {
236
236
  "name": "headerTitle",
237
- "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.",
237
+ "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.",
238
238
  "value": {
239
239
  "type": [
240
240
  "string",
@@ -245,7 +245,7 @@
245
245
  },
246
246
  {
247
247
  "name": "headerRenderer",
248
- "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 added to the overlay element.",
248
+ "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.",
249
249
  "value": {
250
250
  "type": [
251
251
  "DialogRenderer",
@@ -255,7 +255,7 @@
255
255
  },
256
256
  {
257
257
  "name": "footerRenderer",
258
- "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 added to the overlay element.",
258
+ "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.",
259
259
  "value": {
260
260
  "type": [
261
261
  "DialogRenderer",
@@ -274,7 +274,7 @@
274
274
  },
275
275
  {
276
276
  "name": "width",
277
- "description": "Set the width of the overlay.\nIf a unitless number is provided, pixels are assumed.",
277
+ "description": "Set the width of the dialog.\nIf a unitless number is provided, pixels are assumed.",
278
278
  "value": {
279
279
  "type": [
280
280
  "string",
@@ -285,7 +285,7 @@
285
285
  },
286
286
  {
287
287
  "name": "height",
288
- "description": "Set the height of the overlay.\nIf a unitless number is provided, pixels are assumed.",
288
+ "description": "Set the height of the dialog.\nIf a unitless number is provided, pixels are assumed.",
289
289
  "value": {
290
290
  "type": [
291
291
  "string",
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/web-types",
3
3
  "name": "@vaadin/dialog",
4
- "version": "25.0.0-alpha13",
4
+ "version": "25.0.0-alpha15",
5
5
  "description-markup": "markdown",
6
6
  "framework": "lit",
7
7
  "framework-config": {
@@ -21,7 +21,7 @@
21
21
  "attributes": [
22
22
  {
23
23
  "name": "?opened",
24
- "description": "True if the overlay is currently displayed.",
24
+ "description": "True if the dialog is visible and available for interaction.",
25
25
  "value": {
26
26
  "kind": "expression"
27
27
  }
@@ -63,14 +63,14 @@
63
63
  },
64
64
  {
65
65
  "name": ".top",
66
- "description": "Set the distance of the overlay from the top of its container.\nIf a unitless number is provided, pixels are assumed.\n\nNote that the overlay top edge may not be the same as the viewport\ntop edge (e.g. the Lumo theme defines some spacing to prevent the\noverlay from stretching all the way to the top of the viewport).",
66
+ "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.",
67
67
  "value": {
68
68
  "kind": "expression"
69
69
  }
70
70
  },
71
71
  {
72
72
  "name": ".left",
73
- "description": "Set the distance of the overlay from the left of its container.\nIf a unitless number is provided, pixels are assumed.\n\nNote that the overlay left edge may not be the same as the viewport\nleft edge (e.g. the Lumo theme defines some spacing to prevent the\noverlay from stretching all the way to the left of the viewport).",
73
+ "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.",
74
74
  "value": {
75
75
  "kind": "expression"
76
76
  }
@@ -91,35 +91,35 @@
91
91
  },
92
92
  {
93
93
  "name": ".headerTitle",
94
- "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.",
94
+ "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.",
95
95
  "value": {
96
96
  "kind": "expression"
97
97
  }
98
98
  },
99
99
  {
100
100
  "name": ".headerRenderer",
101
- "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 added to the overlay element.",
101
+ "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.",
102
102
  "value": {
103
103
  "kind": "expression"
104
104
  }
105
105
  },
106
106
  {
107
107
  "name": ".footerRenderer",
108
- "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 added to the overlay element.",
108
+ "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.",
109
109
  "value": {
110
110
  "kind": "expression"
111
111
  }
112
112
  },
113
113
  {
114
114
  "name": ".width",
115
- "description": "Set the width of the overlay.\nIf a unitless number is provided, pixels are assumed.",
115
+ "description": "Set the width of the dialog.\nIf a unitless number is provided, pixels are assumed.",
116
116
  "value": {
117
117
  "kind": "expression"
118
118
  }
119
119
  },
120
120
  {
121
121
  "name": ".height",
122
- "description": "Set the height of the overlay.\nIf a unitless number is provided, pixels are assumed.",
122
+ "description": "Set the height of the dialog.\nIf a unitless number is provided, pixels are assumed.",
123
123
  "value": {
124
124
  "kind": "expression"
125
125
  }