@instructure/ui-avatar 8.10.3-snapshot.9 → 8.11.2-snapshot.10

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.11.1](https://github.com/instructure/instructure-ui/compare/v8.11.0...v8.11.1) (2021-10-19)
+
+**Note:** Version bump only for package @instructure/ui-avatar
+
+# [8.11.0](https://github.com/instructure/instructure-ui/compare/v8.10.2...v8.11.0) (2021-10-15)
+
+**Note:** Version bump only for package @instructure/ui-avatar
+
 ## [8.10.2](https://github.com/instructure/instructure-ui/compare/v8.10.1...v8.10.2) (2021-10-01)
 
 **Note:** Version bump only for package @instructure/ui-avatar

package/es/Avatar/index.js

@@ -52,10 +52,12 @@ let Avatar = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = t
     this.ref = null;
 
     this.handleRef = el => {
-      var _this$props$elementRe, _this$props;
-
+      const elementRef = this.props.elementRef;
       this.ref = el;
-      (_this$props$elementRe = (_this$props = this.props).elementRef) === null || _this$props$elementRe === void 0 ? void 0 : _this$props$elementRe.call(_this$props, el);
+
+      if (typeof elementRef === 'function') {
+        elementRef(el);
+      }
     };
 
     this.handleImageLoaded = event => {
@@ -109,10 +111,10 @@ let Avatar = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = t
   render() {
     var _this$props$styles2;
 
-    const _this$props2 = this.props,
-          onImageLoaded = _this$props2.onImageLoaded,
-          styles = _this$props2.styles,
-          props = _objectWithoutProperties(_this$props2, _excluded);
+    const _this$props = this.props,
+          onImageLoaded = _this$props.onImageLoaded,
+          styles = _this$props.styles,
+          props = _objectWithoutProperties(_this$props, _excluded);
 
     return jsx(View, Object.assign({}, passthroughProps(props), {
       "aria-label": this.props.alt ? this.props.alt : void 0,

package/lib/Avatar/index.js

@@ -44,10 +44,12 @@ let Avatar = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _
     this.ref = null;
 
     this.handleRef = el => {
-      var _this$props$elementRe, _this$props;
-
+      const elementRef = this.props.elementRef;
       this.ref = el;
-      (_this$props$elementRe = (_this$props = this.props).elementRef) === null || _this$props$elementRe === void 0 ? void 0 : _this$props$elementRe.call(_this$props, el);
+
+      if (typeof elementRef === 'function') {
+        elementRef(el);
+      }
     };
 
     this.handleImageLoaded = event => {
@@ -101,10 +103,10 @@ let Avatar = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _
   render() {
     var _this$props$styles2;
 
-    const _this$props2 = this.props,
-          onImageLoaded = _this$props2.onImageLoaded,
-          styles = _this$props2.styles,
-          props = (0, _objectWithoutProperties2.default)(_this$props2, _excluded);
+    const _this$props = this.props,
+          onImageLoaded = _this$props.onImageLoaded,
+          styles = _this$props.styles,
+          props = (0, _objectWithoutProperties2.default)(_this$props, _excluded);
     return (0, _emotion.jsx)(_View.View, Object.assign({}, (0, _passthroughProps.passthroughProps)(props), {
       "aria-label": this.props.alt ? this.props.alt : void 0,
       role: this.props.alt ? 'img' : void 0,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-avatar",
-  "version": "8.10.3-snapshot.9+47592ffa9",
+  "version": "8.11.2-snapshot.10+162c2a15c",
   "description": "An image or letters that represents a user.",
   "author": "Instructure, Inc. Engineering and Product Design",
   "type": "commonjs",
@@ -25,20 +25,20 @@
   "license": "MIT",
   "dependencies": {
     "@babel/runtime": "^7.13.10",
-    "@instructure/console": "8.10.3-snapshot.9+47592ffa9",
-    "@instructure/emotion": "8.10.3-snapshot.9+47592ffa9",
-    "@instructure/shared-types": "8.10.3-snapshot.9+47592ffa9",
-    "@instructure/ui-react-utils": "8.10.3-snapshot.9+47592ffa9",
-    "@instructure/ui-testable": "8.10.3-snapshot.9+47592ffa9",
-    "@instructure/ui-view": "8.10.3-snapshot.9+47592ffa9",
+    "@instructure/console": "8.11.2-snapshot.10+162c2a15c",
+    "@instructure/emotion": "8.11.2-snapshot.10+162c2a15c",
+    "@instructure/shared-types": "8.11.2-snapshot.10+162c2a15c",
+    "@instructure/ui-react-utils": "8.11.2-snapshot.10+162c2a15c",
+    "@instructure/ui-testable": "8.11.2-snapshot.10+162c2a15c",
+    "@instructure/ui-view": "8.11.2-snapshot.10+162c2a15c",
     "prop-types": "^15"
   },
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.10.3-snapshot.9+47592ffa9",
-    "@instructure/ui-color-utils": "8.10.3-snapshot.9+47592ffa9",
-    "@instructure/ui-test-locator": "8.10.3-snapshot.9+47592ffa9",
-    "@instructure/ui-test-utils": "8.10.3-snapshot.9+47592ffa9",
-    "@instructure/ui-themes": "8.10.3-snapshot.9+47592ffa9"
+    "@instructure/ui-babel-preset": "8.11.2-snapshot.10+162c2a15c",
+    "@instructure/ui-color-utils": "8.11.2-snapshot.10+162c2a15c",
+    "@instructure/ui-test-locator": "8.11.2-snapshot.10+162c2a15c",
+    "@instructure/ui-test-utils": "8.11.2-snapshot.10+162c2a15c",
+    "@instructure/ui-themes": "8.11.2-snapshot.10+162c2a15c"
   },
   "peerDependencies": {
     "react": ">=16.8 <=17"
@@ -47,5 +47,5 @@
     "access": "public"
   },
   "sideEffects": false,
-  "gitHead": "47592ffa9fed565a9df0677c77e6d890d5e964ea"
+  "gitHead": "162c2a15c78f0c641fb71cffd17bc97d6b5c6e0e"
 }

package/src/Avatar/index.tsx

@@ -63,8 +63,13 @@ class Avatar extends Component<AvatarProps, AvatarState> {
   ref: Element | null = null
 
   handleRef = (el: Element | null) => {
+    const { elementRef } = this.props
+
     this.ref = el
-    this.props.elementRef?.(el)
+
+    if (typeof elementRef === 'function') {
+      elementRef(el)
+    }
   }
 
   componentDidMount() {

package/src/Avatar/props.ts

@@ -35,6 +35,7 @@ import type {
 import type {
   AsElementType,
   AvatarTheme,
+  OtherHTMLAttributes,
   PropValidators
 } from '@instructure/shared-types'
 
@@ -85,7 +86,7 @@ type AvatarOwnProps = {
    */
   as?: AsElementType
   /**
-   * Provides a reference to the underlying html element
+   * provides a reference to the underlying html root element
    */
   elementRef?: (element: Element | null) => void
 }
@@ -98,7 +99,9 @@ type PropKeys = keyof AvatarOwnProps
 
 type AllowedPropKeys = Readonly<Array<PropKeys>>
 
-type AvatarProps = AvatarOwnProps & WithStyleProps<AvatarTheme, AvatarStyle>
+type AvatarProps = AvatarOwnProps &
+  WithStyleProps<AvatarTheme, AvatarStyle> &
+  OtherHTMLAttributes<AvatarOwnProps>
 
 type AvatarStyle = ComponentStyle<'avatar' | 'initials' | 'loadImage'>
 

package/types/Avatar/index.d.ts

@@ -12,6 +12,12 @@ declare class Avatar extends Component<AvatarProps, AvatarState> {
     static readonly componentId = "Avatar";
     static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
         name: string;
+        /**
+        ---
+        category: components
+        ---
+        @tsProps
+        **/
         src?: string | undefined;
         alt?: string | undefined;
         size: "auto" | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large";
@@ -25,6 +31,12 @@ declare class Avatar extends Component<AvatarProps, AvatarState> {
     }>;
     static allowedProps: readonly (keyof {
         name: string;
+        /**
+        ---
+        category: components
+        ---
+        @tsProps
+        **/
         src?: string | undefined;
         alt?: string | undefined;
         size: "auto" | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large";

package/types/Avatar/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Avatar/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,OAAO,CAAA;AAMjD,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAMrD,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAEvD;;;;;GAKG;AACH,cAEM,MAAO,SAAQ,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC;IACtD,MAAM,CAAC,QAAQ,CAAC,WAAW,YAAW;IAEtC,MAAM,CAAC,SAAS;;;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;;;yCAKO,cAAc;MAC9B;IAEV,KAAK;;MAAoB;IAEzB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAG9B;IAED,iBAAiB;IAKjB,kBAAkB;IAKlB,oBAAoB;IAmBpB,iBAAiB,UAAW,cAAc,UAGzC;IAED,cAAc;IAQd,MAAM;CAyBP;AAED,eAAe,MAAM,CAAA;AACrB,OAAO,EAAE,MAAM,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Avatar/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,OAAO,CAAA;AAMjD,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAMrD,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAEvD;;;;;GAKG;AACH,cAEM,MAAO,SAAQ,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC;IACtD,MAAM,CAAC,QAAQ,CAAC,WAAW,YAAW;IAEtC,MAAM,CAAC,SAAS;;QAXlB;;;;;WAKG;;;;;;;;;;;OAM2B;IAC5B,MAAM,CAAC,YAAY;;QAZrB;;;;;WAKG;;;;;;;;;;;SAOiC;IAClC,MAAM,CAAC,YAAY;;;;;yCAKO,cAAc;MAC9B;IAEV,KAAK;;MAAoB;IAEzB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAED,iBAAiB;IAKjB,kBAAkB;IAKlB,oBAAoB;IAmBpB,iBAAiB,UAAW,cAAc,UAGzC;IAED,cAAc;IAQd,MAAM;CAyBP;AAED,eAAe,MAAM,CAAA;AACrB,OAAO,EAAE,MAAM,EAAE,CAAA"}

package/types/Avatar/props.d.ts

@@ -1,6 +1,6 @@
 import { SyntheticEvent } from 'react';
 import type { Spacing, WithStyleProps, ComponentStyle } from '@instructure/emotion';
-import type { AsElementType, AvatarTheme, PropValidators } from '@instructure/shared-types';
+import type { AsElementType, AvatarTheme, OtherHTMLAttributes, PropValidators } from '@instructure/shared-types';
 declare type AvatarOwnProps = {
     /**
      * The name to display. It will be automatically converted to initials.
@@ -33,7 +33,7 @@ declare type AvatarOwnProps = {
      */
     as?: AsElementType;
     /**
-     * Provides a reference to the underlying html element
+     * provides a reference to the underlying html root element
      */
     elementRef?: (element: Element | null) => void;
 };
@@ -42,7 +42,7 @@ export declare type AvatarState = {
 };
 declare type PropKeys = keyof AvatarOwnProps;
 declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
-declare type AvatarProps = AvatarOwnProps & WithStyleProps<AvatarTheme, AvatarStyle>;
+declare type AvatarProps = AvatarOwnProps & WithStyleProps<AvatarTheme, AvatarStyle> & OtherHTMLAttributes<AvatarOwnProps>;
 declare type AvatarStyle = ComponentStyle<'avatar' | 'initials' | 'loadImage'>;
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;

package/types/Avatar/props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Avatar/props.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAA;AAKtC,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,aAAa,EACb,WAAW,EACX,cAAc,EACf,MAAM,2BAA2B,CAAA;AAElC,aAAK,cAAc,GAAG;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,EACA,MAAM,GACN,UAAU,GACV,SAAS,GACT,OAAO,GACP,QAAQ,GACR,OAAO,GACP,SAAS,GACT,UAAU,CAAA;IACd,KAAK,EACD,SAAS,GACT,UAAU,GACV,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,KAAK,CAAA;IACT,KAAK,EAAE,QAAQ,GAAG,WAAW,CAAA;IAC7B,OAAO,EAAE,cAAc,GAAG,OAAO,CAAA;IACjC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,aAAa,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAA;IAC9C;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;CAC/C,CAAA;AAED,oBAAY,WAAW,GAAG;IACxB,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,cAAc,CAAA;AAEpC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,WAAW,GAAG,cAAc,GAAG,cAAc,CAAC,WAAW,EAAE,WAAW,CAAC,CAAA;AAE5E,aAAK,WAAW,GAAG,cAAc,CAAC,QAAQ,GAAG,UAAU,GAAG,WAAW,CAAC,CAAA;AAEtE,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CA6BvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAYnB,CAAA;AAED,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,CAAA;AACxC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Avatar/props.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAA;AAKtC,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,aAAa,EACb,WAAW,EACX,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAElC,aAAK,cAAc,GAAG;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,EACA,MAAM,GACN,UAAU,GACV,SAAS,GACT,OAAO,GACP,QAAQ,GACR,OAAO,GACP,SAAS,GACT,UAAU,CAAA;IACd,KAAK,EACD,SAAS,GACT,UAAU,GACV,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,KAAK,CAAA;IACT,KAAK,EAAE,QAAQ,GAAG,WAAW,CAAA;IAC7B,OAAO,EAAE,cAAc,GAAG,OAAO,CAAA;IACjC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,aAAa,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAA;IAC9C;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;CAC/C,CAAA;AAED,oBAAY,WAAW,GAAG;IACxB,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,cAAc,CAAA;AAEpC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,WAAW,GAAG,cAAc,GAC/B,cAAc,CAAC,WAAW,EAAE,WAAW,CAAC,GACxC,mBAAmB,CAAC,cAAc,CAAC,CAAA;AAErC,aAAK,WAAW,GAAG,cAAc,CAAC,QAAQ,GAAG,UAAU,GAAG,WAAW,CAAC,CAAA;AAEtE,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CA6BvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAYnB,CAAA;AAED,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,CAAA;AACxC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}