@vaadin/avatar-group 25.3.0-alpha6 → 25.3.0-alpha8
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 +33 -26
- package/package.json +13 -13
- package/src/vaadin-avatar-group-menu-item.js +1 -0
- package/src/vaadin-avatar-group-menu.js +1 -0
- package/src/vaadin-avatar-group-overlay.js +1 -0
- package/src/vaadin-avatar-group.js +1 -0
- package/web-types.json +4 -6
- package/web-types.lit.json +3 -3
package/custom-elements.json
CHANGED
|
@@ -163,6 +163,39 @@
|
|
|
163
163
|
}
|
|
164
164
|
}
|
|
165
165
|
],
|
|
166
|
+
"attributes": [
|
|
167
|
+
{
|
|
168
|
+
"name": "i18n",
|
|
169
|
+
"type": {
|
|
170
|
+
"text": "Object"
|
|
171
|
+
},
|
|
172
|
+
"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.",
|
|
173
|
+
"fieldName": "i18n",
|
|
174
|
+
"inheritedFrom": {
|
|
175
|
+
"name": "I18nMixin",
|
|
176
|
+
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
177
|
+
}
|
|
178
|
+
},
|
|
179
|
+
{
|
|
180
|
+
"name": "max-items-visible",
|
|
181
|
+
"type": {
|
|
182
|
+
"text": "number"
|
|
183
|
+
},
|
|
184
|
+
"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.",
|
|
185
|
+
"fieldName": "maxItemsVisible",
|
|
186
|
+
"inheritedFrom": {
|
|
187
|
+
"name": "AvatarGroupMixin",
|
|
188
|
+
"module": "src/vaadin-avatar-group-mixin.js"
|
|
189
|
+
}
|
|
190
|
+
},
|
|
191
|
+
{
|
|
192
|
+
"type": {
|
|
193
|
+
"text": "string"
|
|
194
|
+
},
|
|
195
|
+
"description": "The theme variants to apply to the component.",
|
|
196
|
+
"name": "theme"
|
|
197
|
+
}
|
|
198
|
+
],
|
|
166
199
|
"mixins": [
|
|
167
200
|
{
|
|
168
201
|
"name": "AvatarGroupMixin",
|
|
@@ -191,32 +224,6 @@
|
|
|
191
224
|
},
|
|
192
225
|
"tagName": "vaadin-avatar-group",
|
|
193
226
|
"customElement": true,
|
|
194
|
-
"attributes": [
|
|
195
|
-
{
|
|
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",
|
|
202
|
-
"inheritedFrom": {
|
|
203
|
-
"name": "I18nMixin",
|
|
204
|
-
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
205
|
-
}
|
|
206
|
-
},
|
|
207
|
-
{
|
|
208
|
-
"name": "max-items-visible",
|
|
209
|
-
"type": {
|
|
210
|
-
"text": "number"
|
|
211
|
-
},
|
|
212
|
-
"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.",
|
|
213
|
-
"fieldName": "maxItemsVisible",
|
|
214
|
-
"inheritedFrom": {
|
|
215
|
-
"name": "AvatarGroupMixin",
|
|
216
|
-
"module": "src/vaadin-avatar-group-mixin.js"
|
|
217
|
-
}
|
|
218
|
-
}
|
|
219
|
-
],
|
|
220
227
|
"events": []
|
|
221
228
|
}
|
|
222
229
|
],
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/avatar-group",
|
|
3
|
-
"version": "25.3.0-
|
|
3
|
+
"version": "25.3.0-alpha8",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -36,21 +36,21 @@
|
|
|
36
36
|
],
|
|
37
37
|
"dependencies": {
|
|
38
38
|
"@open-wc/dedupe-mixin": "^1.3.0",
|
|
39
|
-
"@vaadin/a11y-base": "25.3.0-
|
|
40
|
-
"@vaadin/avatar": "25.3.0-
|
|
41
|
-
"@vaadin/component-base": "25.3.0-
|
|
42
|
-
"@vaadin/item": "25.3.0-
|
|
43
|
-
"@vaadin/overlay": "25.3.0-
|
|
44
|
-
"@vaadin/tooltip": "25.3.0-
|
|
45
|
-
"@vaadin/vaadin-themable-mixin": "25.3.0-
|
|
39
|
+
"@vaadin/a11y-base": "25.3.0-alpha8",
|
|
40
|
+
"@vaadin/avatar": "25.3.0-alpha8",
|
|
41
|
+
"@vaadin/component-base": "25.3.0-alpha8",
|
|
42
|
+
"@vaadin/item": "25.3.0-alpha8",
|
|
43
|
+
"@vaadin/overlay": "25.3.0-alpha8",
|
|
44
|
+
"@vaadin/tooltip": "25.3.0-alpha8",
|
|
45
|
+
"@vaadin/vaadin-themable-mixin": "25.3.0-alpha8",
|
|
46
46
|
"lit": "^3.0.0"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
|
-
"@vaadin/aura": "25.3.0-
|
|
50
|
-
"@vaadin/chai-plugins": "25.3.0-
|
|
51
|
-
"@vaadin/test-runner-commands": "25.3.0-
|
|
49
|
+
"@vaadin/aura": "25.3.0-alpha8",
|
|
50
|
+
"@vaadin/chai-plugins": "25.3.0-alpha8",
|
|
51
|
+
"@vaadin/test-runner-commands": "25.3.0-alpha8",
|
|
52
52
|
"@vaadin/testing-helpers": "^2.0.0",
|
|
53
|
-
"@vaadin/vaadin-lumo-styles": "25.3.0-
|
|
53
|
+
"@vaadin/vaadin-lumo-styles": "25.3.0-alpha8",
|
|
54
54
|
"sinon": "^22.0.0"
|
|
55
55
|
},
|
|
56
56
|
"customElements": "custom-elements.json",
|
|
@@ -58,5 +58,5 @@
|
|
|
58
58
|
"web-types.json",
|
|
59
59
|
"web-types.lit.json"
|
|
60
60
|
],
|
|
61
|
-
"gitHead": "
|
|
61
|
+
"gitHead": "ccbb4aaffb63c745c6da0426b532d4d05e47af29"
|
|
62
62
|
}
|
|
@@ -15,6 +15,7 @@ import { avatarGroupMenuItemStyles } from './styles/vaadin-avatar-group-menu-ite
|
|
|
15
15
|
/**
|
|
16
16
|
* An element used internally by `<vaadin-avatar-group>`. Not intended to be used separately.
|
|
17
17
|
*
|
|
18
|
+
* @attr {string} theme - The theme variants to apply to the component.
|
|
18
19
|
* @customElement vaadin-avatar-group-menu-item
|
|
19
20
|
* @extends HTMLElement
|
|
20
21
|
* @protected
|
|
@@ -15,6 +15,7 @@ import { avatarGroupMenuStyles } from './styles/vaadin-avatar-group-menu-base-st
|
|
|
15
15
|
/**
|
|
16
16
|
* An element used internally by `<vaadin-avatar-group>`. Not intended to be used separately.
|
|
17
17
|
*
|
|
18
|
+
* @attr {string} theme - The theme variants to apply to the component.
|
|
18
19
|
* @customElement vaadin-avatar-group-menu
|
|
19
20
|
* @extends HTMLElement
|
|
20
21
|
* @protected
|
|
@@ -16,6 +16,7 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
|
|
|
16
16
|
/**
|
|
17
17
|
* An element used internally by `<vaadin-avatar-group>`. Not intended to be used separately.
|
|
18
18
|
*
|
|
19
|
+
* @attr {string} theme - The theme variants to apply to the component.
|
|
19
20
|
* @customElement vaadin-avatar-group-overlay
|
|
20
21
|
* @extends HTMLElement
|
|
21
22
|
* @private
|
|
@@ -65,6 +65,7 @@ import { AvatarGroupMixin } from './vaadin-avatar-group-mixin.js';
|
|
|
65
65
|
* - `<vaadin-avatar-group-menu>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).
|
|
66
66
|
* - `<vaadin-avatar-group-menu-item>` - has the same API as [`<vaadin-item>`](#/elements/vaadin-item).
|
|
67
67
|
*
|
|
68
|
+
* @attr {string} theme - The theme variants to apply to the component.
|
|
68
69
|
* @customElement vaadin-avatar-group
|
|
69
70
|
* @extends HTMLElement
|
|
70
71
|
*/
|
package/web-types.json
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/web-types",
|
|
3
3
|
"name": "@vaadin/avatar-group",
|
|
4
|
-
"version": "25.3.0-
|
|
4
|
+
"version": "25.3.0-alpha8",
|
|
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.3.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.3.0-alpha8/#/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\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:----------------------------------|\n| `--vaadin-avatar-group-gap` |\n| `--vaadin-avatar-group-overlap` |\n\nSee the [`<vaadin-avatar>`](https://cdn.vaadin.com/vaadin-web-components/25.3.0-alpha8/#/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.3.0-alpha8/#/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.3.0-alpha8/#/elements/vaadin-item).",
|
|
12
12
|
"attributes": [
|
|
13
13
|
{
|
|
14
14
|
"name": "max-items-visible",
|
|
@@ -24,9 +24,7 @@
|
|
|
24
24
|
"description": "The theme variants to apply to the component.",
|
|
25
25
|
"value": {
|
|
26
26
|
"type": [
|
|
27
|
-
"string"
|
|
28
|
-
"null",
|
|
29
|
-
"undefined"
|
|
27
|
+
"string"
|
|
30
28
|
]
|
|
31
29
|
}
|
|
32
30
|
}
|
|
@@ -44,7 +42,7 @@
|
|
|
44
42
|
},
|
|
45
43
|
{
|
|
46
44
|
"name": "items",
|
|
47
|
-
"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.3.0-
|
|
45
|
+
"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.3.0-alpha8/#/elements/vaadin-avatar#property-name),\n[`abbr`](https://cdn.vaadin.com/vaadin-web-components/25.3.0-alpha8/#/elements/vaadin-avatar#property-abbr), [`img`](#/elements/vaadin-avatar#property-img)\nand [`colorIndex`](https://cdn.vaadin.com/vaadin-web-components/25.3.0-alpha8/#/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```",
|
|
48
46
|
"value": {
|
|
49
47
|
"type": [
|
|
50
48
|
"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.3.0-
|
|
4
|
+
"version": "25.3.0-alpha8",
|
|
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.3.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.3.0-alpha8/#/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\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:----------------------------------|\n| `--vaadin-avatar-group-gap` |\n| `--vaadin-avatar-group-overlap` |\n\nSee the [`<vaadin-avatar>`](https://cdn.vaadin.com/vaadin-web-components/25.3.0-alpha8/#/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.3.0-alpha8/#/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.3.0-alpha8/#/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.3.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.3.0-alpha8/#/elements/vaadin-avatar#property-name),\n[`abbr`](https://cdn.vaadin.com/vaadin-web-components/25.3.0-alpha8/#/elements/vaadin-avatar#property-abbr), [`img`](#/elements/vaadin-avatar#property-img)\nand [`colorIndex`](https://cdn.vaadin.com/vaadin-web-components/25.3.0-alpha8/#/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
|
}
|