@vaadin/avatar-group 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/custom-elements.json +24 -279
- package/package.json +14 -14
- package/src/vaadin-avatar-group-mixin.js +1 -1
- package/web-types.json +15 -4
- package/web-types.lit.json +3 -3
package/custom-elements.json
CHANGED
|
@@ -17,253 +17,6 @@
|
|
|
17
17
|
}
|
|
18
18
|
]
|
|
19
19
|
},
|
|
20
|
-
{
|
|
21
|
-
"kind": "javascript-module",
|
|
22
|
-
"path": "src/vaadin-avatar-group-menu-item.js",
|
|
23
|
-
"declarations": [
|
|
24
|
-
{
|
|
25
|
-
"kind": "class",
|
|
26
|
-
"description": "An element used internally by `<vaadin-avatar-group>`. Not intended to be used separately.",
|
|
27
|
-
"name": "AvatarGroupMenuItem",
|
|
28
|
-
"members": [
|
|
29
|
-
{
|
|
30
|
-
"kind": "field",
|
|
31
|
-
"name": "selected",
|
|
32
|
-
"privacy": "public",
|
|
33
|
-
"type": {
|
|
34
|
-
"text": "boolean"
|
|
35
|
-
},
|
|
36
|
-
"description": "If true, the item is in selected state.",
|
|
37
|
-
"attribute": "selected",
|
|
38
|
-
"inheritedFrom": {
|
|
39
|
-
"name": "ItemMixin",
|
|
40
|
-
"package": "@vaadin/item/src/vaadin-item-mixin.js"
|
|
41
|
-
}
|
|
42
|
-
},
|
|
43
|
-
{
|
|
44
|
-
"kind": "field",
|
|
45
|
-
"name": "value",
|
|
46
|
-
"return": {
|
|
47
|
-
"type": {
|
|
48
|
-
"text": "string"
|
|
49
|
-
}
|
|
50
|
-
},
|
|
51
|
-
"parameters": [
|
|
52
|
-
{
|
|
53
|
-
"name": "value",
|
|
54
|
-
"type": {
|
|
55
|
-
"text": "string"
|
|
56
|
-
}
|
|
57
|
-
}
|
|
58
|
-
],
|
|
59
|
-
"inheritedFrom": {
|
|
60
|
-
"name": "ItemMixin",
|
|
61
|
-
"package": "@vaadin/item/src/vaadin-item-mixin.js"
|
|
62
|
-
}
|
|
63
|
-
}
|
|
64
|
-
],
|
|
65
|
-
"mixins": [
|
|
66
|
-
{
|
|
67
|
-
"name": "ItemMixin",
|
|
68
|
-
"package": "@vaadin/item/src/vaadin-item-mixin.js"
|
|
69
|
-
},
|
|
70
|
-
{
|
|
71
|
-
"name": "ThemableMixin",
|
|
72
|
-
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
73
|
-
},
|
|
74
|
-
{
|
|
75
|
-
"name": "DirMixin",
|
|
76
|
-
"package": "@vaadin/component-base/src/dir-mixin.js"
|
|
77
|
-
},
|
|
78
|
-
{
|
|
79
|
-
"name": "PolylitMixin",
|
|
80
|
-
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
81
|
-
},
|
|
82
|
-
{
|
|
83
|
-
"name": "LumoInjectionMixin",
|
|
84
|
-
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
85
|
-
}
|
|
86
|
-
],
|
|
87
|
-
"superclass": {
|
|
88
|
-
"name": "LitElement",
|
|
89
|
-
"package": "lit"
|
|
90
|
-
},
|
|
91
|
-
"tagName": "vaadin-avatar-group-menu-item",
|
|
92
|
-
"customElement": true,
|
|
93
|
-
"attributes": [
|
|
94
|
-
{
|
|
95
|
-
"name": "selected",
|
|
96
|
-
"type": {
|
|
97
|
-
"text": "boolean"
|
|
98
|
-
},
|
|
99
|
-
"description": "If true, the item is in selected state.",
|
|
100
|
-
"fieldName": "selected",
|
|
101
|
-
"inheritedFrom": {
|
|
102
|
-
"name": "ItemMixin",
|
|
103
|
-
"package": "@vaadin/item/src/vaadin-item-mixin.js"
|
|
104
|
-
}
|
|
105
|
-
}
|
|
106
|
-
],
|
|
107
|
-
"events": []
|
|
108
|
-
}
|
|
109
|
-
],
|
|
110
|
-
"exports": [
|
|
111
|
-
{
|
|
112
|
-
"kind": "js",
|
|
113
|
-
"name": "AvatarGroupMenuItem",
|
|
114
|
-
"declaration": {
|
|
115
|
-
"name": "AvatarGroupMenuItem",
|
|
116
|
-
"module": "src/vaadin-avatar-group-menu-item.js"
|
|
117
|
-
}
|
|
118
|
-
}
|
|
119
|
-
]
|
|
120
|
-
},
|
|
121
|
-
{
|
|
122
|
-
"kind": "javascript-module",
|
|
123
|
-
"path": "src/vaadin-avatar-group-menu.js",
|
|
124
|
-
"declarations": [
|
|
125
|
-
{
|
|
126
|
-
"kind": "class",
|
|
127
|
-
"description": "An element used internally by `<vaadin-avatar-group>`. Not intended to be used separately.",
|
|
128
|
-
"name": "AvatarGroupMenu",
|
|
129
|
-
"members": [
|
|
130
|
-
{
|
|
131
|
-
"kind": "field",
|
|
132
|
-
"name": "disabled",
|
|
133
|
-
"privacy": "public",
|
|
134
|
-
"type": {
|
|
135
|
-
"text": "boolean"
|
|
136
|
-
},
|
|
137
|
-
"description": "If true, the user cannot interact with this element.\nWhen the element is disabled, the selected item is\nnot updated when `selected` property is changed.",
|
|
138
|
-
"attribute": "disabled",
|
|
139
|
-
"inheritedFrom": {
|
|
140
|
-
"name": "ListMixin",
|
|
141
|
-
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
142
|
-
}
|
|
143
|
-
},
|
|
144
|
-
{
|
|
145
|
-
"kind": "field",
|
|
146
|
-
"name": "items",
|
|
147
|
-
"privacy": "public",
|
|
148
|
-
"type": {
|
|
149
|
-
"text": "!Array<!Element> | undefined"
|
|
150
|
-
},
|
|
151
|
-
"description": "A read-only list of items from which a selection can be made.\nIt is populated from the elements passed to the light DOM,\nand updated dynamically when adding or removing items.",
|
|
152
|
-
"attribute": "items",
|
|
153
|
-
"inheritedFrom": {
|
|
154
|
-
"name": "ListMixin",
|
|
155
|
-
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
156
|
-
}
|
|
157
|
-
},
|
|
158
|
-
{
|
|
159
|
-
"kind": "field",
|
|
160
|
-
"name": "orientation",
|
|
161
|
-
"privacy": "public",
|
|
162
|
-
"type": {
|
|
163
|
-
"text": "!ListOrientation"
|
|
164
|
-
},
|
|
165
|
-
"description": "Define how items are disposed in the dom.\nPossible values are: `horizontal|vertical`.\nIt also changes navigation keys from left/right to up/down.",
|
|
166
|
-
"attribute": "orientation",
|
|
167
|
-
"inheritedFrom": {
|
|
168
|
-
"name": "ListMixin",
|
|
169
|
-
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
170
|
-
}
|
|
171
|
-
},
|
|
172
|
-
{
|
|
173
|
-
"kind": "field",
|
|
174
|
-
"name": "selected",
|
|
175
|
-
"privacy": "public",
|
|
176
|
-
"type": {
|
|
177
|
-
"text": "number"
|
|
178
|
-
},
|
|
179
|
-
"description": "The index of the item selected in the items array.\nNote: Not updated when used in `multiple` selection mode.",
|
|
180
|
-
"attribute": "selected",
|
|
181
|
-
"inheritedFrom": {
|
|
182
|
-
"name": "ListMixin",
|
|
183
|
-
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
184
|
-
}
|
|
185
|
-
}
|
|
186
|
-
],
|
|
187
|
-
"attributes": [
|
|
188
|
-
{
|
|
189
|
-
"name": "disabled",
|
|
190
|
-
"type": {
|
|
191
|
-
"text": "boolean"
|
|
192
|
-
},
|
|
193
|
-
"description": "If true, the user cannot interact with this element.\nWhen the element is disabled, the selected item is\nnot updated when `selected` property is changed.",
|
|
194
|
-
"fieldName": "disabled",
|
|
195
|
-
"inheritedFrom": {
|
|
196
|
-
"name": "ListMixin",
|
|
197
|
-
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
198
|
-
}
|
|
199
|
-
},
|
|
200
|
-
{
|
|
201
|
-
"name": "orientation",
|
|
202
|
-
"type": {
|
|
203
|
-
"text": "!ListOrientation"
|
|
204
|
-
},
|
|
205
|
-
"description": "Define how items are disposed in the dom.\nPossible values are: `horizontal|vertical`.\nIt also changes navigation keys from left/right to up/down.",
|
|
206
|
-
"fieldName": "orientation",
|
|
207
|
-
"inheritedFrom": {
|
|
208
|
-
"name": "ListMixin",
|
|
209
|
-
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
210
|
-
}
|
|
211
|
-
},
|
|
212
|
-
{
|
|
213
|
-
"name": "selected",
|
|
214
|
-
"type": {
|
|
215
|
-
"text": "number"
|
|
216
|
-
},
|
|
217
|
-
"description": "The index of the item selected in the items array.\nNote: Not updated when used in `multiple` selection mode.",
|
|
218
|
-
"fieldName": "selected",
|
|
219
|
-
"inheritedFrom": {
|
|
220
|
-
"name": "ListMixin",
|
|
221
|
-
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
222
|
-
}
|
|
223
|
-
}
|
|
224
|
-
],
|
|
225
|
-
"mixins": [
|
|
226
|
-
{
|
|
227
|
-
"name": "ListMixin",
|
|
228
|
-
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
229
|
-
},
|
|
230
|
-
{
|
|
231
|
-
"name": "ThemableMixin",
|
|
232
|
-
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
233
|
-
},
|
|
234
|
-
{
|
|
235
|
-
"name": "DirMixin",
|
|
236
|
-
"package": "@vaadin/component-base/src/dir-mixin.js"
|
|
237
|
-
},
|
|
238
|
-
{
|
|
239
|
-
"name": "PolylitMixin",
|
|
240
|
-
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
241
|
-
},
|
|
242
|
-
{
|
|
243
|
-
"name": "LumoInjectionMixin",
|
|
244
|
-
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
245
|
-
}
|
|
246
|
-
],
|
|
247
|
-
"superclass": {
|
|
248
|
-
"name": "LitElement",
|
|
249
|
-
"package": "lit"
|
|
250
|
-
},
|
|
251
|
-
"tagName": "vaadin-avatar-group-menu",
|
|
252
|
-
"customElement": true,
|
|
253
|
-
"events": []
|
|
254
|
-
}
|
|
255
|
-
],
|
|
256
|
-
"exports": [
|
|
257
|
-
{
|
|
258
|
-
"kind": "js",
|
|
259
|
-
"name": "AvatarGroupMenu",
|
|
260
|
-
"declaration": {
|
|
261
|
-
"name": "AvatarGroupMenu",
|
|
262
|
-
"module": "src/vaadin-avatar-group-menu.js"
|
|
263
|
-
}
|
|
264
|
-
}
|
|
265
|
-
]
|
|
266
|
-
},
|
|
267
20
|
{
|
|
268
21
|
"kind": "javascript-module",
|
|
269
22
|
"path": "src/vaadin-avatar-group-mixin.js",
|
|
@@ -276,20 +29,12 @@
|
|
|
276
29
|
{
|
|
277
30
|
"kind": "field",
|
|
278
31
|
"name": "i18n",
|
|
279
|
-
"
|
|
280
|
-
"
|
|
281
|
-
"
|
|
282
|
-
"text": "!AvatarGroupI18n"
|
|
283
|
-
}
|
|
32
|
+
"privacy": "public",
|
|
33
|
+
"type": {
|
|
34
|
+
"text": "Object"
|
|
284
35
|
},
|
|
285
|
-
"
|
|
286
|
-
|
|
287
|
-
"name": "value",
|
|
288
|
-
"type": {
|
|
289
|
-
"text": "Object"
|
|
290
|
-
}
|
|
291
|
-
}
|
|
292
|
-
],
|
|
36
|
+
"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 JSON structure and default values:\n```js\n{\n // Translation of the anonymous user avatar tooltip.\n anonymous: 'anonymous',\n // Translation of the avatar group accessible label.\n // {count} is replaced with the actual count of users.\n activeUsers: {\n one: 'Currently one active user',\n many: 'Currently {count} active users'\n },\n // Screen reader announcement when user joins group.\n // {user} is replaced with the name or abbreviation.\n // When neither is set, \"anonymous\" is used instead.\n joined: '{user} joined',\n // Screen reader announcement when user leaves group.\n // {user} is replaced with the name or abbreviation.\n // When neither is set, \"anonymous\" is used instead.\n left: '{user} left'\n}\n```",
|
|
37
|
+
"attribute": "i18n",
|
|
293
38
|
"inheritedFrom": {
|
|
294
39
|
"name": "I18nMixin",
|
|
295
40
|
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
@@ -319,6 +64,11 @@
|
|
|
319
64
|
"attributes": [
|
|
320
65
|
{
|
|
321
66
|
"name": "i18n",
|
|
67
|
+
"type": {
|
|
68
|
+
"text": "Object"
|
|
69
|
+
},
|
|
70
|
+
"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.",
|
|
71
|
+
"fieldName": "i18n",
|
|
322
72
|
"inheritedFrom": {
|
|
323
73
|
"name": "I18nMixin",
|
|
324
74
|
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
@@ -337,6 +87,10 @@
|
|
|
337
87
|
{
|
|
338
88
|
"name": "I18nMixin",
|
|
339
89
|
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"name": "ResizeMixin",
|
|
93
|
+
"package": "@vaadin/component-base/src/resize-mixin.js"
|
|
340
94
|
}
|
|
341
95
|
],
|
|
342
96
|
"parameters": [
|
|
@@ -357,12 +111,6 @@
|
|
|
357
111
|
}
|
|
358
112
|
]
|
|
359
113
|
},
|
|
360
|
-
{
|
|
361
|
-
"kind": "javascript-module",
|
|
362
|
-
"path": "src/vaadin-avatar-group-overlay.js",
|
|
363
|
-
"declarations": [],
|
|
364
|
-
"exports": []
|
|
365
|
-
},
|
|
366
114
|
{
|
|
367
115
|
"kind": "javascript-module",
|
|
368
116
|
"path": "src/vaadin-avatar-group.js",
|
|
@@ -375,20 +123,12 @@
|
|
|
375
123
|
{
|
|
376
124
|
"kind": "field",
|
|
377
125
|
"name": "i18n",
|
|
378
|
-
"
|
|
379
|
-
"
|
|
380
|
-
"
|
|
381
|
-
"text": "!AvatarGroupI18n"
|
|
382
|
-
}
|
|
126
|
+
"privacy": "public",
|
|
127
|
+
"type": {
|
|
128
|
+
"text": "Object"
|
|
383
129
|
},
|
|
384
|
-
"
|
|
385
|
-
|
|
386
|
-
"name": "value",
|
|
387
|
-
"type": {
|
|
388
|
-
"text": "Object"
|
|
389
|
-
}
|
|
390
|
-
}
|
|
391
|
-
],
|
|
130
|
+
"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 JSON structure and default values:\n```js\n{\n // Translation of the anonymous user avatar tooltip.\n anonymous: 'anonymous',\n // Translation of the avatar group accessible label.\n // {count} is replaced with the actual count of users.\n activeUsers: {\n one: 'Currently one active user',\n many: 'Currently {count} active users'\n },\n // Screen reader announcement when user joins group.\n // {user} is replaced with the name or abbreviation.\n // When neither is set, \"anonymous\" is used instead.\n joined: '{user} joined',\n // Screen reader announcement when user leaves group.\n // {user} is replaced with the name or abbreviation.\n // When neither is set, \"anonymous\" is used instead.\n left: '{user} left'\n}\n```",
|
|
131
|
+
"attribute": "i18n",
|
|
392
132
|
"inheritedFrom": {
|
|
393
133
|
"name": "I18nMixin",
|
|
394
134
|
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
@@ -454,6 +194,11 @@
|
|
|
454
194
|
"attributes": [
|
|
455
195
|
{
|
|
456
196
|
"name": "i18n",
|
|
197
|
+
"type": {
|
|
198
|
+
"text": "Object"
|
|
199
|
+
},
|
|
200
|
+
"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.",
|
|
201
|
+
"fieldName": "i18n",
|
|
457
202
|
"inheritedFrom": {
|
|
458
203
|
"name": "I18nMixin",
|
|
459
204
|
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/avatar-group",
|
|
3
|
-
"version": "25.1.0-
|
|
3
|
+
"version": "25.1.0-beta3",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -36,27 +36,27 @@
|
|
|
36
36
|
],
|
|
37
37
|
"dependencies": {
|
|
38
38
|
"@open-wc/dedupe-mixin": "^1.3.0",
|
|
39
|
-
"@vaadin/a11y-base": "25.1.0-
|
|
40
|
-
"@vaadin/avatar": "25.1.0-
|
|
41
|
-
"@vaadin/component-base": "25.1.0-
|
|
42
|
-
"@vaadin/item": "25.1.0-
|
|
43
|
-
"@vaadin/overlay": "25.1.0-
|
|
44
|
-
"@vaadin/tooltip": "25.1.0-
|
|
45
|
-
"@vaadin/vaadin-themable-mixin": "25.1.0-
|
|
39
|
+
"@vaadin/a11y-base": "25.1.0-beta3",
|
|
40
|
+
"@vaadin/avatar": "25.1.0-beta3",
|
|
41
|
+
"@vaadin/component-base": "25.1.0-beta3",
|
|
42
|
+
"@vaadin/item": "25.1.0-beta3",
|
|
43
|
+
"@vaadin/overlay": "25.1.0-beta3",
|
|
44
|
+
"@vaadin/tooltip": "25.1.0-beta3",
|
|
45
|
+
"@vaadin/vaadin-themable-mixin": "25.1.0-beta3",
|
|
46
46
|
"lit": "^3.0.0"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
|
-
"@vaadin/aura": "25.1.0-
|
|
50
|
-
"@vaadin/chai-plugins": "25.1.0-
|
|
51
|
-
"@vaadin/test-runner-commands": "25.1.0-
|
|
49
|
+
"@vaadin/aura": "25.1.0-beta3",
|
|
50
|
+
"@vaadin/chai-plugins": "25.1.0-beta3",
|
|
51
|
+
"@vaadin/test-runner-commands": "25.1.0-beta3",
|
|
52
52
|
"@vaadin/testing-helpers": "^2.0.0",
|
|
53
|
-
"@vaadin/vaadin-lumo-styles": "25.1.0-
|
|
54
|
-
"sinon": "^21.0.
|
|
53
|
+
"@vaadin/vaadin-lumo-styles": "25.1.0-beta3",
|
|
54
|
+
"sinon": "^21.0.2"
|
|
55
55
|
},
|
|
56
56
|
"customElements": "custom-elements.json",
|
|
57
57
|
"web-types": [
|
|
58
58
|
"web-types.json",
|
|
59
59
|
"web-types.lit.json"
|
|
60
60
|
],
|
|
61
|
-
"gitHead": "
|
|
61
|
+
"gitHead": "4251850231a42298fda23b83928da588831cdb5d"
|
|
62
62
|
}
|
package/web-types.json
CHANGED
|
@@ -1,15 +1,26 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/web-types",
|
|
3
3
|
"name": "@vaadin/avatar-group",
|
|
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-avatar-group",
|
|
11
|
-
"description": "`<vaadin-avatar-group>` is a Web Component providing avatar group displaying functionality.\n\nTo create the avatar group, first add the component to the page:\n\n```html\n<vaadin-avatar-group></vaadin-avatar-group>\n```\n\nAnd then use [`items`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-
|
|
11
|
+
"description": "`<vaadin-avatar-group>` is a Web Component providing avatar group displaying functionality.\n\nTo create the avatar group, first add the component to the page:\n\n```html\n<vaadin-avatar-group></vaadin-avatar-group>\n```\n\nAnd then use [`items`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-avatar-group#property-items) property to initialize the structure:\n\n```js\ndocument.querySelector('vaadin-avatar-group').items = [\n {name: 'John Doe'},\n {abbr: 'AB'}\n];\n```\n\n### Styling\n\nThe following shadow DOM parts are exposed for styling:\n\nPart name | Description\n----------- | ---------------\n`container` | The container element\n`overlay` | The overflow avatar menu overlay\n`content` | The overflow avatar menu overlay content\n\nSee the [`<vaadin-avatar>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-avatar) documentation for the available\nstate attributes and stylable shadow parts of avatar elements.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.\n\n### Internal components\n\nIn addition to `<vaadin-avatar-group>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-avatar-group-menu>` - has the same API as [`<vaadin-list-box>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-list-box).\n- `<vaadin-avatar-group-menu-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-item).",
|
|
12
12
|
"attributes": [
|
|
13
|
+
{
|
|
14
|
+
"name": "i18n",
|
|
15
|
+
"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.",
|
|
16
|
+
"value": {
|
|
17
|
+
"type": [
|
|
18
|
+
"Object",
|
|
19
|
+
"null",
|
|
20
|
+
"undefined"
|
|
21
|
+
]
|
|
22
|
+
}
|
|
23
|
+
},
|
|
13
24
|
{
|
|
14
25
|
"name": "max-items-visible",
|
|
15
26
|
"description": "The maximum number of avatars to display. By default, all the avatars are displayed.\nWhen _maxItemsVisible_ is set, the overflowing avatars are grouped into one avatar with\na dropdown. Setting 0 or 1 has no effect so there are always at least two avatars visible.",
|
|
@@ -40,13 +51,13 @@
|
|
|
40
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 JSON structure and default values:\n```js\n{\n // Translation of the anonymous user avatar tooltip.\n anonymous: 'anonymous',\n // Translation of the avatar group accessible label.\n // {count} is replaced with the actual count of users.\n activeUsers: {\n one: 'Currently one active user',\n many: 'Currently {count} active users'\n },\n // Screen reader announcement when user joins group.\n // {user} is replaced with the name or abbreviation.\n // When neither is set, \"anonymous\" is used instead.\n joined: '{user} joined',\n // Screen reader announcement when user leaves group.\n // {user} is replaced with the name or abbreviation.\n // When neither is set, \"anonymous\" is used instead.\n left: '{user} left'\n}\n```",
|
|
41
52
|
"value": {
|
|
42
53
|
"type": [
|
|
43
|
-
"
|
|
54
|
+
"?"
|
|
44
55
|
]
|
|
45
56
|
}
|
|
46
57
|
},
|
|
47
58
|
{
|
|
48
59
|
"name": "items",
|
|
49
|
-
"description": "An array containing the items which will be stamped as avatars.\n\nThe items objects allow to configure [`name`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-
|
|
60
|
+
"description": "An array containing the items which will be stamped as avatars.\n\nThe items objects allow to configure [`name`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-avatar#property-name),\n[`abbr`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-avatar#property-abbr), [`img`](#/elements/vaadin-avatar#property-img)\nand [`colorIndex`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-avatar#property-colorIndex) properties on the\nstamped avatars, and set `className` to provide CSS class names.\n\n#### Example\n\n```js\ngroup.items = [\n {\n name: 'User name',\n img: 'url-to-image.png',\n className: 'even'\n },\n {\n abbr: 'JD',\n colorIndex: 1,\n className: 'odd'\n },\n];\n```",
|
|
50
61
|
"value": {
|
|
51
62
|
"type": [
|
|
52
63
|
"Array.<AvatarGroupItem>",
|
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/avatar-group",
|
|
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-avatar-group",
|
|
19
|
-
"description": "`<vaadin-avatar-group>` is a Web Component providing avatar group displaying functionality.\n\nTo create the avatar group, first add the component to the page:\n\n```html\n<vaadin-avatar-group></vaadin-avatar-group>\n```\n\nAnd then use [`items`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-
|
|
19
|
+
"description": "`<vaadin-avatar-group>` is a Web Component providing avatar group displaying functionality.\n\nTo create the avatar group, first add the component to the page:\n\n```html\n<vaadin-avatar-group></vaadin-avatar-group>\n```\n\nAnd then use [`items`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-avatar-group#property-items) property to initialize the structure:\n\n```js\ndocument.querySelector('vaadin-avatar-group').items = [\n {name: 'John Doe'},\n {abbr: 'AB'}\n];\n```\n\n### Styling\n\nThe following shadow DOM parts are exposed for styling:\n\nPart name | Description\n----------- | ---------------\n`container` | The container element\n`overlay` | The overflow avatar menu overlay\n`content` | The overflow avatar menu overlay content\n\nSee the [`<vaadin-avatar>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-avatar) documentation for the available\nstate attributes and stylable shadow parts of avatar elements.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.\n\n### Internal components\n\nIn addition to `<vaadin-avatar-group>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-avatar-group-menu>` - has the same API as [`<vaadin-list-box>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-list-box).\n- `<vaadin-avatar-group-menu-item>` - has the same API as [`<vaadin-item>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-item).",
|
|
20
20
|
"extension": true,
|
|
21
21
|
"attributes": [
|
|
22
22
|
{
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
},
|
|
29
29
|
{
|
|
30
30
|
"name": ".items",
|
|
31
|
-
"description": "An array containing the items which will be stamped as avatars.\n\nThe items objects allow to configure [`name`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-
|
|
31
|
+
"description": "An array containing the items which will be stamped as avatars.\n\nThe items objects allow to configure [`name`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-avatar#property-name),\n[`abbr`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-avatar#property-abbr), [`img`](#/elements/vaadin-avatar#property-img)\nand [`colorIndex`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-avatar#property-colorIndex) properties on the\nstamped avatars, and set `className` to provide CSS class names.\n\n#### Example\n\n```js\ngroup.items = [\n {\n name: 'User name',\n img: 'url-to-image.png',\n className: 'even'\n },\n {\n abbr: 'JD',\n colorIndex: 1,\n className: 'odd'\n },\n];\n```",
|
|
32
32
|
"value": {
|
|
33
33
|
"kind": "expression"
|
|
34
34
|
}
|