@atlaskit/avatar-group 8.5.14 → 8.5.15

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 (6) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/dist/cjs/version.json +1 -1
  3. package/dist/es2019/version.json +1 -1
  4. package/dist/esm/version.json +1 -1
  5. package/dist/types/components/avatar-group.d.ts +8 -10
  6. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @atlaskit/avatar-group
2
2
 
3
+ ## 8.5.15
4
+
5
+ ### Patch Changes
6
+
7
+ - [`efa50ac72ba`](https://bitbucket.org/atlassian/atlassian-frontend/commits/efa50ac72ba) - Adjusts jsdoc strings to improve prop documentation
8
+
3
9
  ## 8.5.14
4
10
 
5
11
  ### Patch Changes
package/dist/cjs/version.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/avatar-group",
3
- "version": "8.5.14",
3
+ "version": "8.5.15",
4
4
  "sideEffects": false
5
5
  }
package/dist/es2019/version.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/avatar-group",
3
- "version": "8.5.14",
3
+ "version": "8.5.15",
4
4
  "sideEffects": false
5
5
  }
package/dist/esm/version.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/avatar-group",
3
- "version": "8.5.14",
3
+ "version": "8.5.15",
4
4
  "sideEffects": false
5
5
  }
package/dist/types/components/avatar-group.d.ts CHANGED
@@ -78,16 +78,14 @@ export interface AvatarGroupProps {
78
78
  */
79
79
  isTooltipDisabled?: boolean;
80
80
  /**
81
- * Text to be used as aria-label of avatar's list.
82
- *
83
- * Screen reader announcement with default label, which is `avatar group`, is `list, avatar group, X items`.
84
- *
85
- * The label should describe the `AvatarGroup`'s entities, for instance:
86
- *
87
- * - `label="team members"`, screen reader announcement would be `list team members, X items`
88
- * - `label="reviewers"` screen reader announcement would be `list reviewers, X items`
89
- *
90
- * When there are several AvatarGroups on the page you should use a unique label to let users distinguish different lists.
81
+ Text to be used as aria-label for the list of avatars.
82
+ Screen reader announcement with default label, which is `avatar group`, is `list, avatar group, X items`.
83
+
84
+ The label should describe the `AvatarGroup`'s entities, for instance:
85
+ - `label="team members"`, screen reader announcement would be `list team members, X items`
86
+ - `label="reviewers"` screen reader announcement would be `list reviewers, X items`
87
+
88
+ When there are several AvatarGroups on the page you should use a unique label to let users distinguish different lists.
91
89
  */
92
90
  label?: string;
93
91
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/avatar-group",
3
- "version": "8.5.14",
3
+ "version": "8.5.15",
4
4
  "description": "An avatar group displays a number of avatars grouped together in a stack or grid.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"