Add animation for ErrorBar

src/cartesian/ErrorBar.tsx

@@ -3,10 +3,11 @@
  */
 import React, { SVGProps } from 'react';
 import invariant from 'tiny-invariant';
+import Animate from 'react-smooth';
 import { Layer } from '../container/Layer';
 import { Props as XAxisProps } from './XAxis';
 import { Props as YAxisProps } from './YAxis';
-import { D3Scale, DataKey } from '../util/types';
+import { AnimationTiming, D3Scale, DataKey } from '../util/types';
 import { filterProps } from '../util/ReactUtils';
 import { BarRectangleItem } from './Bar';
 import { LinePointItem } from './Line';
@@ -43,12 +44,30 @@ interface ErrorBarProps extends InternalErrorBarProps {
    * Only accepts a value of "x" or "y" and makes the error bars lie in that direction.
    */
   direction?: 'x' | 'y';
+  isAnimationActive?: boolean;
+  animationBegin?: number;
+  animationDuration?: number;
+  animationEasing?: AnimationTiming;
 }
 
 export type Props = SVGProps<SVGLineElement> & ErrorBarProps;
 
 export function ErrorBar(props: Props) {
-  const { offset, layout, width, dataKey, data, dataPointFormatter, xAxis, yAxis, ...others } = props;
+  const {
+    offset,
+    layout,
+    width,
+    dataKey,
+    data,
+    dataPointFormatter,
+    xAxis,
+    yAxis,
+    isAnimationActive,
+    animationBegin,
+    animationDuration,
+    animationEasing,
+    ...others
+  } = props;
   const svgProps = filterProps(others, false);
 
   invariant(
@@ -114,9 +133,23 @@ export function ErrorBar(props: Props) {
         key={`bar-${lineCoordinates.map(c => `${c.x1}-${c.x2}-${c.y1}-${c.y2}`)}`}
         {...svgProps}
       >
-        {lineCoordinates.map(coordinates => (
-          <line {...coordinates} key={`line-${coordinates.x1}-${coordinates.x2}-${coordinates.y1}-${coordinates.y2}`} />
-        ))}
+        {lineCoordinates.map(coordinates => {
+          const lineStyle = isAnimationActive ? { transformOrigin: `${coordinates.x1 - 5}px` } : undefined;
+          return (
+            <Animate
+              from="scale(0, 1)"
+              to="scale(1, 1)"
+              attributeName="transform"
+              begin={animationBegin}
+              easing={animationEasing}
+              isActive={isAnimationActive}
+              duration={animationDuration}
+              key={`line-${coordinates.x1}-${coordinates.x2}-${coordinates.y1}-${coordinates.y2}`}
+            >
+              <line {...coordinates} style={lineStyle} />
+            </Animate>
+          );
+        })}
       </Layer>
     );
   });
@@ -130,5 +163,9 @@ ErrorBar.defaultProps = {
   width: 5,
   offset: 0,
   layout: 'horizontal',
+  isAnimationActive: true,
+  animationBegin: 0,
+  animationDuration: 200,
+  animationEasing: 'ease-in-out',
 };
 ErrorBar.displayName = 'ErrorBar';

test/cartesian/ErrorBar.spec.tsx

@@ -1,6 +1,8 @@
 import React from 'react';
 import { render } from '@testing-library/react';
 import { Bar, BarChart, Line, LineChart, ErrorBar, XAxis, YAxis } from '../../src';
+import '@testing-library/jest-dom';
+import { mockAnimation, cleanupMockAnimation } from '../helper/animation-frame-helper';
 
 // asserts an error bar has both a start and end position
 const assertErrorBars = (container: HTMLElement, barsExpected: number) => {
@@ -20,6 +22,27 @@ const assertErrorBars = (container: HTMLElement, barsExpected: number) => {
   });
 };
 
