victory-group 35.11.3 → 36.2.0

package/es/helper-methods.js

@@ -8,8 +8,21 @@ function _iterableToArray(iter) { if (Symbol.iterator in Object(iter) || Object.
 
 function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) { for (var i = 0, arr2 = new Array(arr.length); i < arr.length; i++) { arr2[i] = arr[i]; } return arr2; } }
 
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance"); }
+
+function _iterableToArrayLimit(arr, i) { var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; var ownKeys = Object.keys(source); if (typeof Object.getOwnPropertySymbols === 'function') { ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function (sym) { return Object.getOwnPropertyDescriptor(source, sym).enumerable; })); } ownKeys.forEach(function (key) { _defineProperty(target, key, source[key]); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
 import React from "react";
-import { Helpers, Scale, Data, Wrapper } from "victory-core";
+import { Data, Helpers, Scale, Wrapper } from "victory-core";
+import isEqual from "react-fast-compare";
 var fallbackProps = {
   width: 450,
   height: 300,
@@ -65,6 +78,38 @@ export function getCalculatedProps(props, childComponents) {
     origin: origin,
     padding: padding
   };
+} // We need to remove sharedEvents in order to memoize the calculated data
+// With shared events, the props change on every event, and every value is re-calculated
+
+var withoutSharedEvents = function (props) {
+  var children = props.children;
+  var modifiedChildren = React.Children.toArray(children).map(function (child) {
+    return _objectSpread({}, child, {
+      props: Helpers.omit(child.props, ["sharedEvents"])
+    });
+  });
+  props.children = modifiedChildren;
+  return props;
+};
+
+export function useMemoizedProps(initialProps) {
+  var modifiedProps = withoutSharedEvents(initialProps);
+
+  var _React$useState = React.useState(modifiedProps),
+      _React$useState2 = _slicedToArray(_React$useState, 2),
+      props = _React$useState2[0],
+      setProps = _React$useState2[1]; // React.memo uses shallow equality to compare objects. This way props
+  // will only be re-calculated when they change.
+
+
+  React.useEffect(function () {
+    if (!isEqual(modifiedProps, props)) {
+      setProps(modifiedProps);
+    }
+  }, [props, setProps, modifiedProps]);
+  return React.useMemo(function () {
+    return getCalculatedProps(props, props.children);
+  }, [props]);
 }
 
 function pixelsToValue(props, axis, calculatedProps) {

package/es/index.d.ts

@@ -19,6 +19,7 @@ export interface VictoryGroupProps
     VictoryDatableProps,
     VictoryMultiLabelableProps {
   categories?: CategoryPropType;
+  children?: React.ReactNode;
   color?: string;
   colorScale?: ColorScalePropType;
   domain?: DomainPropType;

package/es/victory-group.js

@@ -6,23 +6,11 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-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); return Constructor; }
-
-function _possibleConstructorReturn(self, call) { if (call && (typeof call === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }
-
-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, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
-
-function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
-
 import PropTypes from "prop-types";
 import React from "react";
-import { Helpers, VictoryContainer, VictoryTheme, CommonProps, Wrapper } from "victory-core";
+import { Helpers, VictoryContainer, VictoryTheme, CommonProps, Wrapper, Hooks } from "victory-core";
 import { VictorySharedEvents } from "victory-shared-events";
-import { getChildren, getCalculatedProps } from "./helper-methods";
+import { getChildren, useMemoizedProps } from "./helper-methods";
 import isEqual from "react-fast-compare";
 var fallbackProps = {
   width: 450,
@@ -31,76 +19,46 @@ var fallbackProps = {
   offset: 0
 };
 
-var VictoryGroup =
-/*#__PURE__*/
-function (_React$Component) {
-  _inherits(VictoryGroup, _React$Component);
-
-  function VictoryGroup(props) {
-    var _this;
-
-    _classCallCheck(this, VictoryGroup);
-
-    _this = _possibleConstructorReturn(this, (VictoryGroup.__proto__ || Object.getPrototypeOf(VictoryGroup)).call(this, props));
-
-    if (props.animate) {
-      _this.state = {
-        nodesShouldLoad: false,
-        nodesDoneLoad: false,
-        animating: true
-      };
-      _this.setAnimationState = Wrapper.setAnimationState.bind(_assertThisInitialized(_this));
-    }
-
-    return _this;
-  }
-
-  _createClass(VictoryGroup, [{
-    key: "shouldComponentUpdate",
-    value: function shouldComponentUpdate(nextProps) {
-      if (this.props.animate) {
-        if (!isEqual(this.props, nextProps)) {
-          this.setAnimationState(this.props, nextProps);
-          return false;
-        }
-      }
-
-      return true;
-    }
-  }, {
-    key: "getNewChildren",
-    value: function getNewChildren(props, childComponents, calculatedProps) {
-      var children = getChildren(props, childComponents, calculatedProps);
-      var getAnimationProps = Wrapper.getAnimationProps.bind(this);
-      return children.map(function (child, index) {
-        var childProps = _assign({
-          animate: getAnimationProps(props, child, index)
-        }, child.props);
-
-        return React.cloneElement(child, childProps);
-      });
-    }
-  }, {
-    key: "renderContainer",
-    value: function renderContainer(containerComponent, props) {
-      var containerProps = _defaults({}, containerComponent.props, props);
-
-      return React.cloneElement(containerComponent, containerProps);
-    }
-  }, {
-    key: "getContainerProps",
-    value: function getContainerProps(props, calculatedProps) {
-      var width = props.width,
-          height = props.height,
-          standalone = props.standalone,
-          theme = props.theme,
-          polar = props.polar,
-          horizontal = props.horizontal,
-          name = props.name;
-      var domain = calculatedProps.domain,
-          scale = calculatedProps.scale,
-          style = calculatedProps.style,
-          origin = calculatedProps.origin;
+var VictoryGroup = function (initialProps) {
+  // eslint-disable-next-line no-use-before-define
+  var role = VictoryGroupMemo.role;
+
+  var _Hooks$useAnimationSt = Hooks.useAnimationState(),
+      getAnimationProps = _Hooks$useAnimationSt.getAnimationProps,
+      setAnimationState = _Hooks$useAnimationSt.setAnimationState,
+      getProps = _Hooks$useAnimationSt.getProps;
+
+  var props = getProps(initialProps);
+  var modifiedProps = Helpers.modifyProps(props, fallbackProps, role);
+  var eventKey = modifiedProps.eventKey,
+      containerComponent = modifiedProps.containerComponent,
+      standalone = modifiedProps.standalone,
+      groupComponent = modifiedProps.groupComponent,
+      externalEventMutations = modifiedProps.externalEventMutations,
+      width = modifiedProps.width,
+      height = modifiedProps.height,
+      theme = modifiedProps.theme,
+      polar = modifiedProps.polar,
+      horizontal = modifiedProps.horizontal,
+      name = modifiedProps.name;
+  var childComponents = React.Children.toArray(modifiedProps.children);
+  var calculatedProps = useMemoizedProps(modifiedProps);
+  var domain = calculatedProps.domain,
+      scale = calculatedProps.scale,
+      style = calculatedProps.style,
+      origin = calculatedProps.origin;
+  var newChildren = React.useMemo(function () {
+    var children = getChildren(props, childComponents, calculatedProps);
+    return children.map(function (child, index) {
+      var childProps = _assign({
+        animate: getAnimationProps(props, child, index, "victory-group")
+      }, child.props);
+
+      return React.cloneElement(child, childProps);
+    });
+  }, [props, childComponents, calculatedProps, getAnimationProps]);
+  var containerProps = React.useMemo(function () {
+    if (standalone) {
       return {
         domain: domain,
         scale: scale,
@@ -115,87 +73,63 @@ function (_React$Component) {
         name: name
       };
     }
-  }, {
-    key: "render",
-    value: function render() {
-      var role = this.constructor.role;
-      var props = this.state && this.state.nodesWillExit ? this.state.oldProps || this.props : this.props;
-      var modifiedProps = Helpers.modifyProps(props, fallbackProps, role);
-      var eventKey = modifiedProps.eventKey,
-          containerComponent = modifiedProps.containerComponent,
-          standalone = modifiedProps.standalone,
-          groupComponent = modifiedProps.groupComponent,
-          externalEventMutations = modifiedProps.externalEventMutations;
-      var childComponents = React.Children.toArray(modifiedProps.children);
-      var calculatedProps = getCalculatedProps(modifiedProps, childComponents);
-      var newChildren = this.getNewChildren(modifiedProps, childComponents, calculatedProps);
-      var containerProps = standalone ? this.getContainerProps(modifiedProps, calculatedProps) : {};
-      var container = standalone ? this.renderContainer(containerComponent, containerProps) : groupComponent;
-      var events = Wrapper.getAllEvents(props);
 
-      if (!_isEmpty(events)) {
-        return React.createElement(VictorySharedEvents, {
-          container: container,
-          eventKey: eventKey,
-          events: events,
-          externalEventMutations: externalEventMutations
-        }, newChildren);
-      }
+    return {};
+  }, [standalone, domain, scale, width, height, theme, style, horizontal, polar, origin, name]);
+  var container = React.useMemo(function () {
+    if (standalone) {
+      var defaultContainerProps = _defaults({}, containerComponent.props, containerProps);
 
-      return React.cloneElement(container, container.props, newChildren);
+      return React.cloneElement(containerComponent, defaultContainerProps);
     }
-  }]);
 
-  return VictoryGroup;
-}(React.Component);
-
-Object.defineProperty(VictoryGroup, "displayName", {
-  configurable: true,
-  enumerable: true,
-  writable: true,
-  value: "VictoryGroup"
-});
-Object.defineProperty(VictoryGroup, "role", {
-  configurable: true,
-  enumerable: true,
-  writable: true,
-  value: "group"
-});
-Object.defineProperty(VictoryGroup, "propTypes", {
-  configurable: true,
-  enumerable: true,
-  writable: true,
-  value: _objectSpread({}, CommonProps.baseProps, CommonProps.dataProps, {
-    children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]),
-    color: PropTypes.oneOfType([PropTypes.string, PropTypes.func]),
-    colorScale: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string), PropTypes.oneOf(["grayscale", "qualitative", "heatmap", "warm", "cool", "red", "green", "blue"])]),
-    horizontal: PropTypes.bool,
-    offset: PropTypes.number
-  })
-});
-Object.defineProperty(VictoryGroup, "defaultProps", {
-  configurable: true,
-  enumerable: true,
-  writable: true,
-  value: {
-    containerComponent: React.createElement(VictoryContainer, null),
-    groupComponent: React.createElement("g", null),
-    samples: 50,
-    sortOrder: "ascending",
-    standalone: true,
-    theme: VictoryTheme.grayscale
+    return groupComponent;
+  }, [groupComponent, standalone, containerComponent, containerProps]);
+  var events = React.useMemo(function () {
+    return Wrapper.getAllEvents(props);
+  }, [props]);
+  var previousProps = Hooks.usePreviousProps(initialProps);
+  React.useEffect(function () {
+    // This is called before dismount to keep state in sync
+    return function () {
+      if (initialProps.animate) {
+        setAnimationState(previousProps, props);
+      }
+    };
+  }, [setAnimationState, previousProps, initialProps, props]);
+
+  if (!_isEmpty(events)) {
+    return React.createElement(VictorySharedEvents, {
+      container: container,
+      eventKey: eventKey,
+      events: events,
+      externalEventMutations: externalEventMutations
+    }, newChildren);
   }
+
+  return React.cloneElement(container, container.props, newChildren);
+};
+
+VictoryGroup.propTypes = _objectSpread({}, CommonProps.baseProps, CommonProps.dataProps, {
+  children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]),
+  color: PropTypes.oneOfType([PropTypes.string, PropTypes.func]),
+  colorScale: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string), PropTypes.oneOf(["grayscale", "qualitative", "heatmap", "warm", "cool", "red", "green", "blue"])]),
+  horizontal: PropTypes.bool,
+  offset: PropTypes.number
 });
-Object.defineProperty(VictoryGroup, "expectedComponents", {
-  configurable: true,
-  enumerable: true,
-  writable: true,
-  value: ["groupComponent", "containerComponent", "labelComponent"]
-});
-Object.defineProperty(VictoryGroup, "getChildren", {
-  configurable: true,
-  enumerable: true,
-  writable: true,
-  value: getChildren
-});
-export { VictoryGroup as default };
+VictoryGroup.defaultProps = {
+  containerComponent: React.createElement(VictoryContainer, null),
+  groupComponent: React.createElement("g", null),
+  samples: 50,
+  sortOrder: "ascending",
+  standalone: true,
+  theme: VictoryTheme.grayscale
+}; // We need to attatch the static properties to the memoized version, or else
+// VictoryChart will not be able to get this component's role type
+
+var VictoryGroupMemo = React.memo(VictoryGroup, isEqual);
+VictoryGroupMemo.displayName = "VictoryGroup";
+VictoryGroupMemo.role = "group";
+VictoryGroupMemo.expectedComponents = ["groupComponent", "containerComponent", "labelComponent"];
+VictoryGroupMemo.getChildren = getChildren;
+export default VictoryGroupMemo;

package/lib/helper-methods.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getCalculatedProps = getCalculatedProps;
+exports.useMemoizedProps = useMemoizedProps;
 exports.getChildren = getChildren;
 
 var _assign2 = _interopRequireDefault(require("lodash/assign"));
@@ -12,6 +13,8 @@ var _react = _interopRequireDefault(require("react"));
 
 var _victoryCore = require("victory-core");
 
+var _reactFastCompare = _interopRequireDefault(require("react-fast-compare"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _nonIterableSpread(); }
@@ -22,6 +25,18 @@ function _iterableToArray(iter) { if (Symbol.iterator in Object(iter) || Object.
 
 function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) { for (var i = 0, arr2 = new Array(arr.length); i < arr.length; i++) { arr2[i] = arr[i]; } return arr2; } }
 
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance"); }
+
+function _iterableToArrayLimit(arr, i) { var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; var ownKeys = Object.keys(source); if (typeof Object.getOwnPropertySymbols === 'function') { ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function (sym) { return Object.getOwnPropertyDescriptor(source, sym).enumerable; })); } ownKeys.forEach(function (key) { _defineProperty(target, key, source[key]); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
 var fallbackProps = {
   width: 450,
   height: 300,
@@ -84,6 +99,42 @@ function getCalculatedProps(props, childComponents) {
     origin: origin,
     padding: padding
   };
+} // We need to remove sharedEvents in order to memoize the calculated data
+// With shared events, the props change on every event, and every value is re-calculated
+
+
+var withoutSharedEvents = function (props) {
+  var children = props.children;
+
+  var modifiedChildren = _react.default.Children.toArray(children).map(function (child) {
+    return _objectSpread({}, child, {
+      props: _victoryCore.Helpers.omit(child.props, ["sharedEvents"])
+    });
+  });
+
+  props.children = modifiedChildren;
+  return props;
+};
+
+function useMemoizedProps(initialProps) {
+  var modifiedProps = withoutSharedEvents(initialProps);
+
+  var _React$useState = _react.default.useState(modifiedProps),
+      _React$useState2 = _slicedToArray(_React$useState, 2),
+      props = _React$useState2[0],
+      setProps = _React$useState2[1]; // React.memo uses shallow equality to compare objects. This way props
+  // will only be re-calculated when they change.
+
+
+  _react.default.useEffect(function () {
+    if (!(0, _reactFastCompare.default)(modifiedProps, props)) {
+      setProps(modifiedProps);
+    }
+  }, [props, setProps, modifiedProps]);
+
+  return _react.default.useMemo(function () {
+    return getCalculatedProps(props, props.children);
+  }, [props]);
 }
 
 function pixelsToValue(props, axis, calculatedProps) {

package/lib/index.d.ts

@@ -19,6 +19,7 @@ export interface VictoryGroupProps
     VictoryDatableProps,
     VictoryMultiLabelableProps {
   categories?: CategoryPropType;
+  children?: React.ReactNode;
   color?: string;
   colorScale?: ColorScalePropType;
   domain?: DomainPropType;