@zohodesk/components 1.0.0-alpha-249 → 1.0.0-alpha-252

package/lib/Avatar/Avatar.js

@@ -0,0 +1,199 @@
+"use strict";
+
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _defaultProps = require("./props/defaultProps");
+var _propTypes = require("./props/propTypes");
+var _getInitial = require("../utils/getInitial");
+var _AvatarSize = _interopRequireDefault(require("../Provider/AvatarSize"));
+var _AvatarModule = _interopRequireDefault(require("./Avatar.module.css"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
+/*
+1. need to change name into firstName lastName
+2. pattern support via context as well as props
+3. prop high priority to arrange firstName lastName
+4. team pass name as lastName and pass pattern via prop
+*/
+/*
+eslint css-modules/no-unused-class: [2, { markAsUsed: ['circle', 'square',
+'small','medium','xmedium',"xsmall", "large", "xlarge", "primary", "secondary",
+"info","default"] }]
+*/
+var Avatar = /*#__PURE__*/function (_React$Component) {
+  _inherits(Avatar, _React$Component);
+  var _super = _createSuper(Avatar);
+  function Avatar(props) {
+    var _this;
+    _classCallCheck(this, Avatar);
+    _this = _super.call(this, props);
+    _this.state = {
+      isLoaded: false
+    };
+    _this.putInvalidImageURLJSON = _this.putInvalidImageURLJSON.bind(_assertThisInitialized(_this));
+    _this.putValidImageURLJSON = _this.putValidImageURLJSON.bind(_assertThisInitialized(_this));
+    _this.getInitialByFullName = _this.getInitialByFullName.bind(_assertThisInitialized(_this));
+    return _this;
+  }
+  _createClass(Avatar, [{
+    key: "componentDidUpdate",
+    value: function componentDidUpdate(prevProps, prevState) {
+      var src = this.props.src;
+      var isLoaded = this.state.isLoaded;
+      if (prevProps.src !== src) {
+        this.setState({
+          isLoaded: !isLoaded
+        });
+      }
+    }
+  }, {
+    key: "putInvalidImageURLJSON",
+    value: function putInvalidImageURLJSON() {
+      var _this$props = this.props,
+        src = _this$props.src,
+        alternateSrc = _this$props.alternateSrc;
+      var isLoaded = this.state.isLoaded;
+      var _validImgArr = _toConsumableArray(Avatar.validImageURLs);
+      var _invalidImgArr = _toConsumableArray(Avatar.invalidImageURLs);
+
+      // if (alternateSrc) {
+      //   _validImgArr.push(alternateSrc);
+      // }
+
+      var validIndex = _validImgArr.indexOf(src);
+      if (validIndex !== -1) {
+        _validImgArr.splice(validIndex, 1);
+      }
+      _invalidImgArr.push(src);
+      Avatar.invalidImageURLs = _invalidImgArr;
+      Avatar.validImageURLs = _validImgArr;
+      this.setState({
+        isLoaded: !isLoaded
+      });
+    }
+  }, {
+    key: "putValidImageURLJSON",
+    value: function putValidImageURLJSON() {
+      var src = this.props.src;
+      var isLoaded = this.state.isLoaded;
+      var validImgArr = Avatar.validImageURLs;
+      var invalidImgArr = Avatar.invalidImageURLs;
+      if (src && validImgArr.indexOf(src) === -1 && invalidImgArr.indexOf(src) === -1) {
+        var _validImgArr = _toConsumableArray(validImgArr);
+        _validImgArr.push(src);
+        Avatar.validImageURLs = _validImgArr;
+        this.setState({
+          isLoaded: !isLoaded
+        });
+      }
+    }
+
+    /* this will cause error if user name already have some space need to move firstName lastName user preference pattern*/
+  }, {
+    key: "getInitialByFullName",
+    value: function getInitialByFullName() {
+      var fullName = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
+      fullName = (fullName || '').trim();
+      var nameList = fullName.split(' ');
+      if (nameList.length === 1) {
+        return (0, _getInitial.getInitial)('', nameList[0]);
+      }
+      return (0, _getInitial.getInitial)(nameList[0], nameList[1]);
+    }
+
+    // componentDidMount() {
+    //   const { src } = this.props;
+    //   const validImgArr = Avatar.validImageURLs;
+    //   if (validImgArr.indexOf(src) === -1) {
+    //     let _validImgArr = [...validImgArr];
+    //     _validImgArr.push(src);
+    //   }
+    // }
+  }, {
+    key: "render",
+    value: function render() {
+      var _this$props2 = this.props,
+        src = _this$props2.src,
+        name = _this$props2.name,
+        size = _this$props2.size,
+        palette = _this$props2.palette,
+        onClick = _this$props2.onClick,
+        title = _this$props2.title,
+        shape = _this$props2.shape,
+        needTitle = _this$props2.needTitle,
+        dataId = _this$props2.dataId,
+        initial = _this$props2.initial,
+        needBorder = _this$props2.needBorder,
+        borderOnActive = _this$props2.borderOnActive,
+        borderOnHover = _this$props2.borderOnHover,
+        textPalette = _this$props2.textPalette,
+        customClass = _this$props2.customClass,
+        alternateSrc = _this$props2.alternateSrc,
+        isAnimate = _this$props2.isAnimate,
+        customProps = _this$props2.customProps;
+      var _customProps$AvatarPr = customProps.AvatarProps,
+        AvatarProps = _customProps$AvatarPr === void 0 ? {} : _customProps$AvatarPr;
+      var textStyle = textPalette ? _AvatarModule["default"][textPalette] : palette === 'secondary' ? _AvatarModule["default"].white : _AvatarModule["default"].black;
+      var shapeStyle = shape === 'circle' ? 'circle' : "square_".concat(size);
+      initial = initial || this.getInitialByFullName(name);
+      var isInvalidImageList = Avatar.invalidImageURLs.indexOf(src) !== -1;
+      var isValidImageList = Avatar.validImageURLs.indexOf(src) !== -1;
+      var border = borderOnHover || onClick;
+      var borderStyle = (!src || src && isInvalidImageList || !isValidImageList) && needBorder ? "".concat(_AvatarModule["default"].border, " ").concat(borderOnActive ? _AvatarModule["default"].borderOnActive : border ? _AvatarModule["default"].borderOnHover : '', " ") : '';
+      var showAvatar = src && !isInvalidImageList;
+      var showInitial = !showAvatar || showAvatar && !isValidImageList;
+      var showAlternateAvatar = alternateSrc ? showInitial : false;
+      borderStyle = showAlternateAvatar ? '' : borderStyle;
+      return /*#__PURE__*/_react["default"].createElement("div", _extends({
+        className: "".concat(_AvatarModule["default"].avatar, " ").concat(_AvatarModule["default"][size], " ").concat((0, _AvatarSize["default"])(size), " ").concat(_AvatarModule["default"][shapeStyle], " ").concat(_AvatarModule["default"][palette], " ").concat(textStyle, " ").concat(borderStyle, " ").concat(customClass ? customClass : ''),
+        "data-title": needTitle ? title ? title : name : null,
+        "data-id": dataId,
+        onClick: onClick
+      }, AvatarProps), showInitial && !showAlternateAvatar && /*#__PURE__*/_react["default"].createElement("span", {
+        className: "".concat(_AvatarModule["default"].initial),
+        "data-id": "".concat(dataId, "_AvatarInitial")
+      }, initial), (showAvatar || showAlternateAvatar) && /*#__PURE__*/_react["default"].createElement(_react["default"].Fragment, null, /*#__PURE__*/_react["default"].createElement("img", {
+        className: "".concat(_AvatarModule["default"].image, " ").concat(isAnimate ? _AvatarModule["default"].animate : ''),
+        "data-id": "".concat(dataId, "_AvatarImg"),
+        name: name,
+        onError: this.putInvalidImageURLJSON,
+        onLoad: this.putValidImageURLJSON,
+        src: showAlternateAvatar ? alternateSrc : src
+      }), !isValidImageList && !showAlternateAvatar ? null : /*#__PURE__*/_react["default"].createElement("span", {
+        className: "".concat(_AvatarModule["default"].shadow, " ").concat(textStyle, " ")
+      })));
+    }
+  }]);
+  return Avatar;
+}(_react["default"].Component);
+exports["default"] = Avatar;
+Avatar.defaultProps = _defaultProps.defaultProps;
+Avatar.propTypes = _propTypes.propTypes;
+Avatar.invalidImageURLs = [];
+Avatar.validImageURLs = [];
+if (false) {
+  Avatar.docs = {
+    componentGroup: 'Avatar Group',
+    folderName: 'Style Guide'
+  };
+}

package/lib/Avatar/Avatar.module.css

@@ -0,0 +1,135 @@
+.varClass {
+  /* avatar default variables */
+  --avatar_text_color: var(--zdt_avatar_default_text);
+  --avatar_font_size: var(--zd_font_size14);
+  --avatar_bg_color: var(--zdt_avatar_default_bg);
+  --avatar_border_radius: 50%;
+  --avatar_border_width: 0;
+  --avatar_border_style: solid;
+  --avatar_border_color: var(--zdt_avatar_default_border);
+  --avatar_border_hoverColor: var(--zdt_avatar_default_borderHover);
+  --avatar_boxshadow: var(--zdt_avatar_default_boxshadow);
+  --avatar_text_transform: uppercase;
+}
+.avatar {
+  composes: varClass;
+  position: relative;
+  composes: dInflex alignVertical alignHorizontal from '../common/common.module.css';
+  vertical-align: middle;
+  font-size: var(--avatar_font_size);
+  color: var(--avatar_text_color);
+  border-width: var(--avatar_border_width);
+  border-style: var(--avatar_border_style);
+}
+.border {
+  border-color: var(--avatar_border_color);
+}
+.borderOnHover:hover, .borderOnActive {
+  border-color: var(--avatar_border_hoverColor);
+}
+.avatar, .primary {
+  background-color: var(--avatar_bg_color);
+}
+.shadow {
+  position: absolute;
+  height: 100%;
+  width: 100%;
+  top: 0;
+  pointer-events: none;
+  border-radius: var(--avatar_border_radius);
+}
+[dir=ltr] .shadow {
+  left: 0;
+}
+[dir=rtl] .shadow {
+  right: 0;
+}
+.shadow.black {
+  box-shadow: inset 0px 0px 5px var(--avatar_boxshadow);
+}
+.shadow.white {
+  box-shadow: inset 0px 0px 11px var(--avatar_boxshadow);
+}
+.avatar, .circle {
+  border-radius: var(--avatar_border_radius);
+}
+.border {
+  --avatar_border_width: 1px;
+}
+.image {
+  width: 100%;
+  height: 100%;
+  position: absolute;
+  top:0;
+  z-index: 0;
+  border-radius: var(--avatar_border_radius);
+}
+[dir=ltr] .image {
+  left:0;
+}
+[dir=rtl] .image { 
+  right:0;
+}
+.animate{
+  composes:fadeIn modeForward from './../common/animation.module.css';
+}
+[dir=ltr] .animate{
+  animation-duration: var(--zd_transition2);
+}
+[dir=rtl] .animate{
+  animation-duration: var(--zd_transition2);
+}
+.square_small {
+  --avatar_border_radius: 4px;
+}
+.square_xsmall {
+  --avatar_border_radius: 6px;
+}
+.square_medium,
+.square_xmedium {
+  --avatar_border_radius: 8px;
+}
+.square_large,
+.square_xlarge {
+  --avatar_border_radius: 10px;
+}
+.none {
+  display: none;
+}
+.default {
+  --avatar_border_width: 0;
+}
+.secondary {
+  --avatar_bg_color: var(--zdt_avatar_secondary_bg);
+}
+.info {
+  --avatar_bg_color: var(--zdt_avatar_info_bg);
+}
+.initial {
+  text-transform: var(--avatar_text_transform);
+  display: inline-block;
+}
+.small {
+  --avatar_font_size: var(--zd_font_size9);
+}
+.xsmall {
+  --avatar_font_size: var(--zd_font_size12);
+}
+.medium {
+  --avatar_font_size: var(--zd_font_size14);
+}
+.xmedium {
+  --avatar_font_size: var(--zd_font_size14);
+}
+.large {
+  --avatar_font_size: var(--zd_font_size18);
+}
+.xlarge {
+  --avatar_font_size: var(--zd_font_size28);
+}
+.white {
+  --avatar_text_color: var(--zdt_avatar_white_text);
+  --avatar_border_color: var(--zdt_avatar_white_border);
+  --avatar_border_hoverColor: var(--zdt_avatar_white_borderHover);
+  --avatar_boxshadow: var(--zdt_avatar_white_boxshadow);
+}

package/lib/Avatar/__tests__/Avatar.spec.js

@@ -0,0 +1,164 @@
+"use strict";
+
+var _react = _interopRequireDefault(require("react"));
+var _Avatar = _interopRequireDefault(require("../Avatar"));
+var _reactTestRenderer = _interopRequireDefault(require("react-test-renderer"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+var avatarURL = 'avatar.jpg';
+describe('Avatar component', function () {
+  it('should display initial', function () {
+    var ele = _reactTestRenderer["default"].create( /*#__PURE__*/_react["default"].createElement(_Avatar["default"], {
+      name: "vimalesan a"
+    }));
+    var tree = ele.toJSON();
+    expect(tree).toMatchSnapshot();
+  });
+  it('should display avatar image and initial while avatar loading...', function () {
+    var ele = _reactTestRenderer["default"].create( /*#__PURE__*/_react["default"].createElement(_Avatar["default"], {
+      name: "vimalesan a",
+      src: avatarURL
+    }));
+    var tree = ele.toJSON();
+    expect(tree).toMatchSnapshot();
+  });
+  it('should display initial if invalid url', function () {
+    _Avatar["default"].invalidImageURLs.push(avatarURL);
+    var ele = _reactTestRenderer["default"].create( /*#__PURE__*/_react["default"].createElement(_Avatar["default"], {
+      name: "vimalesan a",
+      src: avatarURL
+    }));
+    var tree = ele.toJSON();
+    expect(tree).toMatchSnapshot();
+  });
+  it('should display image valid url', function () {
+    _Avatar["default"].invalidImageURLs.length = 0;
+    _Avatar["default"].validImageURLs.push(avatarURL);
+    var ele = _reactTestRenderer["default"].create( /*#__PURE__*/_react["default"].createElement(_Avatar["default"], {
+      name: "vimalesan a",
+      src: avatarURL
+    }));
+    var tree = ele.toJSON();
+    expect(tree).toMatchSnapshot();
+  });
+  it('should the palette is default', function () {
+    _Avatar["default"].invalidImageURLs.length = 0;
+    _Avatar["default"].validImageURLs.push(avatarURL);
+    var ele = _reactTestRenderer["default"].create( /*#__PURE__*/_react["default"].createElement(_Avatar["default"], {
+      name: "vimalesan a",
+      src: avatarURL,
+      palette: "default"
+    }));
+    var tree = ele.toJSON();
+    expect(tree).toMatchSnapshot();
+  });
+  it('should the palette is secondary', function () {
+    _Avatar["default"].invalidImageURLs.length = 0;
+    _Avatar["default"].validImageURLs.push(avatarURL);
+    var ele = _reactTestRenderer["default"].create( /*#__PURE__*/_react["default"].createElement(_Avatar["default"], {
+      name: "vimalesan a",
+      src: avatarURL,
+      palette: "secondary"
+    }));
+    var tree = ele.toJSON();
+    expect(tree).toMatchSnapshot();
+  });
+  it('should the palette is info', function () {
+    _Avatar["default"].invalidImageURLs.length = 0;
+    _Avatar["default"].validImageURLs.push(avatarURL);
+    var ele = _reactTestRenderer["default"].create( /*#__PURE__*/_react["default"].createElement(_Avatar["default"], {
+      name: "vimalesan a",
+      src: avatarURL,
+      palette: "info"
+    }));
+    var tree = ele.toJSON();
+    expect(tree).toMatchSnapshot();
+  });
+  it('should the shape is square', function () {
+    _Avatar["default"].invalidImageURLs.length = 0;
+    _Avatar["default"].validImageURLs.push(avatarURL);
+    var ele = _reactTestRenderer["default"].create( /*#__PURE__*/_react["default"].createElement(_Avatar["default"], {
+      name: "vimalesan a",
+      src: avatarURL,
+      shape: "square"
+    }));
+    var tree = ele.toJSON();
+    expect(tree).toMatchSnapshot();
+  });
+  it('should the size is small', function () {
+    _Avatar["default"].invalidImageURLs.length = 0;
+    _Avatar["default"].validImageURLs.push(avatarURL);
+    var ele = _reactTestRenderer["default"].create( /*#__PURE__*/_react["default"].createElement(_Avatar["default"], {
+      name: "vimalesan a",
+      src: avatarURL,
+      size: "square"
+    }));
+    var tree = ele.toJSON();
+    expect(tree).toMatchSnapshot();
+  });
+  it('should the size is xsmall', function () {
+    _Avatar["default"].invalidImageURLs.length = 0;
+    _Avatar["default"].validImageURLs.push(avatarURL);
+    var ele = _reactTestRenderer["default"].create( /*#__PURE__*/_react["default"].createElement(_Avatar["default"], {
+      name: "vimalesan a",
+      src: avatarURL,
+      size: "xsmall"
+    }));
+    var tree = ele.toJSON();
+    expect(tree).toMatchSnapshot();
+  });
+  it('should the size is xmedium', function () {
+    _Avatar["default"].invalidImageURLs.length = 0;
+    _Avatar["default"].validImageURLs.push(avatarURL);
+    var ele = _reactTestRenderer["default"].create( /*#__PURE__*/_react["default"].createElement(_Avatar["default"], {
+      name: "vimalesan a",
+      src: avatarURL,
+      size: "xmedium"
+    }));
+    var tree = ele.toJSON();
+    expect(tree).toMatchSnapshot();
+  });
+  it('should the size is large', function () {
+    _Avatar["default"].invalidImageURLs.length = 0;
+    _Avatar["default"].validImageURLs.push(avatarURL);
+    var ele = _reactTestRenderer["default"].create( /*#__PURE__*/_react["default"].createElement(_Avatar["default"], {
+      name: "vimalesan a",
+      src: avatarURL,
+      size: "large"
+    }));
+    var tree = ele.toJSON();
+    expect(tree).toMatchSnapshot();
+  });
+  it('should the size is xlarge', function () {
+    _Avatar["default"].invalidImageURLs.length = 0;
+    _Avatar["default"].validImageURLs.push(avatarURL);
+    var ele = _reactTestRenderer["default"].create( /*#__PURE__*/_react["default"].createElement(_Avatar["default"], {
+      name: "vimalesan a",
+      src: avatarURL,
+      size: "xlarge"
+    }));
+    var tree = ele.toJSON();
+    expect(tree).toMatchSnapshot();
+  });
+  it('should have title', function () {
+    _Avatar["default"].invalidImageURLs.length = 0;
+    _Avatar["default"].validImageURLs.push(avatarURL);
+    var ele = _reactTestRenderer["default"].create( /*#__PURE__*/_react["default"].createElement(_Avatar["default"], {
+      name: "vimalesan a",
+      src: avatarURL,
+      title: "Sample Title"
+    }));
+    var tree = ele.toJSON();
+    expect(tree).toMatchSnapshot();
+  });
+  it('should no need title', function () {
+    _Avatar["default"].invalidImageURLs.length = 0;
+    _Avatar["default"].validImageURLs.push(avatarURL);
+    var ele = _reactTestRenderer["default"].create( /*#__PURE__*/_react["default"].createElement(_Avatar["default"], {
+      name: "vimalesan a",
+      src: avatarURL,
+      needTitle: false
+    }));
+    var tree = ele.toJSON();
+    expect(tree).toMatchSnapshot();
+  });
+});