@uncinc/uncinc-react-kitchen-sink 2.16.9 → 2.16.10

package/dist/components/Lottie/LottieAnimation/index.d.ts

@@ -1,3 +1,5 @@
-export default LottieAnimation;
-declare const LottieAnimation: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
 import React from 'react';
+import type { LottieProps } from '../types';
+import './style.scss';
+declare const LottieAnimation: React.ForwardRefExoticComponent<Omit<LottieProps, "delay"> & React.RefAttributes<import("lottie-web").AnimationItem>>;
+export default LottieAnimation;

package/dist/components/Lottie/LottieAnimation/index.js

@@ -1,86 +1,145 @@
-import React, { useEffect, useCallback, useRef } from 'react';
+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 ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+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) { _defineProperty(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; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+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); }
+import React, { useEffect, useCallback, useRef, useMemo } from 'react';
 import c from 'classnames';
 import lottie from 'lottie-web';
 import './style.scss';
+var DIRECTION_FORWARD = 1;
+var DIRECTION_BACKWARDS = -1;
 var LottieAnimation = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var id = props.id,
     className = props.className,
-    ariaLabel = props.ariaLabel,
-    data = props.data;
-  var DIRECTION_FORWARD = 1;
-  var DIRECTION_BACKWARDS = -1;
-  var lottieClasses = c('Lottie', className);
-  var refInternal = useRef(null);
+    _props$ariaLabel = props.ariaLabel,
+    ariaLabel = _props$ariaLabel === void 0 ? 'animation' : _props$ariaLabel,
+    data = props.data,
+    path = props.path,
+    _props$renderer = props.renderer,
+    renderer = _props$renderer === void 0 ? 'svg' : _props$renderer,
+    _props$rendererSettin = props.rendererSettings,
+    rendererSettings = _props$rendererSettin === void 0 ? {
+      preserveAspectRatio: 'xMidYMid meet'
+    } : _props$rendererSettin,
+    _props$loop = props.loop,
+    loop = _props$loop === void 0 ? true : _props$loop,
+    _props$autoPlay = props.autoPlay,
+    autoPlay = _props$autoPlay === void 0 ? true : _props$autoPlay,
+    _props$speed = props.speed,
+    speed = _props$speed === void 0 ? 1 : _props$speed,
+    startPosition = props.startPosition,
+    _props$direction = props.direction,
+    direction = _props$direction === void 0 ? 1 : _props$direction,
+    segments = props.segments,
+    _props$activateOnHove = props.activateOnHover,
+    activateOnHover = _props$activateOnHove === void 0 ? false : _props$activateOnHove,
+    _props$pauseOnClick = props.pauseOnClick,
+    pauseOnClick = _props$pauseOnClick === void 0 ? false : _props$pauseOnClick,
+    onInit = props.onInit,
+    onDestroy = props.onDestroy;
+  var refInternal = useRef();
   var lottieAnimation = ref || refInternal;
-  var lottieId = id || (data ? data.nm : null);
+  var rendererSettingsRef = useRef(rendererSettings);
+  var onInitRef = useRef(onInit);
+  var lottieClasses = c('Lottie', className);
+  var lottieId = useMemo(function () {
+    if (id) {
+      return id;
+    }
+    if (_typeof(data) === 'object' && data !== null && 'nm' in data && typeof data.nm === 'string') {
+      return data.nm;
+    }
+    return '';
+  }, [data, id]);
 
