@vaadin/side-nav 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.
- package/README.md +1 -1
- package/custom-elements.json +45 -41
- package/package.json +12 -12
- package/src/vaadin-side-nav-children-mixin.js +1 -1
- package/src/vaadin-side-nav-item.d.ts +1 -1
- package/src/vaadin-side-nav-item.js +7 -7
- package/src/vaadin-side-nav.js +0 -2
- package/web-types.json +34 -14
- package/web-types.lit.json +2 -2
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@ A web component for navigation menus.
|
|
|
13
13
|
<vaadin-side-nav-item path="/dashboard">
|
|
14
14
|
<vaadin-icon icon="vaadin:chart" slot="prefix"></vaadin-icon>
|
|
15
15
|
Dashboard
|
|
16
|
-
<
|
|
16
|
+
<vaadin-badge slot="suffix" number="2" theme="number-only">new items</vaadin-badge>
|
|
17
17
|
</vaadin-side-nav-item>
|
|
18
18
|
|
|
19
19
|
<vaadin-side-nav-item>
|
package/custom-elements.json
CHANGED
|
@@ -44,20 +44,12 @@
|
|
|
44
44
|
{
|
|
45
45
|
"kind": "field",
|
|
46
46
|
"name": "i18n",
|
|
47
|
-
"
|
|
48
|
-
"
|
|
49
|
-
"
|
|
50
|
-
"text": "!SideNavI18n"
|
|
51
|
-
}
|
|
47
|
+
"privacy": "public",
|
|
48
|
+
"type": {
|
|
49
|
+
"text": "Object"
|
|
52
50
|
},
|
|
53
|
-
"
|
|
54
|
-
|
|
55
|
-
"name": "value",
|
|
56
|
-
"type": {
|
|
57
|
-
"text": "Object"
|
|
58
|
-
}
|
|
59
|
-
}
|
|
60
|
-
],
|
|
51
|
+
"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 toggle: 'Toggle child items'\n}\n```",
|
|
52
|
+
"attribute": "i18n",
|
|
61
53
|
"inheritedFrom": {
|
|
62
54
|
"name": "I18nMixin",
|
|
63
55
|
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
@@ -67,6 +59,11 @@
|
|
|
67
59
|
"attributes": [
|
|
68
60
|
{
|
|
69
61
|
"name": "i18n",
|
|
62
|
+
"type": {
|
|
63
|
+
"text": "Object"
|
|
64
|
+
},
|
|
65
|
+
"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.",
|
|
66
|
+
"fieldName": "i18n",
|
|
70
67
|
"inheritedFrom": {
|
|
71
68
|
"name": "I18nMixin",
|
|
72
69
|
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
@@ -103,7 +100,7 @@
|
|
|
103
100
|
"declarations": [
|
|
104
101
|
{
|
|
105
102
|
"kind": "class",
|
|
106
|
-
"description": "A navigation item to be used within `<vaadin-side-nav>`. Represents a navigation target.\nNot intended to be used separately.\n\n```html\n<vaadin-side-nav-item>\n Item 1\n <vaadin-side-nav-item path=\"/path1\" slot=\"children\">\n Child item 1\n </vaadin-side-nav-item>\n <vaadin-side-nav-item path=\"/path2\" slot=\"children\">\n Child item 2\n </vaadin-side-nav-item>\n</vaadin-side-nav-item>\n```\n\n### Customization\n\nYou can configure the item by using `slot` names.\n\nSlot name | Description\n----------|-------------\n`prefix` | A slot for content before the label (e.g. an icon).\n`suffix` | A slot for content after the label (e.g. an icon).\n\n#### Example\n\n```html\n<vaadin-side-nav-item>\n <vaadin-icon icon=\"vaadin:chart\" slot=\"prefix\"></vaadin-icon>\n Item\n <
|
|
103
|
+
"description": "A navigation item to be used within `<vaadin-side-nav>`. Represents a navigation target.\nNot intended to be used separately.\n\n```html\n<vaadin-side-nav-item>\n Item 1\n <vaadin-side-nav-item path=\"/path1\" slot=\"children\">\n Child item 1\n </vaadin-side-nav-item>\n <vaadin-side-nav-item path=\"/path2\" slot=\"children\">\n Child item 2\n </vaadin-side-nav-item>\n</vaadin-side-nav-item>\n```\n\n### Customization\n\nYou can configure the item by using `slot` names.\n\nSlot name | Description\n----------|-------------\n`prefix` | A slot for content before the label (e.g. an icon).\n`suffix` | A slot for content after the label (e.g. an icon).\n\n#### Example\n\n```html\n<vaadin-side-nav-item>\n <vaadin-icon icon=\"vaadin:chart\" slot=\"prefix\"></vaadin-icon>\n Item\n <vaadin-badge slot=\"suffix\">Suffix</vaadin-badge>\n</vaadin-side-nav-item>\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------------|----------------\n`content` | The element that wraps link and toggle button\n`children` | The element that wraps child items\n`link` | The clickable anchor used for navigation\n`toggle-button` | The toggle button\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n---------------|-------------\n`disabled` | Set when the element is disabled.\n`expanded` | Set when the element is expanded.\n`has-children` | Set when the element has child items.\n`has-tooltip` | Set when the element has a slotted tooltip.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
107
104
|
"name": "SideNavItem",
|
|
108
105
|
"members": [
|
|
109
106
|
{
|
|
@@ -114,7 +111,8 @@
|
|
|
114
111
|
"text": "boolean"
|
|
115
112
|
},
|
|
116
113
|
"description": "Whether the item's path matches the current browser URL.\n\nA match occurs when both share the same base origin (like https://example.com),\nthe same path (like /path/to/page), and the browser URL contains at least\nall the query parameters with the same values from the item's path.\n\nSee [`matchNested`](#/elements/vaadin-side-nav-item#property-matchNested) for how to change the path matching behavior.\n\nThe state is updated when the item is added to the DOM or when the browser\nnavigates to a new page.",
|
|
117
|
-
"attribute": "current"
|
|
114
|
+
"attribute": "current",
|
|
115
|
+
"readonly": true
|
|
118
116
|
},
|
|
119
117
|
{
|
|
120
118
|
"kind": "field",
|
|
@@ -129,20 +127,12 @@
|
|
|
129
127
|
{
|
|
130
128
|
"kind": "field",
|
|
131
129
|
"name": "i18n",
|
|
132
|
-
"
|
|
133
|
-
"
|
|
134
|
-
"
|
|
135
|
-
"text": "!SideNavI18n"
|
|
136
|
-
}
|
|
130
|
+
"privacy": "public",
|
|
131
|
+
"type": {
|
|
132
|
+
"text": "Object"
|
|
137
133
|
},
|
|
138
|
-
"
|
|
139
|
-
|
|
140
|
-
"name": "value",
|
|
141
|
-
"type": {
|
|
142
|
-
"text": "Object"
|
|
143
|
-
}
|
|
144
|
-
}
|
|
145
|
-
],
|
|
134
|
+
"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 toggle: 'Toggle child items'\n}\n```",
|
|
135
|
+
"attribute": "i18n",
|
|
146
136
|
"inheritedFrom": {
|
|
147
137
|
"name": "I18nMixin",
|
|
148
138
|
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
@@ -162,6 +152,9 @@
|
|
|
162
152
|
"kind": "field",
|
|
163
153
|
"name": "path",
|
|
164
154
|
"privacy": "public",
|
|
155
|
+
"type": {
|
|
156
|
+
"text": "string"
|
|
157
|
+
},
|
|
165
158
|
"description": "The path to navigate to",
|
|
166
159
|
"attribute": "path"
|
|
167
160
|
},
|
|
@@ -189,6 +182,9 @@
|
|
|
189
182
|
"kind": "field",
|
|
190
183
|
"name": "target",
|
|
191
184
|
"privacy": "public",
|
|
185
|
+
"type": {
|
|
186
|
+
"text": "string"
|
|
187
|
+
},
|
|
192
188
|
"description": "The target of the link. Works only when `path` is set.",
|
|
193
189
|
"attribute": "target"
|
|
194
190
|
}
|
|
@@ -221,6 +217,11 @@
|
|
|
221
217
|
},
|
|
222
218
|
{
|
|
223
219
|
"name": "i18n",
|
|
220
|
+
"type": {
|
|
221
|
+
"text": "Object"
|
|
222
|
+
},
|
|
223
|
+
"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.",
|
|
224
|
+
"fieldName": "i18n",
|
|
224
225
|
"inheritedFrom": {
|
|
225
226
|
"name": "I18nMixin",
|
|
226
227
|
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
@@ -236,6 +237,9 @@
|
|
|
236
237
|
},
|
|
237
238
|
{
|
|
238
239
|
"name": "path",
|
|
240
|
+
"type": {
|
|
241
|
+
"text": "string"
|
|
242
|
+
},
|
|
239
243
|
"description": "The path to navigate to",
|
|
240
244
|
"fieldName": "path"
|
|
241
245
|
},
|
|
@@ -249,6 +253,9 @@
|
|
|
249
253
|
},
|
|
250
254
|
{
|
|
251
255
|
"name": "target",
|
|
256
|
+
"type": {
|
|
257
|
+
"text": "string"
|
|
258
|
+
},
|
|
252
259
|
"description": "The target of the link. Works only when `path` is set.",
|
|
253
260
|
"fieldName": "target"
|
|
254
261
|
}
|
|
@@ -330,20 +337,12 @@
|
|
|
330
337
|
{
|
|
331
338
|
"kind": "field",
|
|
332
339
|
"name": "i18n",
|
|
333
|
-
"
|
|
334
|
-
"
|
|
335
|
-
"
|
|
336
|
-
"text": "!SideNavI18n"
|
|
337
|
-
}
|
|
340
|
+
"privacy": "public",
|
|
341
|
+
"type": {
|
|
342
|
+
"text": "Object"
|
|
338
343
|
},
|
|
339
|
-
"
|
|
340
|
-
|
|
341
|
-
"name": "value",
|
|
342
|
-
"type": {
|
|
343
|
-
"text": "Object"
|
|
344
|
-
}
|
|
345
|
-
}
|
|
346
|
-
],
|
|
344
|
+
"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 toggle: 'Toggle child items'\n}\n```",
|
|
345
|
+
"attribute": "i18n",
|
|
347
346
|
"inheritedFrom": {
|
|
348
347
|
"name": "I18nMixin",
|
|
349
348
|
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
@@ -407,6 +406,11 @@
|
|
|
407
406
|
},
|
|
408
407
|
{
|
|
409
408
|
"name": "i18n",
|
|
409
|
+
"type": {
|
|
410
|
+
"text": "Object"
|
|
411
|
+
},
|
|
412
|
+
"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.",
|
|
413
|
+
"fieldName": "i18n",
|
|
410
414
|
"inheritedFrom": {
|
|
411
415
|
"name": "I18nMixin",
|
|
412
416
|
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/side-nav",
|
|
3
|
-
"version": "25.1.0-
|
|
3
|
+
"version": "25.1.0-beta3",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -35,26 +35,26 @@
|
|
|
35
35
|
],
|
|
36
36
|
"dependencies": {
|
|
37
37
|
"@open-wc/dedupe-mixin": "^1.3.0",
|
|
38
|
-
"@vaadin/a11y-base": "25.1.0-
|
|
39
|
-
"@vaadin/component-base": "25.1.0-
|
|
40
|
-
"@vaadin/vaadin-themable-mixin": "25.1.0-
|
|
38
|
+
"@vaadin/a11y-base": "25.1.0-beta3",
|
|
39
|
+
"@vaadin/component-base": "25.1.0-beta3",
|
|
40
|
+
"@vaadin/vaadin-themable-mixin": "25.1.0-beta3",
|
|
41
41
|
"lit": "^3.0.0"
|
|
42
42
|
},
|
|
43
43
|
"devDependencies": {
|
|
44
|
-
"@vaadin/aura": "25.1.0-
|
|
45
|
-
"@vaadin/chai-plugins": "25.1.0-
|
|
46
|
-
"@vaadin/icon": "25.1.0-
|
|
47
|
-
"@vaadin/icons": "25.1.0-
|
|
48
|
-
"@vaadin/test-runner-commands": "25.1.0-
|
|
44
|
+
"@vaadin/aura": "25.1.0-beta3",
|
|
45
|
+
"@vaadin/chai-plugins": "25.1.0-beta3",
|
|
46
|
+
"@vaadin/icon": "25.1.0-beta3",
|
|
47
|
+
"@vaadin/icons": "25.1.0-beta3",
|
|
48
|
+
"@vaadin/test-runner-commands": "25.1.0-beta3",
|
|
49
49
|
"@vaadin/testing-helpers": "^2.0.0",
|
|
50
|
-
"@vaadin/vaadin-lumo-styles": "25.1.0-
|
|
50
|
+
"@vaadin/vaadin-lumo-styles": "25.1.0-beta3",
|
|
51
51
|
"lit": "^3.0.0",
|
|
52
|
-
"sinon": "^21.0.
|
|
52
|
+
"sinon": "^21.0.2"
|
|
53
53
|
},
|
|
54
54
|
"customElements": "custom-elements.json",
|
|
55
55
|
"web-types": [
|
|
56
56
|
"web-types.json",
|
|
57
57
|
"web-types.lit.json"
|
|
58
58
|
],
|
|
59
|
-
"gitHead": "
|
|
59
|
+
"gitHead": "4251850231a42298fda23b83928da588831cdb5d"
|
|
60
60
|
}
|
|
@@ -50,7 +50,7 @@ export type SideNavItemEventMap = HTMLElementEventMap & SideNavItemCustomEventMa
|
|
|
50
50
|
* <vaadin-side-nav-item>
|
|
51
51
|
* <vaadin-icon icon="vaadin:chart" slot="prefix"></vaadin-icon>
|
|
52
52
|
* Item
|
|
53
|
-
* <
|
|
53
|
+
* <vaadin-badge slot="suffix">Suffix</vaadin-badge>
|
|
54
54
|
* </vaadin-side-nav-item>
|
|
55
55
|
* ```
|
|
56
56
|
*
|
|
@@ -48,7 +48,7 @@ import { SideNavChildrenMixin } from './vaadin-side-nav-children-mixin.js';
|
|
|
48
48
|
* <vaadin-side-nav-item>
|
|
49
49
|
* <vaadin-icon icon="vaadin:chart" slot="prefix"></vaadin-icon>
|
|
50
50
|
* Item
|
|
51
|
-
* <
|
|
51
|
+
* <vaadin-badge slot="suffix">Suffix</vaadin-badge>
|
|
52
52
|
* </vaadin-side-nav-item>
|
|
53
53
|
* ```
|
|
54
54
|
*
|
|
@@ -95,7 +95,9 @@ class SideNavItem extends SideNavChildrenMixin(
|
|
|
95
95
|
/**
|
|
96
96
|
* The path to navigate to
|
|
97
97
|
*/
|
|
98
|
-
path:
|
|
98
|
+
path: {
|
|
99
|
+
type: String,
|
|
100
|
+
},
|
|
99
101
|
|
|
100
102
|
/**
|
|
101
103
|
* The list of alternative paths matching this item
|
|
@@ -110,7 +112,6 @@ class SideNavItem extends SideNavChildrenMixin(
|
|
|
110
112
|
/**
|
|
111
113
|
* Whether to show the child items or not
|
|
112
114
|
*
|
|
113
|
-
* @type {boolean}
|
|
114
115
|
*/
|
|
115
116
|
expanded: {
|
|
116
117
|
type: Boolean,
|
|
@@ -129,7 +130,6 @@ class SideNavItem extends SideNavChildrenMixin(
|
|
|
129
130
|
* Note that this only affects matching of the URLs path, not the base
|
|
130
131
|
* origin or query parameters.
|
|
131
132
|
*
|
|
132
|
-
* @type {boolean}
|
|
133
133
|
* @attr {boolean} match-nested
|
|
134
134
|
*/
|
|
135
135
|
matchNested: {
|
|
@@ -149,7 +149,6 @@ class SideNavItem extends SideNavChildrenMixin(
|
|
|
149
149
|
* The state is updated when the item is added to the DOM or when the browser
|
|
150
150
|
* navigates to a new page.
|
|
151
151
|
*
|
|
152
|
-
* @type {boolean}
|
|
153
152
|
*/
|
|
154
153
|
current: {
|
|
155
154
|
type: Boolean,
|
|
@@ -161,7 +160,9 @@ class SideNavItem extends SideNavChildrenMixin(
|
|
|
161
160
|
/**
|
|
162
161
|
* The target of the link. Works only when `path` is set.
|
|
163
162
|
*/
|
|
164
|
-
target:
|
|
163
|
+
target: {
|
|
164
|
+
type: String,
|
|
165
|
+
},
|
|
165
166
|
|
|
166
167
|
/**
|
|
167
168
|
* Whether to exclude the item from client-side routing. When enabled,
|
|
@@ -169,7 +170,6 @@ class SideNavItem extends SideNavChildrenMixin(
|
|
|
169
170
|
* page reload. This only works with supported routers, such as the one
|
|
170
171
|
* provided in Vaadin apps, or when using the side nav `onNavigate` hook.
|
|
171
172
|
*
|
|
172
|
-
* @type {boolean}
|
|
173
173
|
* @attr {boolean} router-ignore
|
|
174
174
|
*/
|
|
175
175
|
routerIgnore: {
|
package/src/vaadin-side-nav.js
CHANGED
|
@@ -89,7 +89,6 @@ class SideNav extends SideNavChildrenMixin(
|
|
|
89
89
|
/**
|
|
90
90
|
* Whether the side nav is collapsible. When enabled, the toggle icon is shown.
|
|
91
91
|
*
|
|
92
|
-
* @type {boolean}
|
|
93
92
|
*/
|
|
94
93
|
collapsible: {
|
|
95
94
|
type: Boolean,
|
|
@@ -100,7 +99,6 @@ class SideNav extends SideNavChildrenMixin(
|
|
|
100
99
|
/**
|
|
101
100
|
* Whether the side nav is collapsed. When collapsed, the items are hidden.
|
|
102
101
|
*
|
|
103
|
-
* @type {boolean}
|
|
104
102
|
*/
|
|
105
103
|
collapsed: {
|
|
106
104
|
type: Boolean,
|
package/web-types.json
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/web-types",
|
|
3
3
|
"name": "@vaadin/side-nav",
|
|
4
|
-
"version": "25.1.0-
|
|
4
|
+
"version": "25.1.0-beta3",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
8
8
|
"elements": [
|
|
9
9
|
{
|
|
10
10
|
"name": "vaadin-side-nav-item",
|
|
11
|
-
"description": "A navigation item to be used within `<vaadin-side-nav>`. Represents a navigation target.\nNot intended to be used separately.\n\n```html\n<vaadin-side-nav-item>\n Item 1\n <vaadin-side-nav-item path=\"/path1\" slot=\"children\">\n Child item 1\n </vaadin-side-nav-item>\n <vaadin-side-nav-item path=\"/path2\" slot=\"children\">\n Child item 2\n </vaadin-side-nav-item>\n</vaadin-side-nav-item>\n```\n\n### Customization\n\nYou can configure the item by using `slot` names.\n\nSlot name | Description\n----------|-------------\n`prefix` | A slot for content before the label (e.g. an icon).\n`suffix` | A slot for content after the label (e.g. an icon).\n\n#### Example\n\n```html\n<vaadin-side-nav-item>\n <vaadin-icon icon=\"vaadin:chart\" slot=\"prefix\"></vaadin-icon>\n Item\n <
|
|
11
|
+
"description": "A navigation item to be used within `<vaadin-side-nav>`. Represents a navigation target.\nNot intended to be used separately.\n\n```html\n<vaadin-side-nav-item>\n Item 1\n <vaadin-side-nav-item path=\"/path1\" slot=\"children\">\n Child item 1\n </vaadin-side-nav-item>\n <vaadin-side-nav-item path=\"/path2\" slot=\"children\">\n Child item 2\n </vaadin-side-nav-item>\n</vaadin-side-nav-item>\n```\n\n### Customization\n\nYou can configure the item by using `slot` names.\n\nSlot name | Description\n----------|-------------\n`prefix` | A slot for content before the label (e.g. an icon).\n`suffix` | A slot for content after the label (e.g. an icon).\n\n#### Example\n\n```html\n<vaadin-side-nav-item>\n <vaadin-icon icon=\"vaadin:chart\" slot=\"prefix\"></vaadin-icon>\n Item\n <vaadin-badge slot=\"suffix\">Suffix</vaadin-badge>\n</vaadin-side-nav-item>\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------------|----------------\n`content` | The element that wraps link and toggle button\n`children` | The element that wraps child items\n`link` | The clickable anchor used for navigation\n`toggle-button` | The toggle button\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n---------------|-------------\n`disabled` | Set when the element is disabled.\n`expanded` | Set when the element is expanded.\n`has-children` | Set when the element has child items.\n`has-tooltip` | Set when the element has a slotted tooltip.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
12
12
|
"attributes": [
|
|
13
13
|
{
|
|
14
14
|
"name": "disabled",
|
|
@@ -26,7 +26,9 @@
|
|
|
26
26
|
"description": "Whether to show the child items or not",
|
|
27
27
|
"value": {
|
|
28
28
|
"type": [
|
|
29
|
-
"boolean"
|
|
29
|
+
"boolean",
|
|
30
|
+
"null",
|
|
31
|
+
"undefined"
|
|
30
32
|
]
|
|
31
33
|
}
|
|
32
34
|
},
|
|
@@ -35,7 +37,9 @@
|
|
|
35
37
|
"description": "Whether to also match nested paths / routes. `false` by default.\n\nWhen enabled, an item with the path `/path` is considered current when\nthe browser URL is `/path`, `/path/child`, `/path/child/grandchild`,\netc.\n\nNote that this only affects matching of the URLs path, not the base\norigin or query parameters.",
|
|
36
38
|
"value": {
|
|
37
39
|
"type": [
|
|
38
|
-
"boolean"
|
|
40
|
+
"boolean",
|
|
41
|
+
"null",
|
|
42
|
+
"undefined"
|
|
39
43
|
]
|
|
40
44
|
}
|
|
41
45
|
},
|
|
@@ -55,7 +59,9 @@
|
|
|
55
59
|
"description": "Whether to exclude the item from client-side routing. When enabled,\nthis causes the item to behave like a regular anchor, causing a full\npage reload. This only works with supported routers, such as the one\nprovided in Vaadin apps, or when using the side nav `onNavigate` hook.",
|
|
56
60
|
"value": {
|
|
57
61
|
"type": [
|
|
58
|
-
"boolean"
|
|
62
|
+
"boolean",
|
|
63
|
+
"null",
|
|
64
|
+
"undefined"
|
|
59
65
|
]
|
|
60
66
|
}
|
|
61
67
|
},
|
|
@@ -100,7 +106,9 @@
|
|
|
100
106
|
"description": "Whether to show the child items or not",
|
|
101
107
|
"value": {
|
|
102
108
|
"type": [
|
|
103
|
-
"boolean"
|
|
109
|
+
"boolean",
|
|
110
|
+
"null",
|
|
111
|
+
"undefined"
|
|
104
112
|
]
|
|
105
113
|
}
|
|
106
114
|
},
|
|
@@ -109,7 +117,7 @@
|
|
|
109
117
|
"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 toggle: 'Toggle child items'\n}\n```",
|
|
110
118
|
"value": {
|
|
111
119
|
"type": [
|
|
112
|
-
"
|
|
120
|
+
"?"
|
|
113
121
|
]
|
|
114
122
|
}
|
|
115
123
|
},
|
|
@@ -118,7 +126,9 @@
|
|
|
118
126
|
"description": "Whether to also match nested paths / routes. `false` by default.\n\nWhen enabled, an item with the path `/path` is considered current when\nthe browser URL is `/path`, `/path/child`, `/path/child/grandchild`,\netc.\n\nNote that this only affects matching of the URLs path, not the base\norigin or query parameters.",
|
|
119
127
|
"value": {
|
|
120
128
|
"type": [
|
|
121
|
-
"boolean"
|
|
129
|
+
"boolean",
|
|
130
|
+
"null",
|
|
131
|
+
"undefined"
|
|
122
132
|
]
|
|
123
133
|
}
|
|
124
134
|
},
|
|
@@ -147,7 +157,9 @@
|
|
|
147
157
|
"description": "Whether to exclude the item from client-side routing. When enabled,\nthis causes the item to behave like a regular anchor, causing a full\npage reload. This only works with supported routers, such as the one\nprovided in Vaadin apps, or when using the side nav `onNavigate` hook.",
|
|
148
158
|
"value": {
|
|
149
159
|
"type": [
|
|
150
|
-
"boolean"
|
|
160
|
+
"boolean",
|
|
161
|
+
"null",
|
|
162
|
+
"undefined"
|
|
151
163
|
]
|
|
152
164
|
}
|
|
153
165
|
},
|
|
@@ -180,7 +192,9 @@
|
|
|
180
192
|
"description": "Whether the side nav is collapsed. When collapsed, the items are hidden.",
|
|
181
193
|
"value": {
|
|
182
194
|
"type": [
|
|
183
|
-
"boolean"
|
|
195
|
+
"boolean",
|
|
196
|
+
"null",
|
|
197
|
+
"undefined"
|
|
184
198
|
]
|
|
185
199
|
}
|
|
186
200
|
},
|
|
@@ -189,7 +203,9 @@
|
|
|
189
203
|
"description": "Whether the side nav is collapsible. When enabled, the toggle icon is shown.",
|
|
190
204
|
"value": {
|
|
191
205
|
"type": [
|
|
192
|
-
"boolean"
|
|
206
|
+
"boolean",
|
|
207
|
+
"null",
|
|
208
|
+
"undefined"
|
|
193
209
|
]
|
|
194
210
|
}
|
|
195
211
|
},
|
|
@@ -242,7 +258,9 @@
|
|
|
242
258
|
"description": "Whether the side nav is collapsed. When collapsed, the items are hidden.",
|
|
243
259
|
"value": {
|
|
244
260
|
"type": [
|
|
245
|
-
"boolean"
|
|
261
|
+
"boolean",
|
|
262
|
+
"null",
|
|
263
|
+
"undefined"
|
|
246
264
|
]
|
|
247
265
|
}
|
|
248
266
|
},
|
|
@@ -251,7 +269,9 @@
|
|
|
251
269
|
"description": "Whether the side nav is collapsible. When enabled, the toggle icon is shown.",
|
|
252
270
|
"value": {
|
|
253
271
|
"type": [
|
|
254
|
-
"boolean"
|
|
272
|
+
"boolean",
|
|
273
|
+
"null",
|
|
274
|
+
"undefined"
|
|
255
275
|
]
|
|
256
276
|
}
|
|
257
277
|
},
|
|
@@ -260,7 +280,7 @@
|
|
|
260
280
|
"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 toggle: 'Toggle child items'\n}\n```",
|
|
261
281
|
"value": {
|
|
262
282
|
"type": [
|
|
263
|
-
"
|
|
283
|
+
"?"
|
|
264
284
|
]
|
|
265
285
|
}
|
|
266
286
|
},
|
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/side-nav",
|
|
4
|
-
"version": "25.1.0-
|
|
4
|
+
"version": "25.1.0-beta3",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"framework": "lit",
|
|
7
7
|
"framework-config": {
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"elements": [
|
|
17
17
|
{
|
|
18
18
|
"name": "vaadin-side-nav-item",
|
|
19
|
-
"description": "A navigation item to be used within `<vaadin-side-nav>`. Represents a navigation target.\nNot intended to be used separately.\n\n```html\n<vaadin-side-nav-item>\n Item 1\n <vaadin-side-nav-item path=\"/path1\" slot=\"children\">\n Child item 1\n </vaadin-side-nav-item>\n <vaadin-side-nav-item path=\"/path2\" slot=\"children\">\n Child item 2\n </vaadin-side-nav-item>\n</vaadin-side-nav-item>\n```\n\n### Customization\n\nYou can configure the item by using `slot` names.\n\nSlot name | Description\n----------|-------------\n`prefix` | A slot for content before the label (e.g. an icon).\n`suffix` | A slot for content after the label (e.g. an icon).\n\n#### Example\n\n```html\n<vaadin-side-nav-item>\n <vaadin-icon icon=\"vaadin:chart\" slot=\"prefix\"></vaadin-icon>\n Item\n <
|
|
19
|
+
"description": "A navigation item to be used within `<vaadin-side-nav>`. Represents a navigation target.\nNot intended to be used separately.\n\n```html\n<vaadin-side-nav-item>\n Item 1\n <vaadin-side-nav-item path=\"/path1\" slot=\"children\">\n Child item 1\n </vaadin-side-nav-item>\n <vaadin-side-nav-item path=\"/path2\" slot=\"children\">\n Child item 2\n </vaadin-side-nav-item>\n</vaadin-side-nav-item>\n```\n\n### Customization\n\nYou can configure the item by using `slot` names.\n\nSlot name | Description\n----------|-------------\n`prefix` | A slot for content before the label (e.g. an icon).\n`suffix` | A slot for content after the label (e.g. an icon).\n\n#### Example\n\n```html\n<vaadin-side-nav-item>\n <vaadin-icon icon=\"vaadin:chart\" slot=\"prefix\"></vaadin-icon>\n Item\n <vaadin-badge slot=\"suffix\">Suffix</vaadin-badge>\n</vaadin-side-nav-item>\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------------|----------------\n`content` | The element that wraps link and toggle button\n`children` | The element that wraps child items\n`link` | The clickable anchor used for navigation\n`toggle-button` | The toggle button\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n---------------|-------------\n`disabled` | Set when the element is disabled.\n`expanded` | Set when the element is expanded.\n`has-children` | Set when the element has child items.\n`has-tooltip` | Set when the element has a slotted tooltip.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
20
20
|
"extension": true,
|
|
21
21
|
"attributes": [
|
|
22
22
|
{
|