@atlaskit/avatar 20.5.8 → 21.0.0

package/Avatar/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/entry-points/avatar.js",
   "module": "../dist/esm/entry-points/avatar.js",
   "module:es2019": "../dist/es2019/entry-points/avatar.js",
+  "sideEffects": false,
   "types": "../dist/types/entry-points/avatar.d.ts"
 }

package/AvatarItem/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/entry-points/avatar-item.js",
   "module": "../dist/esm/entry-points/avatar-item.js",
   "module:es2019": "../dist/es2019/entry-points/avatar-item.js",
+  "sideEffects": false,
   "types": "../dist/types/entry-points/avatar-item.d.ts"
 }

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @atlaskit/avatar
 
+## 21.0.0
+
+### Major Changes
+
+- [`92bb02bc46b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/92bb02bc46b) - [ux] There are **no code changes required** to consume this major, but you should be aware that internal changes have been made to how `@atlaskit/avatar` loads images.
+
+  Before, the image loading behaviour was written in JS. Now, it leans on a standard HTML `img` tag if you provide a `src` prop, allowing it to rely on the browser to optimise the loading. These changes should result in faster image loading and an improved server-side rendering story.
+
+  In this version, the **breaking change is that you will no longer see a fallback icon while the image is loading**. We have intentionally removed this loading behaviour as it is no longer consistent with our native `img` behaviour-first approach, and was a source of SSR bugs. Avatar images will load either instantly from the cache, or very fast from a CDN. In the edge cases where there is an error with the image src provided, we will still fall back to a default icon.
+
+### Patch Changes
+
+- [`be23a6d8ee1`](https://bitbucket.org/atlassian/atlassian-frontend/commits/be23a6d8ee1) - [ux] Updates color tokens used to be more semantically accurate
+
+## 20.5.10
+
+### Patch Changes
+
+- Updated dependencies
+
+## 20.5.9
+
+### Patch Changes
+
+- [`cb2392f6d33`](https://bitbucket.org/atlassian/atlassian-frontend/commits/cb2392f6d33) - Upgrade to TypeScript 4.2.4
+
 ## 20.5.8
 
 ### Patch Changes

package/Presence/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/entry-points/presence.js",
   "module": "../dist/esm/entry-points/presence.js",
   "module:es2019": "../dist/es2019/entry-points/presence.js",
+  "sideEffects": false,
   "types": "../dist/types/entry-points/presence.d.ts"
 }

package/Skeleton/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/entry-points/skeleton.js",
   "module": "../dist/esm/entry-points/skeleton.js",
   "module:es2019": "../dist/es2019/entry-points/skeleton.js",
+  "sideEffects": false,
   "types": "../dist/types/entry-points/skeleton.d.ts"
 }

package/Status/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/entry-points/status.js",
   "module": "../dist/esm/entry-points/status.js",
   "module:es2019": "../dist/es2019/entry-points/status.js",
+  "sideEffects": false,
   "types": "../dist/types/entry-points/status.d.ts"
 }

package/dist/cjs/Avatar.js

@@ -38,7 +38,7 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
 var packageName = "@atlaskit/avatar";
-var packageVersion = "20.5.8";
+var packageVersion = "21.0.0";
 
 var getStyles = function getStyles(css, _ref) {
   var size = _ref.size,

package/dist/cjs/AvatarImage.js

@@ -23,25 +23,21 @@ var _constants = require("./constants");
 
 /** @jsx jsx */
 // eslint-disable-next-line @repo/internal/fs/filename-pattern-match
-var ICON_BACKGROUND = "var(--ds-text-inverse, ".concat((0, _colors.background)(), ")");
+var ICON_BACKGROUND = "var(--ds-icon-inverse, ".concat((0, _colors.background)(), ")");
 exports.ICON_BACKGROUND = ICON_BACKGROUND;
-var ICON_COLOR = "var(--ds-text-subtlest, ".concat(_colors.N90, ")");
+var ICON_COLOR = "var(--ds-icon-subtle, ".concat(_colors.N90, ")");
 exports.ICON_COLOR = ICON_COLOR;
-var avatarImageStyles = (0, _core.css)({
+var avatarDefaultIconStyles = (0, _core.css)({
   display: 'block',
   width: '100%',
   height: '100%',
   backgroundColor: ICON_COLOR
 });
-var loadingImageStyles = (0, _core.css)({
+var avatarImageStyles = (0, _core.css)({
   display: 'flex',
   width: '100%',
   height: '100%',
-  flex: '1 1 100%',
-  backgroundColor: 'transparent',
-  backgroundPosition: 'center',
-  backgroundRepeat: 'no-repeat',
-  backgroundSize: 'cover'
+  flex: '1 1 100%'
 });
 /**
  * __Avatar image__
@@ -57,47 +53,20 @@ var AvatarImage = function AvatarImage(_ref) {
       size = _ref.size,
       testId = _ref.testId;
 
-  var _useState = (0, _react.useState)('initial'),
+  var _useState = (0, _react.useState)(false),
       _useState2 = (0, _slicedToArray2.default)(_useState, 2),
-      phase = _useState2[0],
-      setPhase = _useState2[1];
-
-  var borderRadius = appearance === 'circle' ? '50%' : "".concat(_constants.AVATAR_RADIUS[size], "px");
-  var image = (0, _react.useMemo)(function () {
-    if (src) {
-      setPhase('loading');
-      var img = new Image();
-
-      img.onload = function () {
-        return setPhase('loaded');
-      };
-
-      img.onerror = function () {
-        return setPhase('error');
-      };
+      hasImageErrored = _useState2[0],
+      setHasImageErrored = _useState2[1];
 
-      img.src = src;
-      return img;
-    }
+  var borderRadius = appearance === 'circle' ? '50%' : "".concat(_constants.AVATAR_RADIUS[size], "px"); // If src changes, reset state
 
-    return null;
-  }, [src]);
   (0, _react.useEffect)(function () {
-    return function () {
-      if (image) {
-        image.onload = function () {};
-
-        image.onerror = function () {};
-      }
-    };
-  }, [image]);
-  var imageHasLoadedAsync = src && phase !== 'loading' && phase !== 'error';
-  var imageHasLoadedSync = src && phase === 'loading' && (image === null || image === void 0 ? void 0 : image.complete);
-  var imageHasLoaded = imageHasLoadedAsync || imageHasLoadedSync;
-
-  if (!imageHasLoaded) {
+    setHasImageErrored(false);
+  }, [src]);
+
+  if (!src || hasImageErrored) {
     return (0, _core.jsx)("span", {
-      css: [avatarImageStyles, // TODO: These dynamic SVG styles can't be set in 'style'. On a refactor, use a css custom property to pass down the size
+      css: [avatarDefaultIconStyles, // TODO: These dynamic SVG styles can't be set in 'style'. On a refactor, use a css custom property to pass down the size
       // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
       {
         '& svg': {
@@ -118,15 +87,17 @@ var AvatarImage = function AvatarImage(_ref) {
     }));
   }
 
-  return (0, _core.jsx)("span", {
-    css: loadingImageStyles,
+  return (0, _core.jsx)("img", {
+    src: src,
+    alt: alt,
+    "data-testid": testId && "".concat(testId, "--image"),
+    css: avatarImageStyles,
     style: {
-      backgroundImage: "url(\"".concat(src, "\")"),
       borderRadius: borderRadius
     },
-    role: alt ? 'img' : undefined,
-    "aria-label": alt || undefined,
-    "data-testid": testId && "".concat(testId, "--image")
+    onError: function onError() {
+      return setHasImageErrored(true);
+    }
   });
 };
 

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/avatar",
-	"version": "20.5.8",
+	"version": "21.0.0",
 	"sideEffects": false
 }

package/dist/es2019/Avatar.js

@@ -10,7 +10,7 @@ import { PresenceWrapper } from './Presence';
 import { StatusWrapper } from './Status';
 import { getButtonProps, getCustomElement, getLinkProps } from './utilities';
 const packageName = "@atlaskit/avatar";
-const packageVersion = "20.5.8";
+const packageVersion = "21.0.0";
 
 const getStyles = (css, {
   size,

package/dist/es2019/AvatarImage.js

@@ -1,28 +1,24 @@
 /** @jsx jsx */
 // eslint-disable-next-line @repo/internal/fs/filename-pattern-match
-import { useEffect, useMemo, useState } from 'react';
+import { useEffect, useState } from 'react';
 import { css, jsx } from '@emotion/core';
 import PersonIcon from '@atlaskit/icon/glyph/person';
 import ShipIcon from '@atlaskit/icon/glyph/ship';
 import { background, N90 } from '@atlaskit/theme/colors';
 import { AVATAR_RADIUS, AVATAR_SIZES } from './constants';
-export const ICON_BACKGROUND = `var(--ds-text-inverse, ${background()})`;
-export const ICON_COLOR = `var(--ds-text-subtlest, ${N90})`;
-const avatarImageStyles = css({
+export const ICON_BACKGROUND = `var(--ds-icon-inverse, ${background()})`;
+export const ICON_COLOR = `var(--ds-icon-subtle, ${N90})`;
+const avatarDefaultIconStyles = css({
   display: 'block',
   width: '100%',
   height: '100%',
   backgroundColor: ICON_COLOR
 });
-const loadingImageStyles = css({
+const avatarImageStyles = css({
   display: 'flex',
   width: '100%',
   height: '100%',
-  flex: '1 1 100%',
-  backgroundColor: 'transparent',
-  backgroundPosition: 'center',
-  backgroundRepeat: 'no-repeat',
-  backgroundSize: 'cover'
+  flex: '1 1 100%'
 });
 /**
  * __Avatar image__
@@ -37,39 +33,16 @@ const AvatarImage = ({
   size,
   testId
 }) => {
-  const [phase, setPhase] = useState('initial');
-  const borderRadius = appearance === 'circle' ? '50%' : `${AVATAR_RADIUS[size]}px`;
-  const image = useMemo(() => {
-    if (src) {
-      setPhase('loading');
-      const img = new Image();
-
-      img.onload = () => setPhase('loaded');
-
-      img.onerror = () => setPhase('error');
+  const [hasImageErrored, setHasImageErrored] = useState(false);
+  const borderRadius = appearance === 'circle' ? '50%' : `${AVATAR_RADIUS[size]}px`; // If src changes, reset state
 
-      img.src = src;
-      return img;
-    }
-
-    return null;
-  }, [src]);
   useEffect(() => {
-    return () => {
-      if (image) {
-        image.onload = () => {};
-
-        image.onerror = () => {};
-      }
-    };
-  }, [image]);
-  const imageHasLoadedAsync = src && phase !== 'loading' && phase !== 'error';
-  const imageHasLoadedSync = src && phase === 'loading' && (image === null || image === void 0 ? void 0 : image.complete);
-  const imageHasLoaded = imageHasLoadedAsync || imageHasLoadedSync;
+    setHasImageErrored(false);
+  }, [src]);
 
-  if (!imageHasLoaded) {
+  if (!src || hasImageErrored) {
     return jsx("span", {
-      css: [avatarImageStyles, // TODO: These dynamic SVG styles can't be set in 'style'. On a refactor, use a css custom property to pass down the size
+      css: [avatarDefaultIconStyles, // TODO: These dynamic SVG styles can't be set in 'style'. On a refactor, use a css custom property to pass down the size
       // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
       {
         '& svg': {
@@ -90,15 +63,15 @@ const AvatarImage = ({
     }));
   }
 
-  return jsx("span", {
-    css: loadingImageStyles,
+  return jsx("img", {
+    src: src,
+    alt: alt,
+    "data-testid": testId && `${testId}--image`,
+    css: avatarImageStyles,
     style: {
-      backgroundImage: `url("${src}")`,
       borderRadius: borderRadius
     },
-    role: alt ? 'img' : undefined,
-    "aria-label": alt || undefined,
-    "data-testid": testId && `${testId}--image`
+    onError: () => setHasImageErrored(true)
   });
 };
 

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/avatar",
-	"version": "20.5.8",
+	"version": "21.0.0",
 	"sideEffects": false
 }

package/dist/esm/Avatar.js

@@ -20,7 +20,7 @@ import { PresenceWrapper } from './Presence';
 import { StatusWrapper } from './Status';
 import { getButtonProps, getCustomElement, getLinkProps } from './utilities';
 var packageName = "@atlaskit/avatar";
-var packageVersion = "20.5.8";
+var packageVersion = "21.0.0";
 
 var getStyles = function getStyles(css, _ref) {
   var size = _ref.size,

package/dist/esm/AvatarImage.js

@@ -2,29 +2,25 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 
 /** @jsx jsx */
 // eslint-disable-next-line @repo/internal/fs/filename-pattern-match
-import { useEffect, useMemo, useState } from 'react';
+import { useEffect, useState } from 'react';
 import { css, jsx } from '@emotion/core';
 import PersonIcon from '@atlaskit/icon/glyph/person';
 import ShipIcon from '@atlaskit/icon/glyph/ship';
 import { background, N90 } from '@atlaskit/theme/colors';
 import { AVATAR_RADIUS, AVATAR_SIZES } from './constants';
-export var ICON_BACKGROUND = "var(--ds-text-inverse, ".concat(background(), ")");
-export var ICON_COLOR = "var(--ds-text-subtlest, ".concat(N90, ")");
-var avatarImageStyles = css({
+export var ICON_BACKGROUND = "var(--ds-icon-inverse, ".concat(background(), ")");
+export var ICON_COLOR = "var(--ds-icon-subtle, ".concat(N90, ")");
+var avatarDefaultIconStyles = css({
   display: 'block',
   width: '100%',
   height: '100%',
   backgroundColor: ICON_COLOR
 });
-var loadingImageStyles = css({
+var avatarImageStyles = css({
   display: 'flex',
   width: '100%',
   height: '100%',
-  flex: '1 1 100%',
-  backgroundColor: 'transparent',
-  backgroundPosition: 'center',
-  backgroundRepeat: 'no-repeat',
-  backgroundSize: 'cover'
+  flex: '1 1 100%'
 });
 /**
  * __Avatar image__
@@ -40,47 +36,20 @@ var AvatarImage = function AvatarImage(_ref) {
       size = _ref.size,
       testId = _ref.testId;
 
-  var _useState = useState('initial'),
+  var _useState = useState(false),
       _useState2 = _slicedToArray(_useState, 2),
-      phase = _useState2[0],
-      setPhase = _useState2[1];
-
-  var borderRadius = appearance === 'circle' ? '50%' : "".concat(AVATAR_RADIUS[size], "px");
-  var image = useMemo(function () {
-    if (src) {
-      setPhase('loading');
-      var img = new Image();
-
-      img.onload = function () {
-        return setPhase('loaded');
-      };
-
-      img.onerror = function () {
-        return setPhase('error');
-      };
+      hasImageErrored = _useState2[0],
+      setHasImageErrored = _useState2[1];
 
-      img.src = src;
-      return img;
-    }
+  var borderRadius = appearance === 'circle' ? '50%' : "".concat(AVATAR_RADIUS[size], "px"); // If src changes, reset state
 
-    return null;
-  }, [src]);
   useEffect(function () {
-    return function () {
-      if (image) {
-        image.onload = function () {};
-
-        image.onerror = function () {};
-      }
-    };
-  }, [image]);
-  var imageHasLoadedAsync = src && phase !== 'loading' && phase !== 'error';
-  var imageHasLoadedSync = src && phase === 'loading' && (image === null || image === void 0 ? void 0 : image.complete);
-  var imageHasLoaded = imageHasLoadedAsync || imageHasLoadedSync;
+    setHasImageErrored(false);
+  }, [src]);
 
-  if (!imageHasLoaded) {
+  if (!src || hasImageErrored) {
     return jsx("span", {
-      css: [avatarImageStyles, // TODO: These dynamic SVG styles can't be set in 'style'. On a refactor, use a css custom property to pass down the size
+      css: [avatarDefaultIconStyles, // TODO: These dynamic SVG styles can't be set in 'style'. On a refactor, use a css custom property to pass down the size
       // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
       {
         '& svg': {
@@ -101,15 +70,17 @@ var AvatarImage = function AvatarImage(_ref) {
     }));
   }
 
-  return jsx("span", {
-    css: loadingImageStyles,
+  return jsx("img", {
+    src: src,
+    alt: alt,
+    "data-testid": testId && "".concat(testId, "--image"),
+    css: avatarImageStyles,
     style: {
-      backgroundImage: "url(\"".concat(src, "\")"),
       borderRadius: borderRadius
     },
-    role: alt ? 'img' : undefined,
-    "aria-label": alt || undefined,
-    "data-testid": testId && "".concat(testId, "--image")
+    onError: function onError() {
+      return setHasImageErrored(true);
+    }
   });
 };
 

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/avatar",
-	"version": "20.5.8",
+	"version": "21.0.0",
 	"sideEffects": false
 }

package/dist/types/Avatar.d.ts

@@ -23,7 +23,7 @@ export interface AvatarPropTypes {
     appearance?: AppearanceType;
     /**
      * Used to provide better content to screen readers when using presence/status. Rather
-     * than a screen reader speaking "online, approved, John Smith", passing in an label
+     * than a screen reader speaking "online, approved, John Smith", passing in a label
      * allows a custom message like "John Smith (approved and online)".
      */
     label?: string;
@@ -45,8 +45,7 @@ export interface AvatarPropTypes {
      */
     isDisabled?: boolean;
     /**
-     * Name will be displayed in a tooltip, also used by screen readers as fallback
-     * content if the image fails to load.
+     * Provides alt text for the avatar image.
      */
     name?: string;
     /**

package/dist/types/AvatarImage.d.ts

@@ -8,8 +8,8 @@ interface AvatarImageProps {
     src?: string;
     testId?: string;
 }
-export declare const ICON_BACKGROUND: "var(--ds-text-inverse)";
-export declare const ICON_COLOR: "var(--ds-text-subtlest)";
+export declare const ICON_BACKGROUND: "var(--ds-icon-inverse)";
+export declare const ICON_COLOR: "var(--ds-icon-subtle)";
 /**
  * __Avatar image__
  *

package/dist/types/utilities.d.ts

@@ -6,6 +6,6 @@ export declare const getLinkProps: (href: string, target?: string | undefined) =
 };
 export declare const getButtonProps: (onClick: MouseEventHandler) => {
     type: string;
-    onClick: (event: import("react").MouseEvent<Element, MouseEvent>) => void;
+    onClick: MouseEventHandler<Element>;
 };
-export declare const getCustomElement: (isDisabled?: boolean | undefined, href?: string | undefined, onClick?: ((event: import("react").MouseEvent<Element, MouseEvent>) => void) | undefined) => "button" | "a" | "span";
+export declare const getCustomElement: (isDisabled?: boolean | undefined, href?: string | undefined, onClick?: MouseEventHandler<Element> | undefined) => "button" | "a" | "span";

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@atlaskit/avatar",
-  "version": "20.5.8",
+  "version": "21.0.0",
   "description": "An avatar is a visual representation of a user or entity.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
-  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+  "repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
@@ -34,7 +34,7 @@
     "@atlaskit/analytics-next": "^8.0.0",
     "@atlaskit/icon": "^21.10.0",
     "@atlaskit/theme": "^12.1.0",
-    "@atlaskit/tokens": "^0.9.0",
+    "@atlaskit/tokens": "^0.10.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/core": "^10.0.9"
   },
@@ -42,7 +42,7 @@
     "react": "^16.8.0"
   },
   "devDependencies": {
-    "@atlaskit/button": "^16.2.0",
+    "@atlaskit/button": "^16.3.0",
     "@atlaskit/docs": "*",
     "@atlaskit/field-base": "^15.0.0",
     "@atlaskit/icon": "^21.10.0",
@@ -59,7 +59,7 @@
     "color-contrast-checker": "^1.5.0",
     "jscodeshift": "^0.13.0",
     "react-dom": "^16.8.0",
-    "typescript": "3.9.10",
+    "typescript": "4.2.4",
     "wait-for-expect": "^1.2.0"
   },
   "keywords": [

package/types/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/entry-points/types.js",
   "module": "../dist/esm/entry-points/types.js",
   "module:es2019": "../dist/es2019/entry-points/types.js",
+  "sideEffects": false,
   "types": "../dist/types/entry-points/types.d.ts"
 }