-  /*
-  * Initial load of the Lottie animation
-  */
-  var loadAnimation = useCallback(function () {
-    var renderer = props.renderer,
-      rendererSettings = props.rendererSettings,
-      direction = props.direction,
-      loop = props.loop,
-      autoPlay = props.autoPlay,
-      path = props.path,
-      speed = props.speed,
-      segments = props.segments,
-      activateOnHover = props.activateOnHover,
-      startPosition = props.startPosition,
-      onInit = props.onInit;
-    lottieAnimation.current = lottie.loadAnimation({
+  /**
+   * Create a Lottie config object from the given props
+   */
+  var config = useMemo(function () {
+    return {
       animationData: data,
-      container: document.getElementById("lottie--".concat(lottieId)),
+      path: path,
       renderer: renderer,
-      rendererSettings: rendererSettings,
-      direction: direction,
       loop: activateOnHover ? false : loop,
       autoplay: activateOnHover ? false : autoPlay,
-      path: path
-    });
-    onInit(lottieAnimation.current);
+      speed: speed,
+      startPosition: startPosition,
+      direction: direction,
+      segments: segments
+    };
+  }, [data, path, renderer, loop, autoPlay, speed, startPosition, direction, segments, activateOnHover]);
+
+  /*
+  * Initial load of the Lottie animation
+  */
+  var loadAnimation = useCallback(function () {
+    if (!lottieAnimation || !('current' in lottieAnimation)) {
+      return;
+    }
+    var container = document.getElementById("lottie--".concat(lottieId)) || document.documentElement;
+    lottieAnimation.current = lottie.loadAnimation(_objectSpread(_objectSpread({}, config), {}, {
+      container: container,
+      rendererSettings: rendererSettingsRef.current
+    }));
+    if (onInitRef.current) {
+      onInitRef.current(lottieAnimation.current);
+    }
 
     // Set the default speed.
-    lottieAnimation.current.setSpeed(speed);
+    lottieAnimation.current.setSpeed(config.speed);
+
+    // Set the default direction.
+    lottieAnimation.current.setDirection(config.direction);
+
     // Play segments if we have them.
-    if (segments) {
-      lottieAnimation.current.playSegments(segments);
+    if (config.segments) {
+      lottieAnimation.current.playSegments(config.segments);
     }
-    // If startPosition is defined use it as a starting frame, startPosition should be between 0 and 1.
-    if (startPosition) {
-      var startingFrame = Math.round(lottieAnimation.current.totalFrames * startPosition);
+
+    // If startPosition is defined use it as a starting frame,
+    // startPosition should be between 0 and 1.
+    if (config.startPosition) {
+      var startingFrame = Math.round(lottieAnimation.current.totalFrames * config.startPosition);
       lottieAnimation.current.goToAndStop(startingFrame, true);
     }
-  }, [data, lottieAnimation, lottieId, props]);
+  }, [config, lottieAnimation, lottieId]);
 
   /*
   * Reverse direction on Mouse enter.
   */
-  var onMouseEnter = function onMouseEnter(e) {
-    var activateOnHover = props.activateOnHover;
+  var onMouseEnter = useCallback(function () {
+    if (!(_typeof(lottieAnimation) === 'object' && lottieAnimation.current)) {
+      return;
+    }
     if (activateOnHover) {
       lottieAnimation.current.setDirection(DIRECTION_FORWARD);
       lottieAnimation.current.play();
     }
-  };
+  }, [activateOnHover, lottieAnimation]);
 
   /*
   * Reverse direction on Mouse leave
   */
-  var onMouseLeave = function onMouseLeave() {
-    var activateOnHover = props.activateOnHover;
+  var onMouseLeave = useCallback(function () {
+    if (!(_typeof(lottieAnimation) === 'object' && lottieAnimation.current)) {
+      return;
+    }
     if (activateOnHover) {
       lottieAnimation.current.setDirection(DIRECTION_BACKWARDS);
       lottieAnimation.current.play();
     }
-  };
+  }, [activateOnHover, lottieAnimation]);
 
   /*
   * Toggle the animation on click
   */
-  var onClick = function onClick() {
-    var pauseOnClick = props.pauseOnClick;
+  var onClick = useCallback(function () {
+    if (!(_typeof(lottieAnimation) === 'object' && lottieAnimation.current)) {
+      return;
+    }
     if (pauseOnClick) {
       if (lottieAnimation.current.isPaused) {
         lottieAnimation.current.play();
@@ -88,29 +147,45 @@ var LottieAnimation = /*#__PURE__*/React.forwardRef(function (props, ref) {
         lottieAnimation.current.pause();
       }
     }
-  };
+  }, [lottieAnimation, pauseOnClick]);
+
+  /**
+   * Handle keyboard interaction for accessibility
+   * @param event - keyboard event
+   */
+  var onKeyDown = useCallback(function (event) {
+    if (pauseOnClick && (event.key === 'Enter' || event.key === ' ')) {
+      event.preventDefault();
+      onClick();
+    }
+  }, [onClick, pauseOnClick]);
 
   // Init the Lottie animation.
   useEffect(function () {
-    var onDestroy = props.onDestroy;
     loadAnimation();
     return function () {
-      onDestroy(lottieAnimation.current);
+      if (!(_typeof(lottieAnimation) === 'object' && lottieAnimation.current)) {
+        return;
+      }
+      if (onDestroy) {
+        onDestroy(lottieAnimation.current);
+      }
       lottieAnimation.current.destroy();
     };
-  }, [props, loadAnimation, lottieAnimation]);
-  return (
-    /*#__PURE__*/
-    // eslint-disable-next-line jsx-a11y/interactive-supports-focus
-    React.createElement("div", {
-      onMouseEnter: onMouseEnter,
-      onMouseLeave: onMouseLeave,
-      onClick: onClick,
-      className: lottieClasses,
-      id: "lottie--".concat(lottieId),
-      "aria-label": ariaLabel,
-      role: "button"
-    })
-  );
+  }, [loadAnimation, lottieAnimation, onDestroy]);
+  return /*#__PURE__*/React.createElement("div", _extends({
+    className: lottieClasses,
+    id: "lottie--".concat(lottieId),
+    "aria-label": ariaLabel
+    // Only make the Lottie interactable if we provide the necessary props,
+    // otherwise it's just a plain div.
+  }, pauseOnClick || activateOnHover ? {
+    role: 'button',
+    tabIndex: 0,
+    onMouseEnter: onMouseEnter,
+    onMouseLeave: onMouseLeave,
+    onClick: onClick,
+    onKeyDown: onKeyDown
+  } : {}));
 });
 export default LottieAnimation;