+function assertAnimationStyles(
+  container: HTMLElement,
+  animation: boolean = true,
+  expectedStyles: { [key: string]: string } = {},
+) {
+  const errorBars = container.querySelectorAll('.recharts-errorBar');
+  errorBars.forEach(bar => {
+    const lineElements = bar.querySelectorAll('line');
+    lineElements.forEach(line => {
+      if (animation) {
+        const style = line.getAttribute('style');
+        Object.entries(expectedStyles).forEach(([key, value]) => {
+          expect(style).toContain(`${key}: ${value}`);
+        });
+      } else {
+        expect(line.getAttribute('style')).toBeNull();
+      }
+    });
+  });
+}
+
 describe('<ErrorBar />', () => {
   const barData = [
     { name: 'food', uv: 2000, pv: 2013, time: 1, uvError: [100, 50], pvError: [110, 20] },
@@ -103,4 +126,94 @@ describe('<ErrorBar />', () => {
 
     expect(container.querySelectorAll('.recharts-errorBar')).toHaveLength(10);
   });
+
+  test('Renders Error Bars with animation', async () => {
+    mockAnimation();
+
+    const { container } = render(
+      <BarChart data={barData} width={500} height={500}>
+        <Bar isAnimationActive={false} dataKey="uv">
+          <ErrorBar isAnimationActive dataKey="uvError" />
+        </Bar>
+      </BarChart>,
+    );
+
+    assertErrorBars(container, 4);
+    assertAnimationStyles(container, true, { transition: 'transform 200ms ease-in-out' });
+
+    cleanupMockAnimation();
+  });
+
+  test('Renders Error Bars without animation', () => {
+    mockAnimation();
+
+    const { container } = render(
+      <BarChart data={barData} width={500} height={500}>
+        <Bar isAnimationActive={false} dataKey="uv">
+          <ErrorBar isAnimationActive={false} dataKey="uvError" />
+        </Bar>
+      </BarChart>,
+    );
+
+    assertErrorBars(container, 4);
+    assertAnimationStyles(container, false);
+
+    cleanupMockAnimation();
+  });
+
+  test('Renders Error Bars with animation delay', () => {
+    mockAnimation();
+
+    const { container } = render(
+      <BarChart data={barData} width={500} height={500}>
+        <Bar isAnimationActive={false} dataKey="uv">
+          <ErrorBar isAnimationActive begin={200} dataKey="uvError" />
+        </Bar>
+      </BarChart>,
+    );
+
+    assertErrorBars(container, 4);
+    assertAnimationStyles(container, true, { transition: 'transform 200ms ease-in-out' });
+
+    const errorBars = container.querySelectorAll('.recharts-errorBar');
+    errorBars.forEach(bar => {
+      expect(bar.getAttribute('begin')).toBe('200');
+    });
+
+    cleanupMockAnimation();
+  });
+
+  test('Renders Error Bars with animation duration', () => {
+    mockAnimation();
+
+    const { container } = render(
+      <BarChart data={barData} width={500} height={500}>
+        <Bar isAnimationActive={false} dataKey="uv">
+          <ErrorBar isAnimationActive animationDuration={400} dataKey="uvError" />
+        </Bar>
+      </BarChart>,
+    );
+
+    assertErrorBars(container, 4);
+    assertAnimationStyles(container, true, { transition: 'transform 400ms ease-in-out' });
+
+    cleanupMockAnimation();
+  });
+
+  test('Renders Error Bars with animation easing', () => {
+    mockAnimation();
+
+    const { container } = render(
+      <BarChart data={barData} width={500} height={500}>
+        <Bar isAnimationActive={false} dataKey="uv">
+          <ErrorBar isAnimationActive animationEasing="linear" dataKey="uvError" />
+        </Bar>
+      </BarChart>,
+    );
+
+    assertErrorBars(container, 4);
+    assertAnimationStyles(container, true, { transition: 'transform 200ms linear' });
+
+    cleanupMockAnimation();
+  });
 });