@vaadin/app-layout 25.1.0-beta1 → 25.1.0-beta3

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.
Files changed (5) hide show
  1. package/custom-elements.json +27 -43
  2. package/package.json +11 -11
  3. package/src/vaadin-app-layout-mixin.js +1 -5
  4. package/web-types.json +31 -8
  5. package/web-types.lit.json +1 -1
package/custom-elements.json CHANGED
@@ -70,20 +70,12 @@
70
70
  {
71
71
  "kind": "field",
72
72
  "name": "i18n",
73
- "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following structure and default values:\n```js\n{\n drawer: 'Drawer'\n}\n```",
74
- "return": {
75
- "type": {
76
- "text": "!AppLayoutI18n"
77
- }
73
+ "privacy": "public",
74
+ "type": {
75
+ "text": "Object"
78
76
  },
79
- "parameters": [
80
- {
81
- "name": "value",
82
- "type": {
83
- "text": "Object"
84
- }
85
- }
86
- ],
77
+ "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following structure and default values:\n```js\n{\n drawer: 'Drawer'\n}\n```",
78
+ "attribute": "i18n",
87
79
  "inheritedFrom": {
88
80
  "name": "I18nMixin",
89
81
  "package": "@vaadin/component-base/src/i18n-mixin.js"
@@ -97,14 +89,15 @@
97
89
  "text": "boolean"
98
90
  },
99
91
  "description": "Drawer is an overlay on top of the content\nControlled via CSS using `--vaadin-app-layout-drawer-overlay: true|false`;",
100
- "attribute": "overlay"
92
+ "attribute": "overlay",
93
+ "readonly": true
101
94
  },
102
95
  {
103
96
  "kind": "field",
104
97
  "name": "primarySection",
105
98
  "privacy": "public",
106
99
  "type": {
107
- "text": "!PrimarySection"
100
+ "text": "string"
108
101
  },
109
102
  "description": "Defines whether navbar or drawer will come first visually.\n- By default (`primary-section=\"navbar\"`), the navbar takes the full available width and moves the drawer down.\n- If `primary-section=\"drawer\"` is set, then the drawer will move the navbar, taking the full available height.",
110
103
  "attribute": "primary-section"
@@ -129,6 +122,11 @@
129
122
  },
130
123
  {
131
124
  "name": "i18n",
125
+ "type": {
126
+ "text": "Object"
127
+ },
128
+ "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nShould be overridden by subclasses to provide a custom JSDoc with the\ndefault I18N properties.",
129
+ "fieldName": "i18n",
132
130
  "inheritedFrom": {
133
131
  "name": "I18nMixin",
134
132
  "package": "@vaadin/component-base/src/i18n-mixin.js"
@@ -145,7 +143,7 @@
145
143
  {
146
144
  "name": "primary-section",
147
145
  "type": {
148
- "text": "!PrimarySection"
146
+ "text": "string"
149
147
  },
150
148
  "description": "Defines whether navbar or drawer will come first visually.\n- By default (`primary-section=\"navbar\"`), the navbar takes the full available width and moves the drawer down.\n- If `primary-section=\"drawer\"` is set, then the drawer will move the navbar, taking the full available height.",
151
149
  "fieldName": "primarySection"
@@ -225,20 +223,12 @@
225
223
  {
226
224
  "kind": "field",
227
225
  "name": "i18n",
228
- "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following structure and default values:\n```js\n{\n drawer: 'Drawer'\n}\n```",
229
- "return": {
230
- "type": {
231
- "text": "!AppLayoutI18n"
232
- }
226
+ "privacy": "public",
227
+ "type": {
228
+ "text": "Object"
233
229
  },
234
- "parameters": [
235
- {
236
- "name": "value",
237
- "type": {
238
- "text": "Object"
239
- }
240
- }
241
- ],
230
+ "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following structure and default values:\n```js\n{\n drawer: 'Drawer'\n}\n```",
231
+ "attribute": "i18n",
242
232
  "inheritedFrom": {
243
233
  "name": "I18nMixin",
244
234
  "package": "@vaadin/component-base/src/i18n-mixin.js"
@@ -253,6 +243,7 @@
253
243
  },
254
244
  "description": "Drawer is an overlay on top of the content\nControlled via CSS using `--vaadin-app-layout-drawer-overlay: true|false`;",
255
245
  "attribute": "overlay",
246
+ "readonly": true,
256
247
  "inheritedFrom": {
257
248
  "name": "AppLayoutMixin",
258
249
  "module": "src/vaadin-app-layout-mixin.js"
@@ -263,7 +254,7 @@
263
254
  "name": "primarySection",
264
255
  "privacy": "public",
265
256
  "type": {
266
- "text": "!PrimarySection"
257
+ "text": "string"
267
258
  },
268
259
  "description": "Defines whether navbar or drawer will come first visually.\n- By default (`primary-section=\"navbar\"`), the navbar takes the full available width and moves the drawer down.\n- If `primary-section=\"drawer\"` is set, then the drawer will move the navbar, taking the full available height.",
269
260
  "attribute": "primary-section",
@@ -351,6 +342,11 @@
351
342
  },
352
343
  {
353
344
  "name": "i18n",
345
+ "type": {
346
+ "text": "Object"
347
+ },
348
+ "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nShould be overridden by subclasses to provide a custom JSDoc with the\ndefault I18N properties.",
349
+ "fieldName": "i18n",
354
350
  "inheritedFrom": {
355
351
  "name": "I18nMixin",
356
352
  "package": "@vaadin/component-base/src/i18n-mixin.js"
@@ -371,7 +367,7 @@
371
367
  {
372
368
  "name": "primary-section",
373
369
  "type": {
374
- "text": "!PrimarySection"
370
+ "text": "string"
375
371
  },
376
372
  "description": "Defines whether navbar or drawer will come first visually.\n- By default (`primary-section=\"navbar\"`), the navbar takes the full available width and moves the drawer down.\n- If `primary-section=\"drawer\"` is set, then the drawer will move the navbar, taking the full available height.",
377
373
  "fieldName": "primarySection",
@@ -420,18 +416,6 @@
420
416
  "text": "string"
421
417
  },
422
418
  "fieldName": "ariaLabel"
423
- },
424
- {
425
- "name": "tabindex",
426
- "type": {
427
- "text": "number"
428
- },
429
- "description": "Indicates whether the element can be focused and where it participates in sequential keyboard navigation.",
430
- "fieldName": "tabindex",
431
- "inheritedFrom": {
432
- "name": "TabindexMixin",
433
- "package": "@vaadin/a11y-base/src/tabindex-mixin.js"
434
- }
435
419
  }
436
420
  ],
437
421
  "mixins": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vaadin/app-layout",
3
- "version": "25.1.0-beta1",
3
+ "version": "25.1.0-beta3",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -35,24 +35,24 @@
35
35
  ],
36
36
  "dependencies": {
37
37
  "@open-wc/dedupe-mixin": "^1.3.0",
38
- "@vaadin/a11y-base": "25.1.0-beta1",
39
- "@vaadin/button": "25.1.0-beta1",
40
- "@vaadin/component-base": "25.1.0-beta1",
41
- "@vaadin/vaadin-themable-mixin": "25.1.0-beta1",
38
+ "@vaadin/a11y-base": "25.1.0-beta3",
39
+ "@vaadin/button": "25.1.0-beta3",
40
+ "@vaadin/component-base": "25.1.0-beta3",
41
+ "@vaadin/vaadin-themable-mixin": "25.1.0-beta3",
42
42
  "lit": "^3.0.0"
43
43
  },
44
44
  "devDependencies": {
45
- "@vaadin/aura": "25.1.0-beta1",
46
- "@vaadin/chai-plugins": "25.1.0-beta1",
47
- "@vaadin/test-runner-commands": "25.1.0-beta1",
45
+ "@vaadin/aura": "25.1.0-beta3",
46
+ "@vaadin/chai-plugins": "25.1.0-beta3",
47
+ "@vaadin/test-runner-commands": "25.1.0-beta3",
48
48
  "@vaadin/testing-helpers": "^2.0.0",
49
- "@vaadin/vaadin-lumo-styles": "25.1.0-beta1",
50
- "sinon": "^21.0.0"
49
+ "@vaadin/vaadin-lumo-styles": "25.1.0-beta3",
50
+ "sinon": "^21.0.2"
51
51
  },
52
52
  "customElements": "custom-elements.json",
53
53
  "web-types": [
54
54
  "web-types.json",
55
55
  "web-types.lit.json"
56
56
  ],
57
- "gitHead": "0ccf77c385fc6a92ac2a6344ce8804b94956226d"
57
+ "gitHead": "4251850231a42298fda23b83928da588831cdb5d"
58
58
  }
package/src/vaadin-app-layout-mixin.js CHANGED
@@ -31,7 +31,6 @@ export const AppLayoutMixin = (superclass) =>
31
31
  * - By default (`primary-section="navbar"`), the navbar takes the full available width and moves the drawer down.
32
32
  * - If `primary-section="drawer"` is set, then the drawer will move the navbar, taking the full available height.
33
33
  * @attr {navbar|drawer} primary-section
34
- * @type {!PrimarySection}
35
34
  */
36
35
  primarySection: {
37
36
  type: String,
@@ -48,7 +47,6 @@ export const AppLayoutMixin = (superclass) =>
48
47
  * - `true`, for desktop size views
49
48
  * - `false`, for mobile size views
50
49
  * @attr {boolean} drawer-opened
51
- * @type {boolean}
52
50
  */
53
51
  drawerOpened: {
54
52
  type: Boolean,
@@ -62,7 +60,6 @@ export const AppLayoutMixin = (superclass) =>
62
60
  /**
63
61
  * Drawer is an overlay on top of the content
64
62
  * Controlled via CSS using `--vaadin-app-layout-drawer-overlay: true|false`;
65
- * @type {boolean}
66
63
  */
67
64
  overlay: {
68
65
  type: Boolean,
@@ -79,7 +76,6 @@ export const AppLayoutMixin = (superclass) =>
79
76
  * - The default is `vaadin-router-location-changed` dispatched by Vaadin Router
80
77
  *
81
78
  * @attr {string} close-drawer-on
82
- * @type {string}
83
79
  */
84
80
  closeDrawerOn: {
85
81
  type: String,
@@ -111,7 +107,7 @@ export const AppLayoutMixin = (superclass) =>
111
107
  * drawer: 'Drawer'
112
108
  * }
113
109
  * ```
114
- * @return {!AppLayoutI18n}
110
+ * @type {!AppLayoutI18n}
115
111
  */
116
112
  get i18n() {
117
113
  return super.i18n;
package/web-types.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/web-types",
3
3
  "name": "@vaadin/app-layout",
4
- "version": "25.1.0-beta1",
4
+ "version": "25.1.0-beta3",
5
5
  "description-markup": "markdown",
6
6
  "contributions": {
7
7
  "html": {
@@ -15,7 +15,9 @@
15
15
  "description": "A global event that causes the drawer to close (be hidden) when it is in overlay mode.\n- The default is `vaadin-router-location-changed` dispatched by Vaadin Router",
16
16
  "value": {
17
17
  "type": [
18
- "string"
18
+ "string",
19
+ "null",
20
+ "undefined"
19
21
  ]
20
22
  }
21
23
  },
@@ -24,7 +26,20 @@
24
26
  "description": "Controls whether the drawer is opened (visible) or not.\nIts default value depends on the viewport:\n- `true`, for desktop size views\n- `false`, for mobile size views",
25
27
  "value": {
26
28
  "type": [
27
- "boolean"
29
+ "boolean",
30
+ "null",
31
+ "undefined"
32
+ ]
33
+ }
34
+ },
35
+ {
36
+ "name": "i18n",
37
+ "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nShould be overridden by subclasses to provide a custom JSDoc with the\ndefault I18N properties.",
38
+ "value": {
39
+ "type": [
40
+ "Object",
41
+ "null",
42
+ "undefined"
28
43
  ]
29
44
  }
30
45
  },
@@ -33,7 +48,9 @@
33
48
  "description": "Defines whether navbar or drawer will come first visually.\n- By default (`primary-section=\"navbar\"`), the navbar takes the full available width and moves the drawer down.\n- If `primary-section=\"drawer\"` is set, then the drawer will move the navbar, taking the full available height.",
34
49
  "value": {
35
50
  "type": [
36
- "PrimarySection"
51
+ "string",
52
+ "null",
53
+ "undefined"
37
54
  ]
38
55
  }
39
56
  },
@@ -56,7 +73,9 @@
56
73
  "description": "A global event that causes the drawer to close (be hidden) when it is in overlay mode.\n- The default is `vaadin-router-location-changed` dispatched by Vaadin Router",
57
74
  "value": {
58
75
  "type": [
59
- "string"
76
+ "string",
77
+ "null",
78
+ "undefined"
60
79
  ]
61
80
  }
62
81
  },
@@ -65,7 +84,9 @@
65
84
  "description": "Controls whether the drawer is opened (visible) or not.\nIts default value depends on the viewport:\n- `true`, for desktop size views\n- `false`, for mobile size views",
66
85
  "value": {
67
86
  "type": [
68
- "boolean"
87
+ "boolean",
88
+ "null",
89
+ "undefined"
69
90
  ]
70
91
  }
71
92
  },
@@ -74,7 +95,7 @@
74
95
  "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following structure and default values:\n```js\n{\n drawer: 'Drawer'\n}\n```",
75
96
  "value": {
76
97
  "type": [
77
- "AppLayoutI18n"
98
+ "?"
78
99
  ]
79
100
  }
80
101
  },
@@ -83,7 +104,9 @@
83
104
  "description": "Defines whether navbar or drawer will come first visually.\n- By default (`primary-section=\"navbar\"`), the navbar takes the full available width and moves the drawer down.\n- If `primary-section=\"drawer\"` is set, then the drawer will move the navbar, taking the full available height.",
84
105
  "value": {
85
106
  "type": [
86
- "PrimarySection"
107
+ "string",
108
+ "null",
109
+ "undefined"
87
110
  ]
88
111
  }
89
112
  }
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/app-layout",
4
- "version": "25.1.0-beta1",
4
+ "version": "25.1.0-beta3",
5
5
  "description-markup": "markdown",
6
6
  "framework": "lit",
7
7
  "framework-config": {