victory-stack 35.11.3 → 36.2.0

package/lib/victory-stack.js

@@ -29,101 +29,64 @@ 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; }
-
 var fallbackProps = {
   width: 450,
   height: 300,
   padding: 50
 };
 
-var VictoryStack =
-/*#__PURE__*/
-function (_React$Component) {
-  _inherits(VictoryStack, _React$Component);
-
-  function VictoryStack(props) {
-    var _this;
-
-    _classCallCheck(this, VictoryStack);
-
-    _this = _possibleConstructorReturn(this, (VictoryStack.__proto__ || Object.getPrototypeOf(VictoryStack)).call(this, props));
-
-    if (props.animate) {
-      _this.state = {
-        nodesShouldLoad: false,
-        nodesDoneLoad: false,
-        animating: true
-      };
-      _this.setAnimationState = _victoryCore.Wrapper.setAnimationState.bind(_assertThisInitialized(_this));
-    }
-
-    return _this;
-  }
-
-  _createClass(VictoryStack, [{
-    key: "shouldComponentUpdate",
-    value: function shouldComponentUpdate(nextProps) {
-      if (this.props.animate) {
-        if (!(0, _reactFastCompare.default)(this.props, nextProps)) {
-          this.setAnimationState(this.props, nextProps);
-          return false;
-        }
-      }
-
-      return true;
-    }
-  }, {
-    key: "getNewChildren",
-    value: function getNewChildren(props, childComponents, calculatedProps) {
-      var children = (0, _helperMethods.getChildren)(props, childComponents, calculatedProps);
-
-      var getAnimationProps = _victoryCore.Wrapper.getAnimationProps.bind(this);
-
-      var newChildren = children.map(function (child, index) {
-        var childProps = (0, _assign2.default)({
-          animate: getAnimationProps(props, child, index)
-        }, child.props);
-        return _react.default.cloneElement(child, childProps);
-      });
-      /*
-        reverse render order for children of `VictoryStack` so that higher children in the stack
-        are rendered behind lower children. This looks nicer for stacked bars with cornerRadius, and
-        areas with strokes
-      */
-
-      return newChildren.reverse();
-    }
-  }, {
-    key: "renderContainer",
-    value: function renderContainer(containerComponent, props) {
-      var containerProps = (0, _defaults2.default)({}, containerComponent.props, props);
-      return _react.default.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 VictoryStack = function (initialProps) {
+  // eslint-disable-next-line no-use-before-define
+  var role = VictoryStackMemo.role;
+
+  var _Hooks$useAnimationSt = _victoryCore.Hooks.useAnimationState(),
+      setAnimationState = _Hooks$useAnimationSt.setAnimationState,
+      getAnimationProps = _Hooks$useAnimationSt.getAnimationProps,
+      getProps = _Hooks$useAnimationSt.getProps;
+
+  var props = getProps(initialProps);
+
+  var modifiedProps = _victoryCore.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.default.Children.toArray(modifiedProps.children);
+
+  var calculatedProps = (0, _helperMethods.useMemoizedProps)(modifiedProps);
+  var domain = calculatedProps.domain,
+      scale = calculatedProps.scale,
+      style = calculatedProps.style,
+      origin = calculatedProps.origin;
+
+  var newChildren = _react.default.useMemo(function () {
+    var children = (0, _helperMethods.getChildren)(props, childComponents, calculatedProps);
+    var orderedChildren = children.map(function (child, index) {
+      var childProps = (0, _assign2.default)({
+        animate: getAnimationProps(props, child, index, "victory-stack")
+      }, child.props);
+      return _react.default.cloneElement(child, childProps);
+    });
+    /*
+      reverse render order for children of `VictoryStack` so that higher children in the stack
+      are rendered behind lower children. This looks nicer for stacked bars with cornerRadius, and
+      areas with strokes
+    */
+
+    return orderedChildren.reverse();
+  }, [props, childComponents, calculatedProps, getAnimationProps]);
+
+  var containerProps = _react.default.useMemo(function () {
+    if (standalone) {
       return {
         domain: domain,
         scale: scale,
@@ -138,103 +101,78 @@ 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 = _victoryCore.Helpers.modifyProps(props, fallbackProps, role);
-
-      var eventKey = modifiedProps.eventKey,
-          containerComponent = modifiedProps.containerComponent,
-          standalone = modifiedProps.standalone,
-          groupComponent = modifiedProps.groupComponent,
-          externalEventMutations = modifiedProps.externalEventMutations;
-
-      var childComponents = _react.default.Children.toArray(modifiedProps.children);
-
-      var calculatedProps = (0, _helperMethods.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 = _victoryCore.Wrapper.getAllEvents(props);
-
-      if (!(0, _isEmpty2.default)(events)) {
-        return _react.default.createElement(_victorySharedEvents.VictorySharedEvents, {
-          container: container,
-          eventKey: eventKey,
-          events: events,
-          externalEventMutations: externalEventMutations
-        }, newChildren);
-      }
 
-      return _react.default.cloneElement(container, container.props, newChildren);
+    return {};
+  }, [standalone, domain, scale, width, height, theme, style, horizontal, polar, origin, name]);
+
+  var container = _react.default.useMemo(function () {
+    if (standalone) {
+      var defaultContainerProps = (0, _defaults2.default)({}, containerComponent.props, containerProps);
+      return _react.default.cloneElement(containerComponent, defaultContainerProps);
     }
-  }]);
 
-  return VictoryStack;
-}(_react.default.Component);
+    return groupComponent;
+  }, [groupComponent, standalone, containerComponent, containerProps]);
 
-exports.default = VictoryStack;
-Object.defineProperty(VictoryStack, "displayName", {
-  configurable: true,
-  enumerable: true,
-  writable: true,
-  value: "VictoryStack"
-});
-Object.defineProperty(VictoryStack, "role", {
-  configurable: true,
-  enumerable: true,
-  writable: true,
-  value: "stack"
-});
-Object.defineProperty(VictoryStack, "propTypes", {
-  configurable: true,
-  enumerable: true,
-  writable: true,
-  value: _objectSpread({}, _victoryCore.CommonProps.baseProps, {
-    bins: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.oneOfType([_victoryCore.PropTypes.nonNegative, _propTypes.default.instanceOf(Date)])), _victoryCore.PropTypes.nonNegative]),
-    categories: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.string), _propTypes.default.shape({
-      x: _propTypes.default.arrayOf(_propTypes.default.string),
-      y: _propTypes.default.arrayOf(_propTypes.default.string)
-    })]),
-    children: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.node), _propTypes.default.node]),
-    colorScale: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.string), _propTypes.default.oneOf(["grayscale", "qualitative", "heatmap", "warm", "cool", "red", "green", "blue"])]),
-    fillInMissingData: _propTypes.default.bool,
-    horizontal: _propTypes.default.bool,
-    labelComponent: _propTypes.default.element,
-    labels: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.array]),
-    style: _propTypes.default.shape({
-      parent: _propTypes.default.object,
-      data: _propTypes.default.object,
-      labels: _propTypes.default.object
-    }),
-    xOffset: _propTypes.default.number
-  })
-});
-Object.defineProperty(VictoryStack, "defaultProps", {
-  configurable: true,
-  enumerable: true,
-  writable: true,
-  value: {
-    containerComponent: _react.default.createElement(_victoryCore.VictoryContainer, null),
-    groupComponent: _react.default.createElement("g", null),
-    standalone: true,
-    theme: _victoryCore.VictoryTheme.grayscale,
-    fillInMissingData: true
+  var events = _react.default.useMemo(function () {
+    return _victoryCore.Wrapper.getAllEvents(props);
+  }, [props]);
+
+  var previousProps = _victoryCore.Hooks.usePreviousProps(initialProps);
+
+  _react.default.useEffect(function () {
+    // This is called before dismount to keep state in sync
+    return function () {
+      if (initialProps.animate) {
+        setAnimationState(previousProps, initialProps);
+      }
+    };
+  }, [setAnimationState, previousProps, initialProps]);
+
+  if (!(0, _isEmpty2.default)(events)) {
+    return _react.default.createElement(_victorySharedEvents.VictorySharedEvents, {
+      container: container,
+      eventKey: eventKey,
+      events: events,
+      externalEventMutations: externalEventMutations
+    }, newChildren);
   }
+
+  return _react.default.cloneElement(container, container.props, newChildren);
+};
+
+VictoryStack.propTypes = _objectSpread({}, _victoryCore.CommonProps.baseProps, {
+  bins: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.oneOfType([_victoryCore.PropTypes.nonNegative, _propTypes.default.instanceOf(Date)])), _victoryCore.PropTypes.nonNegative]),
+  categories: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.string), _propTypes.default.shape({
+    x: _propTypes.default.arrayOf(_propTypes.default.string),
+    y: _propTypes.default.arrayOf(_propTypes.default.string)
+  })]),
+  children: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.node), _propTypes.default.node]),
+  colorScale: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.string), _propTypes.default.oneOf(["grayscale", "qualitative", "heatmap", "warm", "cool", "red", "green", "blue"])]),
+  fillInMissingData: _propTypes.default.bool,
+  horizontal: _propTypes.default.bool,
+  labelComponent: _propTypes.default.element,
+  labels: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.array]),
+  style: _propTypes.default.shape({
+    parent: _propTypes.default.object,
+    data: _propTypes.default.object,
+    labels: _propTypes.default.object
+  }),
+  xOffset: _propTypes.default.number
 });
