victory-stack 35.11.2 → 36.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "victory-stack",
-  "version": "35.11.2",
+  "version": "36.1.0",
   "description": "Stack Layout Component for Victory",
   "keywords": [
     "data visualization",
@@ -22,14 +22,15 @@
     "lodash": "^4.17.19",
     "prop-types": "^15.5.8",
     "react-fast-compare": "^2.0.0",
-    "victory-core": "^35.11.2",
-    "victory-shared-events": "^35.11.2"
+    "victory-core": "^36.1.0",
+    "victory-shared-events": "^36.1.0"
   },
   "peerDependencies": {
     "react": "^16.6.0 || ^17.0.0"
   },
   "scripts": {
-    "version": "nps build-libs && nps build-dists"
+    "version": "yarn run nps build-libs && nps build-dists"
   },
-  "sideEffects": false
+  "sideEffects": false,
+  "gitHead": "038cd9b70d9ce54ac6b861014165583760734c99"
 }

package/src/victory-stack.js

@@ -7,7 +7,9 @@ import {
   VictoryTheme,
   CommonProps,
   Wrapper,
-  PropTypes as CustomPropTypes
+  PropTypes as CustomPropTypes,
+  useAnimationState,
+  usePreviousProps
 } from "victory-core";
 import { VictorySharedEvents } from "victory-shared-events";
 import { getChildren, getCalculatedProps } from "./helper-methods";
@@ -19,102 +21,38 @@ const fallbackProps = {
   padding: 50
 };
 
