@atlaskit/avatar 21.4.3 → 21.4.5

package/CHANGELOG.md

@@ -1,10 +1,22 @@
 # @atlaskit/avatar
 
+## 21.4.5
+
+### Patch Changes
+
+- [#67339](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/67339) [`33c37b4c2c1e`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/33c37b4c2c1e) - [ux] Remove nested images introduced in 21.4.3
+
+## 21.4.4
+
+### Patch Changes
+
+- [#64854](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/64854) [`61b09a38c764`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/61b09a38c764) - [ux] Adds label to custom avatars using the render prop API.
+
 ## 21.4.3
 
 ### Patch Changes
 
-- [#63807](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/63807) [`538c46e739b6`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/538c46e739b6) - [ux] Add accessible name to non-interactive avatars.
+- [#63807](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/63807) [`538c46e739b6`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/538c46e739b6) - [ux] Add accessible name to non-interactive avatars. If you are a making a test that relies on there being only a single element containing the avatar's expected text, skipping any elements with a `hidden` attribute will narrow down your search to only the visible element; this will make the test act the same as it would before this change.
 
 ## 21.4.2
 

package/dist/cjs/Avatar.js

@@ -23,7 +23,7 @@ var _templateObject;
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var packageName = "@atlaskit/avatar";
-var packageVersion = "21.4.3";
+var packageVersion = "21.4.5";
 
 // eslint-disable-next-line @repo/internal/react/consistent-types-definitions
 
@@ -139,12 +139,13 @@ var Avatar = /*#__PURE__*/(0, _react.forwardRef)(function (_ref2, ref) {
 
   // add presence or status to the label by default if presence and status are passed as a string
   // if status or presence are nodes this is not added to the label by default
-  var defaultLabel = "".concat(name || '', " ").concat(isStatus && !customStatusNode ? "(".concat(status, ")") : '', " ").concat(isPresence && !customPresenceNode ? "(".concat(presence, ")") : '').trim();
+  var defaultLabel = [name, isStatus && !customStatusNode && "(".concat(status, ")"), isPresence && !customPresenceNode && "(".concat(presence, ")")].filter(Boolean).join(' ');
   var isInteractive = onClick || href || isDisabled;
+  var containerShouldBeImage = Boolean(!isInteractive && defaultLabel);
   return (0, _react2.jsx)(AvatarContainer, {
     "data-testid": testId,
-    role: isInteractive || !defaultLabel ? undefined : 'img',
-    "aria-labelledby": isInteractive || !defaultLabel ? undefined : "".concat(uuid, "-label"),
+    role: containerShouldBeImage ? 'img' : undefined,
+    "aria-labelledby": containerShouldBeImage ? "".concat(uuid, "-label") : undefined,
     style: {
       display: 'inline-block',
       position: 'relative',
@@ -163,14 +164,14 @@ var Avatar = /*#__PURE__*/(0, _react.forwardRef)(function (_ref2, ref) {
         isInteractive: Boolean(href || onClick) && !isDisabled,
         isDisabled: isDisabled
       })
-    }, componentProps()), testId && getTestId(testId, children)), isInteractive && {
+    }, componentProps()), testId && getTestId(testId, children)), (isInteractive || children) && {
       'aria-label': label || defaultLabel
     }), {}, {
       children: (0, _react2.jsx)(_AvatarImage.default
-      // Only pass the name if there is an image provided. We want the
-      // icons to be presentational if they don't show anything important.
+      // Only pass in the name if an image is provded and the
+      // container is not being used as an `img` role
       , {
-        alt: src ? name : undefined,
+        alt: !containerShouldBeImage && src ? name : undefined,
         appearance: appearance,
         size: size,
         src: src,
@@ -190,7 +191,7 @@ var Avatar = /*#__PURE__*/(0, _react.forwardRef)(function (_ref2, ref) {
     borderColor: borderColor,
     status: typeof status === 'string' ? status : undefined,
     testId: testId
-  }, customStatusNode), !isInteractive && defaultLabel ? (0, _react2.jsx)("span", {
+  }, customStatusNode), containerShouldBeImage ? (0, _react2.jsx)("span", {
     id: "".concat(uuid, "-label"),
     hidden: true
   }, defaultLabel) : undefined);

package/dist/cjs/AvatarImage.js

@@ -59,6 +59,7 @@ var AvatarImage = function AvatarImage(_ref3) {
     hasImageErrored = _useState2[0],
     setHasImageErrored = _useState2[1];
   var borderRadius = appearance === 'circle' ? '50%' : "".concat(_constants.AVATAR_RADIUS[size], "px");
+  var isHidden = !alt ? true : undefined;
 
   // If src changes, reset state
   (0, _react.useEffect)(function () {
@@ -71,12 +72,14 @@ var AvatarImage = function AvatarImage(_ref3) {
       label: alt,
       primaryColor: ICON_BACKGROUND,
       secondaryColor: ICON_COLOR,
-      testId: testId && "".concat(testId, "--person")
+      testId: testId && "".concat(testId, "--person"),
+      "aria-hidden": isHidden
     }) : (0, _react2.jsx)(_ship.default, {
       label: alt,
       primaryColor: ICON_BACKGROUND,
       secondaryColor: ICON_COLOR,
-      testId: testId && "".concat(testId, "--ship")
+      testId: testId && "".concat(testId, "--ship"),
+      "aria-hidden": isHidden
     }));
   }
   return (0, _react2.jsx)("img", {
@@ -89,7 +92,8 @@ var AvatarImage = function AvatarImage(_ref3) {
     },
     onError: function onError() {
       return setHasImageErrored(true);
-    }
+    },
+    "aria-hidden": isHidden
   });
 };
 var _default = exports.default = AvatarImage;

package/dist/cjs/Presence.js

@@ -74,7 +74,7 @@ var AvatarPresence = function AvatarPresence(_ref) {
     viewBox: "0 0 8 8",
     width: "100%",
     xmlns: "http://www.w3.org/2000/svg"
-  }, /*#__PURE__*/_react.default.createElement("title", null, "(".concat(presence, ")")), getPresence(presence)) : children);
+  }, getPresence(presence)) : children);
 };
 var _default = exports.default = AvatarPresence;
 /**

package/dist/cjs/Status.js

@@ -72,7 +72,7 @@ var AvatarStatus = function AvatarStatus(_ref) {
     viewBox: "0 0 8 8",
     width: "100%",
     xmlns: "http://www.w3.org/2000/svg"
-  }, /*#__PURE__*/_react.default.createElement("title", null, "(".concat(status, ")")), getStatus(status)) : children);
+  }, getStatus(status)) : children);
 };
 var _default = exports.default = AvatarStatus;
 /**

package/dist/es2019/Avatar.js

@@ -11,7 +11,7 @@ import { PresenceWrapper } from './Presence';
 import { StatusWrapper } from './Status';
 import { getButtonProps, getCustomElement, getLinkProps } from './utilities';
 const packageName = "@atlaskit/avatar";
-const packageVersion = "21.4.3";
+const packageVersion = "21.4.5";
 
 // eslint-disable-next-line @repo/internal/react/consistent-types-definitions
 
@@ -215,12 +215,13 @@ const Avatar = /*#__PURE__*/forwardRef(({
 
   // add presence or status to the label by default if presence and status are passed as a string
   // if status or presence are nodes this is not added to the label by default
-  const defaultLabel = `${name || ''} ${isStatus && !customStatusNode ? `(${status})` : ''} ${isPresence && !customPresenceNode ? `(${presence})` : ''}`.trim();
+  const defaultLabel = [name, isStatus && !customStatusNode && `(${status})`, isPresence && !customPresenceNode && `(${presence})`].filter(Boolean).join(' ');
   const isInteractive = onClick || href || isDisabled;
+  const containerShouldBeImage = Boolean(!isInteractive && defaultLabel);
   return jsx(AvatarContainer, {
     "data-testid": testId,
-    role: isInteractive || !defaultLabel ? undefined : 'img',
-    "aria-labelledby": isInteractive || !defaultLabel ? undefined : `${uuid}-label`,
+    role: containerShouldBeImage ? 'img' : undefined,
+    "aria-labelledby": containerShouldBeImage ? `${uuid}-label` : undefined,
     style: {
       display: 'inline-block',
       position: 'relative',
@@ -242,14 +243,14 @@ const Avatar = /*#__PURE__*/forwardRef(({
       }),
       ...componentProps(),
       ...(testId && getTestId(testId, children)),
-      ...(isInteractive && {
+      ...((isInteractive || children) && {
         'aria-label': label || defaultLabel
       }),
       children: jsx(AvatarImage
-      // Only pass the name if there is an image provided. We want the
-      // icons to be presentational if they don't show anything important.
+      // Only pass in the name if an image is provded and the
+      // container is not being used as an `img` role
       , {
-        alt: src ? name : undefined,
+        alt: !containerShouldBeImage && src ? name : undefined,
         appearance: appearance,
         size: size,
         src: src,
@@ -269,7 +270,7 @@ const Avatar = /*#__PURE__*/forwardRef(({
     borderColor: borderColor,
     status: typeof status === 'string' ? status : undefined,
     testId: testId
-  }, customStatusNode), !isInteractive && defaultLabel ? jsx("span", {
+  }, customStatusNode), containerShouldBeImage ? jsx("span", {
     id: `${uuid}-label`,
     hidden: true
   }, defaultLabel) : undefined);

package/dist/es2019/AvatarImage.js

@@ -47,6 +47,7 @@ const AvatarImage = ({
 }) => {
   const [hasImageErrored, setHasImageErrored] = useState(false);
   const borderRadius = appearance === 'circle' ? '50%' : `${AVATAR_RADIUS[size]}px`;
+  const isHidden = !alt ? true : undefined;
 
   // If src changes, reset state
   useEffect(() => {
@@ -59,12 +60,14 @@ const AvatarImage = ({
       label: alt,
       primaryColor: ICON_BACKGROUND,
       secondaryColor: ICON_COLOR,
-      testId: testId && `${testId}--person`
+      testId: testId && `${testId}--person`,
+      "aria-hidden": isHidden
     }) : jsx(ShipIcon, {
       label: alt,
       primaryColor: ICON_BACKGROUND,
       secondaryColor: ICON_COLOR,
-      testId: testId && `${testId}--ship`
+      testId: testId && `${testId}--ship`,
+      "aria-hidden": isHidden
     }));
   }
   return jsx("img", {
@@ -75,7 +78,8 @@ const AvatarImage = ({
     style: {
       borderRadius: borderRadius
     },
-    onError: () => setHasImageErrored(true)
+    onError: () => setHasImageErrored(true),
+    "aria-hidden": isHidden
   });
 };
 export default AvatarImage;

package/dist/es2019/Presence.js

@@ -63,7 +63,7 @@ const AvatarPresence = ({
   viewBox: "0 0 8 8",
   width: "100%",
   xmlns: "http://www.w3.org/2000/svg"
-}, /*#__PURE__*/React.createElement("title", null, `(${presence})`), getPresence(presence)) : children);
+}, getPresence(presence)) : children);
 export default AvatarPresence;
 /**
  * __Presence wrapper__

package/dist/es2019/Status.js

@@ -61,7 +61,7 @@ const AvatarStatus = ({
   viewBox: "0 0 8 8",
   width: "100%",
   xmlns: "http://www.w3.org/2000/svg"
-}, /*#__PURE__*/React.createElement("title", null, `(${status})`), getStatus(status)) : children);
+}, getStatus(status)) : children);
 export default AvatarStatus;
 /**
  * Status wrapper**

package/dist/esm/Avatar.js

@@ -16,7 +16,7 @@ import { PresenceWrapper } from './Presence';
 import { StatusWrapper } from './Status';
 import { getButtonProps, getCustomElement, getLinkProps } from './utilities';
 var packageName = "@atlaskit/avatar";
-var packageVersion = "21.4.3";
+var packageVersion = "21.4.5";
 
 // eslint-disable-next-line @repo/internal/react/consistent-types-definitions
 
@@ -132,12 +132,13 @@ var Avatar = /*#__PURE__*/forwardRef(function (_ref2, ref) {
 
   // add presence or status to the label by default if presence and status are passed as a string
   // if status or presence are nodes this is not added to the label by default
-  var defaultLabel = "".concat(name || '', " ").concat(isStatus && !customStatusNode ? "(".concat(status, ")") : '', " ").concat(isPresence && !customPresenceNode ? "(".concat(presence, ")") : '').trim();
+  var defaultLabel = [name, isStatus && !customStatusNode && "(".concat(status, ")"), isPresence && !customPresenceNode && "(".concat(presence, ")")].filter(Boolean).join(' ');
   var isInteractive = onClick || href || isDisabled;
+  var containerShouldBeImage = Boolean(!isInteractive && defaultLabel);
   return jsx(AvatarContainer, {
     "data-testid": testId,
-    role: isInteractive || !defaultLabel ? undefined : 'img',
-    "aria-labelledby": isInteractive || !defaultLabel ? undefined : "".concat(uuid, "-label"),
+    role: containerShouldBeImage ? 'img' : undefined,
+    "aria-labelledby": containerShouldBeImage ? "".concat(uuid, "-label") : undefined,
     style: {
       display: 'inline-block',
       position: 'relative',
@@ -156,14 +157,14 @@ var Avatar = /*#__PURE__*/forwardRef(function (_ref2, ref) {
         isInteractive: Boolean(href || onClick) && !isDisabled,
         isDisabled: isDisabled
       })
-    }, componentProps()), testId && getTestId(testId, children)), isInteractive && {
+    }, componentProps()), testId && getTestId(testId, children)), (isInteractive || children) && {
       'aria-label': label || defaultLabel
     }), {}, {
       children: jsx(AvatarImage
-      // Only pass the name if there is an image provided. We want the
-      // icons to be presentational if they don't show anything important.
+      // Only pass in the name if an image is provded and the
+      // container is not being used as an `img` role
       , {
-        alt: src ? name : undefined,
+        alt: !containerShouldBeImage && src ? name : undefined,
         appearance: appearance,
         size: size,
         src: src,
@@ -183,7 +184,7 @@ var Avatar = /*#__PURE__*/forwardRef(function (_ref2, ref) {
     borderColor: borderColor,
     status: typeof status === 'string' ? status : undefined,
     testId: testId
-  }, customStatusNode), !isInteractive && defaultLabel ? jsx("span", {
+  }, customStatusNode), containerShouldBeImage ? jsx("span", {
     id: "".concat(uuid, "-label"),
     hidden: true
   }, defaultLabel) : undefined);

package/dist/esm/AvatarImage.js

@@ -54,6 +54,7 @@ var AvatarImage = function AvatarImage(_ref3) {
     hasImageErrored = _useState2[0],
     setHasImageErrored = _useState2[1];
   var borderRadius = appearance === 'circle' ? '50%' : "".concat(AVATAR_RADIUS[size], "px");
+  var isHidden = !alt ? true : undefined;
 
   // If src changes, reset state
   useEffect(function () {
@@ -66,12 +67,14 @@ var AvatarImage = function AvatarImage(_ref3) {
       label: alt,
       primaryColor: ICON_BACKGROUND,
       secondaryColor: ICON_COLOR,
-      testId: testId && "".concat(testId, "--person")
+      testId: testId && "".concat(testId, "--person"),
+      "aria-hidden": isHidden
     }) : jsx(ShipIcon, {
       label: alt,
       primaryColor: ICON_BACKGROUND,
       secondaryColor: ICON_COLOR,
-      testId: testId && "".concat(testId, "--ship")
+      testId: testId && "".concat(testId, "--ship"),
+      "aria-hidden": isHidden
     }));
   }
   return jsx("img", {
@@ -84,7 +87,8 @@ var AvatarImage = function AvatarImage(_ref3) {
     },
     onError: function onError() {
       return setHasImageErrored(true);
-    }
+    },
+    "aria-hidden": isHidden
   });
 };
 export default AvatarImage;

package/dist/esm/Presence.js

@@ -63,7 +63,7 @@ var AvatarPresence = function AvatarPresence(_ref) {
     viewBox: "0 0 8 8",
     width: "100%",
     xmlns: "http://www.w3.org/2000/svg"
-  }, /*#__PURE__*/React.createElement("title", null, "(".concat(presence, ")")), getPresence(presence)) : children);
+  }, getPresence(presence)) : children);
 };
 export default AvatarPresence;
 /**

package/dist/esm/Status.js

@@ -61,7 +61,7 @@ var AvatarStatus = function AvatarStatus(_ref) {
     viewBox: "0 0 8 8",
     width: "100%",
     xmlns: "http://www.w3.org/2000/svg"
-  }, /*#__PURE__*/React.createElement("title", null, "(".concat(status, ")")), getStatus(status)) : children);
+  }, getStatus(status)) : children);
 };
 export default AvatarStatus;
 /**

package/dist/types/Skeleton.d.ts

@@ -2,9 +2,21 @@
 import { FC } from 'react';
 import { AppearanceType, SizeType } from './types';
 export interface SkeletonProps {
+    /**
+     * Indicates the shape of the avatar skeleton. Most avatars are circular, but square avatars can be used for container objects.
+     */
     appearance?: AppearanceType;