-Object.defineProperty(VictoryStack, "expectedComponents", {
-  configurable: true,
-  enumerable: true,
-  writable: true,
-  value: ["groupComponent", "containerComponent", "labelComponent"]
-});
-Object.defineProperty(VictoryStack, "getChildren", {
-  configurable: true,
-  enumerable: true,
-  writable: true,
-  value: _helperMethods.getChildren
-});
+VictoryStack.defaultProps = {
+  containerComponent: _react.default.createElement(_victoryCore.VictoryContainer, null),
+  groupComponent: _react.default.createElement("g", null),
+  standalone: true,
+  theme: _victoryCore.VictoryTheme.grayscale,
+  fillInMissingData: true
+};
+
+var VictoryStackMemo = _react.default.memo(VictoryStack, _reactFastCompare.default);
+
+VictoryStackMemo.displayName = "VictoryStack";
+VictoryStackMemo.role = "stack";
+VictoryStackMemo.expectedComponents = ["groupComponent", "containerComponent", "labelComponent"];
+VictoryStackMemo.getChildren = _helperMethods.getChildren;
+var _default = VictoryStackMemo;
+exports.default = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "victory-stack",
-  "version": "35.11.3",
+  "version": "36.2.0",
   "description": "Stack Layout Component for Victory",
   "keywords": [
     "data visualization",
@@ -22,8 +22,8 @@
     "lodash": "^4.17.19",
     "prop-types": "^15.5.8",
     "react-fast-compare": "^2.0.0",
-    "victory-core": "^35.11.3",
-    "victory-shared-events": "^35.11.3"
+    "victory-core": "^36.2.0",
+    "victory-shared-events": "^36.2.0"
   },
   "peerDependencies": {
     "react": "^16.6.0 || ^17.0.0"
@@ -32,5 +32,5 @@
     "version": "yarn run nps build-libs && nps build-dists"
   },
   "sideEffects": false,