-export default class VictoryStack extends React.Component {
-  static displayName = "VictoryStack";
-
-  static role = "stack";
-
-  static propTypes = {
-    ...CommonProps.baseProps,
-    bins: PropTypes.oneOfType([
-      PropTypes.arrayOf(
-        PropTypes.oneOfType([
-          CustomPropTypes.nonNegative,
-          PropTypes.instanceOf(Date)
-        ])
-      ),
-      CustomPropTypes.nonNegative
-    ]),
-    categories: PropTypes.oneOfType([
-      PropTypes.arrayOf(PropTypes.string),
-      PropTypes.shape({
-        x: PropTypes.arrayOf(PropTypes.string),
-        y: PropTypes.arrayOf(PropTypes.string)
-      })
-    ]),
-    children: PropTypes.oneOfType([
-      PropTypes.arrayOf(PropTypes.node),
-      PropTypes.node
-    ]),
-    colorScale: PropTypes.oneOfType([
-      PropTypes.arrayOf(PropTypes.string),
-      PropTypes.oneOf([
-        "grayscale",
-        "qualitative",
-        "heatmap",
-        "warm",
-        "cool",
-        "red",
-        "green",
-        "blue"
-      ])
-    ]),
-    fillInMissingData: PropTypes.bool,
-    horizontal: PropTypes.bool,
-    labelComponent: PropTypes.element,
-    labels: PropTypes.oneOfType([PropTypes.func, PropTypes.array]),
-    style: PropTypes.shape({
-      parent: PropTypes.object,
-      data: PropTypes.object,
-      labels: PropTypes.object
-    }),
-    xOffset: PropTypes.number
-  };
-
-  static defaultProps = {
-    containerComponent: <VictoryContainer />,
-    groupComponent: <g />,
-    standalone: true,
-    theme: VictoryTheme.grayscale,
-    fillInMissingData: true
-  };
-
-  static expectedComponents = [
-    "groupComponent",
-    "containerComponent",
-    "labelComponent"
-  ];
-
-  static getChildren = getChildren;
-
-  constructor(props) {
-    super(props);
-    if (props.animate) {
-      this.state = {
-        nodesShouldLoad: false,
-        nodesDoneLoad: false,
-        animating: true
-      };
-      this.setAnimationState = Wrapper.setAnimationState.bind(this);
-    }
-  }
+const VictoryStack = (initialProps) => {
+  // eslint-disable-next-line no-use-before-define
+  const { role } = VictoryStackMemo;
+  const { setAnimationState, getAnimationProps, getProps } =
+    useAnimationState();
 
-  shouldComponentUpdate(nextProps) {
-    if (this.props.animate) {
-      if (!isEqual(this.props, nextProps)) {
-        this.setAnimationState(this.props, nextProps);
-        return false;
-      }
-    }
-    return true;
-  }
+  const props = getProps(initialProps);
+
+  const modifiedProps = Helpers.modifyProps(props, fallbackProps, role);
+  const {
+    eventKey,
+    containerComponent,
+    standalone,
+    groupComponent,
+    externalEventMutations,
+    width,
+    height,
+    theme,
+    polar,
+    horizontal,
+    name
+  } = modifiedProps;
+
+  const childComponents = React.Children.toArray(modifiedProps.children);
+  const calculatedProps = getCalculatedProps(modifiedProps, childComponents);
+  const { domain, scale, style, origin } = calculatedProps;
 
-  getNewChildren(props, childComponents, calculatedProps) {
+  const newChildren = React.useMemo(() => {
     const children = getChildren(props, childComponents, calculatedProps);
-    const getAnimationProps = Wrapper.getAnimationProps.bind(this);
-    const newChildren = children.map((child, index) => {
+    const orderedChildren = children.map((child, index) => {
       const childProps = assign(
-        { animate: getAnimationProps(props, child, index) },
+        { animate: getAnimationProps(props, child, index, "victory-stack") },
         child.props
       );
       return React.cloneElement(child, childProps);
@@ -124,73 +62,149 @@ export default class VictoryStack extends React.Component {
       are rendered behind lower children. This looks nicer for stacked bars with cornerRadius, and
       areas with strokes
     */
-    return newChildren.reverse();
-  }
-
-  renderContainer(containerComponent, props) {
-    const containerProps = defaults({}, containerComponent.props, props);
-    return React.cloneElement(containerComponent, containerProps);
-  }
+    return orderedChildren.reverse();
+  }, [props, childComponents, calculatedProps, getAnimationProps]);
 
-  getContainerProps(props, calculatedProps) {
-    const { width, height, standalone, theme, polar, horizontal, name } = props;
-    const { domain, scale, style, origin } = calculatedProps;
-    return {
-      domain,
-      scale,
-      width,
-      height,
-      standalone,
-      theme,
-      style: style.parent,
-      horizontal,
-      polar,
-      origin,
-      name
-    };
-  }
+  const containerProps = React.useMemo(() => {
+    if (standalone) {
+      return {
+        domain,
+        scale,
+        width,
+        height,
+        standalone,
+        theme,
+        style: style.parent,
+        horizontal,
+        polar,
+        origin,
+        name
+      };
+    }
+    return {};
+  }, [
+    standalone,
+    domain,
+    scale,
+    width,
+    height,
+    theme,
+    style,
+    horizontal,
+    polar,
+    origin,
+    name
+  ]);
 
-  render() {
-    const { role } = this.constructor;
-    const props =
-      this.state && this.state.nodesWillExit
-        ? this.state.oldProps || this.props
-        : this.props;
-    const modifiedProps = Helpers.modifyProps(props, fallbackProps, role);
-    const {
-      eventKey,
-      containerComponent,
-      standalone,
-      groupComponent,
-      externalEventMutations
-    } = modifiedProps;
-    const childComponents = React.Children.toArray(modifiedProps.children);
-    const calculatedProps = getCalculatedProps(modifiedProps, childComponents);
-    const newChildren = this.getNewChildren(
-      modifiedProps,
-      childComponents,
-      calculatedProps
-    );
-    const containerProps = standalone
-      ? this.getContainerProps(modifiedProps, calculatedProps)
-      : {};
-    const container = standalone
-      ? this.renderContainer(containerComponent, containerProps)
-      : groupComponent;
-    const events = Wrapper.getAllEvents(props);
-    if (!isEmpty(events)) {
-      return (
-        <VictorySharedEvents
-          container={container}
-          eventKey={eventKey}
-          events={events}
-          externalEventMutations={externalEventMutations}
-        >
-          {newChildren}
-        </VictorySharedEvents>
+  const container = React.useMemo(() => {
+    if (standalone) {
+      const defaultContainerProps = defaults(
+        {},
+        containerComponent.props,
+        containerProps
       );
+      return React.cloneElement(containerComponent, defaultContainerProps);
     }
+    return groupComponent;
+  }, [groupComponent, standalone, containerComponent, containerProps]);
+
+  const events = React.useMemo(() => {
+    return Wrapper.getAllEvents(props);
+  }, [props]);
 
-    return React.cloneElement(container, container.props, newChildren);
+  const previousProps = usePreviousProps(initialProps);
+
+  React.useEffect(() => {
+    // This is called before dismount to keep state in sync
+    return () => {
+      if (initialProps.animate) {
+        setAnimationState(previousProps, initialProps);
+      }
+    };
+  }, [setAnimationState, previousProps, initialProps]);
+
+  if (!isEmpty(events)) {
+    return (
+      <VictorySharedEvents
+        container={container}
+        eventKey={eventKey}
+        events={events}
+        externalEventMutations={externalEventMutations}
+      >
+        {newChildren}
+      </VictorySharedEvents>
+    );
   }
-}
+
+  return React.cloneElement(container, container.props, newChildren);
+};
+
+VictoryStack.propTypes = {
+  ...CommonProps.baseProps,
+  bins: PropTypes.oneOfType([
+    PropTypes.arrayOf(
+      PropTypes.oneOfType([
+        CustomPropTypes.nonNegative,
+        PropTypes.instanceOf(Date)
+      ])
+    ),
+    CustomPropTypes.nonNegative
+  ]),
+  categories: PropTypes.oneOfType([
+    PropTypes.arrayOf(PropTypes.string),
+    PropTypes.shape({
+      x: PropTypes.arrayOf(PropTypes.string),
+      y: PropTypes.arrayOf(PropTypes.string)
+    })
+  ]),
+  children: PropTypes.oneOfType([
+    PropTypes.arrayOf(PropTypes.node),
+    PropTypes.node
+  ]),
+  colorScale: PropTypes.oneOfType([
+    PropTypes.arrayOf(PropTypes.string),
+    PropTypes.oneOf([
+      "grayscale",
+      "qualitative",
+      "heatmap",
+      "warm",
+      "cool",
+      "red",
+      "green",
+      "blue"
+    ])
+  ]),
+  fillInMissingData: PropTypes.bool,
+  horizontal: PropTypes.bool,
+  labelComponent: PropTypes.element,
+  labels: PropTypes.oneOfType([PropTypes.func, PropTypes.array]),
+  style: PropTypes.shape({
+    parent: PropTypes.object,
+    data: PropTypes.object,
+    labels: PropTypes.object
+  }),
+  xOffset: PropTypes.number
+};
+
+VictoryStack.defaultProps = {
+  containerComponent: <VictoryContainer />,
+  groupComponent: <g />,
+  standalone: true,
+  theme: VictoryTheme.grayscale,
+  fillInMissingData: true
+};
+
+const VictoryStackMemo = React.memo(VictoryStack, isEqual);
+
+VictoryStackMemo.displayName = "VictoryStack";
+VictoryStackMemo.role = "stack";
+
+VictoryStackMemo.expectedComponents = [
+  "groupComponent",
+  "containerComponent",
+  "labelComponent"
+];
+
+VictoryStackMemo.getChildren = getChildren;
+
+export default VictoryStackMemo;