+    /**
+     * Color of the skeleton. By default, it will inherit the current text color.
+     */
     color?: string;
+    /**
+     * Defines the size of the avatar skeleton.
+     */
     size?: SizeType;
+    /**
+     * Defines the opacity of the avatar skeleton. Use `weight="normal"` for the default opacity, or `weight="strong"` for a bolder opacity.
+     */
     weight?: 'normal' | 'strong';
 }
 /**

package/dist/types-ts4.5/Skeleton.d.ts

@@ -2,9 +2,21 @@
 import { FC } from 'react';
 import { AppearanceType, SizeType } from './types';
 export interface SkeletonProps {
+    /**
+     * Indicates the shape of the avatar skeleton. Most avatars are circular, but square avatars can be used for container objects.
+     */
     appearance?: AppearanceType;
+    /**
+     * Color of the skeleton. By default, it will inherit the current text color.
+     */
     color?: string;
+    /**
+     * Defines the size of the avatar skeleton.
+     */
     size?: SizeType;
+    /**
+     * Defines the opacity of the avatar skeleton. Use `weight="normal"` for the default opacity, or `weight="strong"` for a bolder opacity.
+     */
     weight?: 'normal' | 'strong';
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/avatar",
-  "version": "21.4.3",
+  "version": "21.4.5",
   "description": "An avatar is a visual representation of a user or entity.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -46,7 +46,7 @@
     "@atlaskit/analytics-next": "^9.1.0",
     "@atlaskit/icon": "^22.0.0",
     "@atlaskit/theme": "^12.6.0",
-    "@atlaskit/tokens": "^1.33.0",
+    "@atlaskit/tokens": "^1.34.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",
     "@emotion/serialize": "^1.1.0",
@@ -67,6 +67,7 @@
     "@testing-library/react": "^12.1.5",
     "@types/jscodeshift": "^0.11.0",
     "color-contrast-checker": "^1.5.0",
+    "jest-in-case": "^1.0.2",
     "jscodeshift": "^0.13.0",
     "react-dom": "^16.8.0",
     "typescript": "~4.9.5",