-  "gitHead": "a66afca796bc341b06f028531355044cef7c5157"
+  "gitHead": "00c362fcd3e8f3880e14d3ba42873c34dd69c577"
 }

package/src/helper-methods.js

@@ -3,6 +3,7 @@
 import { assign, keys, orderBy } from "lodash";
 import React from "react";
 import { Helpers, Scale, Wrapper } from "victory-core";
+import isEqual from "react-fast-compare";
 
 const fallbackProps = {
   width: 450,
@@ -160,6 +161,37 @@ export function getCalculatedProps(props, childComponents) {
   };
 }
 
+// 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
+const withoutSharedEvents = (props) => {
+  const { children } = props;
+  const modifiedChildren = React.Children.toArray(children).map((child) => {
+    return {
+      ...child,
+      props: Helpers.omit(child.props, ["sharedEvents"])
+    };
+  });
+  props.children = modifiedChildren;
+  return props;
+};
+
+export function useMemoizedProps(initialProps) {
+  const modifiedProps = withoutSharedEvents(initialProps);
+  const [props, setProps] = React.useState(modifiedProps);
+
+  // React.memo uses shallow equality to compare objects. This way props
+  // will only be re-calculated when they change.
+  React.useEffect(() => {
+    if (!isEqual(modifiedProps, props)) {
+      setProps(modifiedProps);
+    }
+  }, [props, setProps, modifiedProps]);
+
+  return React.useMemo(() => {
+    return getCalculatedProps(props, props.children);
+  }, [props]);
+}
+
 function getLabels(props, datasets, index) {
   if (!props.labels) {
     return undefined;