package/dist/components/Lottie/index.d.ts

@@ -1,3 +1,4 @@
-export default Lottie;
-declare const Lottie: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
 import React from 'react';
+import type { LottieProps } from './types';
+declare const Lottie: React.ForwardRefExoticComponent<LottieProps & React.RefAttributes<import("lottie-web").AnimationItem>>;
+export default Lottie;

package/dist/components/Lottie/index.js

@@ -1,12 +1,15 @@
+var _excluded = ["delay"];
 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 _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
 import React, { lazy, Suspense } from 'react';
-import PropTypes from 'prop-types';
-
 // Lazy-load Lottie animations with a delay.
 var Lottie = /*#__PURE__*/React.forwardRef(function (props, ref) {
-  var delay = props.delay;
+  var delay = props.delay,
+    restProps = _objectWithoutProperties(props, _excluded);
   var LottieAnimation = /*#__PURE__*/lazy(function () {
     return new Promise(function (resolve) {
+      // @ts-expect-error
       setTimeout(function () {
         return resolve(import('./LottieAnimation'));
       }, delay);
@@ -14,56 +17,6 @@ var Lottie = /*#__PURE__*/React.forwardRef(function (props, ref) {
   });
   return /*#__PURE__*/React.createElement(Suspense, null, /*#__PURE__*/React.createElement(LottieAnimation, _extends({
     ref: ref
-  }, props)));
+  }, restProps)));
 });
-Lottie.propTypes = {
-  id: PropTypes.string,
-  className: PropTypes.string,
-  renderer: PropTypes.string,
-  rendererSettings: PropTypes.shape({
-    preserveAspectRatio: PropTypes.string
-  }),
-  data: PropTypes.object,
-  path: PropTypes.string,
-  segments: PropTypes.array,
-  // Events
-  onInit: PropTypes.func,
-  onDestroy: PropTypes.func,
-  // Options
-  delay: PropTypes.number,
-  autoPlay: PropTypes.bool,
-  loop: PropTypes.bool,
-  speed: PropTypes.number,
-  direction: PropTypes.number,
-  activateOnHover: PropTypes.bool,
-  pauseOnClick: PropTypes.bool,
-  olaTime: PropTypes.number,
-  startPosition: PropTypes.number,
-  ariaLabel: PropTypes.string
-};
-Lottie.defaultProps = {
-  id: null,
-  className: null,
-  renderer: 'svg',
-  rendererSettings: {
-    preserveAspectRatio: 'xMidYMid meet'
-  },
-  data: null,
-  path: null,
-  segments: null,
-  // Events
-  onInit: function onInit() {},
-  onDestroy: function onDestroy() {},
-  // Options
-  delay: null,
-  autoPlay: true,
-  loop: true,
-  speed: 1,
-  direction: 1,
-  activateOnHover: false,
-  pauseOnClick: false,
-  ariaLabel: 'animation',
-  olaTime: 300,
-  startPosition: null
-};
 export default Lottie;

package/dist/components/Lottie/types.d.ts

@@ -0,0 +1,22 @@
+import type { AnimationConfig, AnimationConfigWithData, AnimationConfigWithPath, AnimationDirection, AnimationItem, RendererType } from 'lottie-web';
+export type LottieItem = AnimationItem;
+export interface LottieConfig<T extends RendererType = 'svg'> extends Omit<AnimationConfig<T>, 'container'> {
+    animationData?: AnimationConfigWithData['animationData'];
+    path?: AnimationConfigWithPath['path'];
+    speed: number;
+    startPosition?: number;
+    direction: AnimationDirection;
+    segments?: Array<any>;
+}
+export interface LottieProps extends Omit<Partial<LottieConfig>, 'animationData' | 'autoplay'> {
+    id?: string;
+    className?: string;
+    ariaLabel?: string;
+    data?: unknown;
+    autoPlay?: AnimationConfig['autoplay'];
+    delay?: number;
+    activateOnHover?: boolean;
+    pauseOnClick?: boolean;
+    onInit?: (lottie: LottieItem) => void;
+    onDestroy?: (lottie: LottieItem) => void;
+}

package/dist/components/Lottie/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uncinc/uncinc-react-kitchen-sink",
-  "version": "2.16.9",
+  "version": "2.16.10",
   "description": "Default React components that are easily extended.",
   "author": "uncinc",
   "license": "MIT",