@mui/x-charts 7.20.0 → 7.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. package/BarChart/BarChart.js +1 -1
  2. package/BarChart/BarPlot.d.ts +1 -1
  3. package/BarChart/BarPlot.js +6 -3
  4. package/BarChart/useBarChartProps.js +2 -2
  5. package/CHANGELOG.md +120 -31
  6. package/ChartContainer/ChartContainer.d.ts +3 -2
  7. package/ChartContainer/ChartContainer.js +11 -2
  8. package/ChartContainer/useChartContainerProps.d.ts +2 -0
  9. package/ChartContainer/useChartContainerProps.js +7 -5
  10. package/LineChart/AreaPlot.js +3 -1
  11. package/LineChart/LinePlot.js +3 -1
  12. package/LineChart/MarkPlot.d.ts +1 -1
  13. package/LineChart/MarkPlot.js +10 -8
  14. package/LineChart/useLineChartProps.d.ts +10 -10
  15. package/LineChart/useLineChartProps.js +4 -5
  16. package/PieChart/PieChart.js +3 -3
  17. package/PieChart/PiePlot.js +3 -1
  18. package/ResponsiveChartContainer/ResponsiveChartContainer.js +5 -0
  19. package/ResponsiveChartContainer/useResponsiveChartContainerProps.d.ts +1 -1
  20. package/ResponsiveChartContainer/useResponsiveChartContainerProps.js +4 -2
  21. package/ScatterChart/ScatterChart.js +5 -0
  22. package/ScatterChart/extremums.js +4 -4
  23. package/ScatterChart/formatter.js +22 -3
  24. package/SparkLineChart/SparkLineChart.js +5 -0
  25. package/context/AnimationProvider/Animation.types.d.ts +15 -0
  26. package/context/AnimationProvider/Animation.types.js +1 -0
  27. package/context/AnimationProvider/AnimationContext.d.ts +4 -0
  28. package/context/AnimationProvider/AnimationContext.js +10 -0
  29. package/context/AnimationProvider/AnimationProvider.d.ts +4 -0
  30. package/context/AnimationProvider/AnimationProvider.js +55 -0
  31. package/context/AnimationProvider/index.d.ts +4 -0
  32. package/context/AnimationProvider/index.js +4 -0
  33. package/context/AnimationProvider/useSkipAnimation.d.ts +6 -0
  34. package/context/AnimationProvider/useSkipAnimation.js +20 -0
  35. package/index.js +1 -1
  36. package/internals/defaultizeColor.d.ts +7 -1
  37. package/internals/index.d.ts +1 -1
  38. package/internals/index.js +1 -1
  39. package/models/seriesType/scatter.d.ts +25 -1
  40. package/modern/BarChart/BarChart.js +1 -1
  41. package/modern/BarChart/BarPlot.js +6 -3
  42. package/modern/BarChart/useBarChartProps.js +2 -2
  43. package/modern/ChartContainer/ChartContainer.js +11 -2
  44. package/modern/ChartContainer/useChartContainerProps.js +7 -5
  45. package/modern/LineChart/AreaPlot.js +3 -1
  46. package/modern/LineChart/LinePlot.js +3 -1
  47. package/modern/LineChart/MarkPlot.js +10 -8
  48. package/modern/LineChart/useLineChartProps.js +4 -5
  49. package/modern/PieChart/PieChart.js +3 -3
  50. package/modern/PieChart/PiePlot.js +3 -1
  51. package/modern/ResponsiveChartContainer/ResponsiveChartContainer.js +5 -0
  52. package/modern/ResponsiveChartContainer/useResponsiveChartContainerProps.js +4 -2
  53. package/modern/ScatterChart/ScatterChart.js +5 -0
  54. package/modern/ScatterChart/extremums.js +4 -4
  55. package/modern/ScatterChart/formatter.js +22 -3
  56. package/modern/SparkLineChart/SparkLineChart.js +5 -0
  57. package/modern/context/AnimationProvider/Animation.types.js +1 -0
  58. package/modern/context/AnimationProvider/AnimationContext.js +10 -0
  59. package/modern/context/AnimationProvider/AnimationProvider.js +55 -0
  60. package/modern/context/AnimationProvider/index.js +4 -0
  61. package/modern/context/AnimationProvider/useSkipAnimation.js +20 -0
  62. package/modern/index.js +1 -1
  63. package/modern/internals/index.js +1 -1
  64. package/node/BarChart/BarChart.js +1 -1
  65. package/node/BarChart/BarPlot.js +4 -2
  66. package/node/BarChart/useBarChartProps.js +2 -2
  67. package/node/ChartContainer/ChartContainer.js +11 -2
  68. package/node/ChartContainer/useChartContainerProps.js +7 -5
  69. package/node/LineChart/AreaPlot.js +3 -1
  70. package/node/LineChart/LinePlot.js +3 -1
  71. package/node/LineChart/MarkPlot.js +10 -8
  72. package/node/LineChart/useLineChartProps.js +4 -5
  73. package/node/PieChart/PieChart.js +3 -3
  74. package/node/PieChart/PiePlot.js +3 -1
  75. package/node/ResponsiveChartContainer/ResponsiveChartContainer.js +5 -0
  76. package/node/ResponsiveChartContainer/useResponsiveChartContainerProps.js +4 -2
  77. package/node/ScatterChart/ScatterChart.js +5 -0
  78. package/node/ScatterChart/extremums.js +4 -4
  79. package/node/ScatterChart/formatter.js +23 -3
  80. package/node/SparkLineChart/SparkLineChart.js +5 -0
  81. package/node/context/AnimationProvider/Animation.types.js +5 -0
  82. package/node/context/AnimationProvider/AnimationContext.js +17 -0
  83. package/node/context/AnimationProvider/AnimationProvider.js +60 -0
  84. package/node/context/AnimationProvider/index.js +49 -0
  85. package/node/context/AnimationProvider/useSkipAnimation.js +25 -0
  86. package/node/index.js +1 -1
  87. package/node/internals/index.js +12 -8
  88. package/package.json +4 -4
  89. package/hooks/useReducedMotion.d.ts +0 -8
  90. package/hooks/useReducedMotion.js +0 -39
  91. package/modern/hooks/useReducedMotion.js +0 -39
  92. package/node/hooks/useReducedMotion.js +0 -45
@@ -1,17 +1,17 @@
1
- import type { LineChartProps } from './LineChart';
2
- import { ResponsiveChartContainerProps } from '../ResponsiveChartContainer';
3
- import { ChartsOnAxisClickHandlerProps } from '../ChartsOnAxisClickHandler';
4
- import { ChartsGridProps } from '../ChartsGrid';
5
- import { ChartsClipPathProps } from '../ChartsClipPath';
6
- import { AreaPlotProps } from './AreaPlot';
7
- import { LinePlotProps } from './LinePlot';
8
- import { MarkPlotProps } from './MarkPlot';
9
- import { ChartsOverlayProps } from '../ChartsOverlay';
10
1
  import { ChartsAxisProps } from '../ChartsAxis';
11
2
  import { ChartsAxisHighlightProps } from '../ChartsAxisHighlight';
12
- import { LineHighlightPlotProps } from './LineHighlightPlot';
3
+ import { ChartsClipPathProps } from '../ChartsClipPath';
4
+ import { ChartsGridProps } from '../ChartsGrid';
13
5
  import { ChartsLegendProps } from '../ChartsLegend';
6
+ import { ChartsOnAxisClickHandlerProps } from '../ChartsOnAxisClickHandler';
7
+ import { ChartsOverlayProps } from '../ChartsOverlay';
14
8
  import { ChartsTooltipProps } from '../ChartsTooltip';
9
+ import { ResponsiveChartContainerProps } from '../ResponsiveChartContainer';
10
+ import { AreaPlotProps } from './AreaPlot';
11
+ import type { LineChartProps } from './LineChart';
12
+ import { LineHighlightPlotProps } from './LineHighlightPlot';
13
+ import { LinePlotProps } from './LinePlot';
14
+ import { MarkPlotProps } from './MarkPlot';
15
15
  /**
16
16
  * A helper function that extracts LineChartProps from the input props
17
17
  * and returns an object with props for the children components of LineChart.
@@ -71,7 +71,8 @@ export const useLineChartProps = props => {
71
71
  highlightedItem,
72
72
  onHighlightChange,
73
73
  disableAxisListener: tooltip?.trigger !== 'axis' && axisHighlight?.x === 'none' && axisHighlight?.y === 'none' && !onAxisClick,
74
- className
74
+ className,
75
+ skipAnimation
75
76
  });
76
77
  const axisClickHandlerProps = {
77
78
  onAxisClick
@@ -89,14 +90,12 @@ export const useLineChartProps = props => {
89
90
  const areaPlotProps = {
90
91
  slots,
91
92
  slotProps,
92
- onItemClick: onAreaClick,
93
- skipAnimation
93
+ onItemClick: onAreaClick
94
94
  };
95
95
  const linePlotProps = {
96
96
  slots,
97
97
  slotProps,
98
- onItemClick: onLineClick,
99
- skipAnimation
98
+ onItemClick: onLineClick
100
99
  };
101
100
  const markPlotProps = {
102
101
  slots,
@@ -105,6 +105,7 @@ const PieChart = /*#__PURE__*/React.forwardRef(function PieChart(inProps, ref) {
105
105
  highlightedItem: highlightedItem,
106
106
  onHighlightChange: onHighlightChange,
107
107
  className: className,
108
+ skipAnimation: skipAnimation,
108
109
  children: [/*#__PURE__*/_jsx(ChartsAxis, {
109
110
  topAxis: topAxis,
110
111
  leftAxis: leftAxis,
@@ -115,8 +116,7 @@ const PieChart = /*#__PURE__*/React.forwardRef(function PieChart(inProps, ref) {
115
116
  }), /*#__PURE__*/_jsx(PiePlot, {
116
117
  slots: slots,
117
118
  slotProps: slotProps,
118
- onItemClick: onItemClick,
119
- skipAnimation: skipAnimation
119
+ onItemClick: onItemClick
120
120
  }), /*#__PURE__*/_jsx(ChartsOverlay, {
121
121
  loading: loading,
122
122
  slots: slots,
@@ -263,7 +263,7 @@ process.env.NODE_ENV !== "production" ? PieChart.propTypes = {
263
263
  series: PropTypes.arrayOf(PropTypes.object).isRequired,
264
264
  /**
265
265
  * If `true`, animations are skipped.
266
- * @default false
266
+ * If unset or `false`, the animations respects the user's `prefers-reduced-motion` setting.
267
267
  */
268
268
  skipAnimation: PropTypes.bool,
269
269
  /**
@@ -8,6 +8,7 @@ import { PieArcLabelPlot } from "./PieArcLabelPlot.js";
8
8
  import { getPercentageValue } from "../internals/getPercentageValue.js";
9
9
  import { getPieCoordinates } from "./getPieCoordinates.js";
10
10
  import { usePieSeries } from "../hooks/useSeries.js";
11
+ import { useSkipAnimation } from "../context/AnimationProvider/index.js";
11
12
  import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
12
13
  /**
13
14
  * Demos:
@@ -21,7 +22,7 @@ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
21
22
  */
22
23
  function PiePlot(props) {
23
24
  const {
24
- skipAnimation,
25
+ skipAnimation: inSkipAnimation,
25
26
  slots,
26
27
  slotProps,
27
28
  onItemClick
@@ -33,6 +34,7 @@ function PiePlot(props) {
33
34
  width,
34
35
  height
35
36
  } = React.useContext(DrawingContext);
37
+ const skipAnimation = useSkipAnimation(inSkipAnimation);
36
38
  if (seriesData === undefined) {
37
39
  return null;
38
40
  }
@@ -90,6 +90,11 @@ process.env.NODE_ENV !== "production" ? ResponsiveChartContainer.propTypes = {
90
90
  * Please refer to the appropriate docs page to learn more about it.
91
91
  */
92
92
  series: PropTypes.arrayOf(PropTypes.object).isRequired,
93
+ /**
94
+ * If `true`, animations are skipped.
95
+ * If unset or `false`, the animations respects the user's `prefers-reduced-motion` setting.
96
+ */
97
+ skipAnimation: PropTypes.bool,
93
98
  sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
94
99
  title: PropTypes.string,
95
100
  viewBox: PropTypes.shape({
@@ -1,7 +1,7 @@
1
1
  import type { ResponsiveChartContainerProps } from './ResponsiveChartContainer';
2
2
  export declare const useResponsiveChartContainerProps: (props: ResponsiveChartContainerProps, ref: React.ForwardedRef<unknown>) => {
3
3
  hasIntrinsicSize: number;
4
- chartContainerProps: Omit<import("..").ChartsSurfaceProps & Omit<import("../internals").SeriesProviderProps, "seriesFormatters"> & Omit<import("../internals").DrawingProviderProps, "svgRef"> & Pick<import("../internals").CartesianProviderProps, "dataset"> & import("..").ZAxisContextProviderProps & import("..").HighlightedProviderProps & import("../internals").PluginProviderProps, "children"> & {
4
+ chartContainerProps: Omit<import("..").ChartsSurfaceProps & Omit<import("../internals").SeriesProviderProps, "seriesFormatters"> & Omit<import("../internals").DrawingProviderProps, "svgRef"> & Pick<import("../internals").CartesianProviderProps, "dataset"> & import("..").ZAxisContextProviderProps & import("..").HighlightedProviderProps & import("../internals").PluginProviderProps & import("../internals").AnimationProviderProps, "children"> & {
5
5
  xAxis?: import("../internals").MakeOptional<import("..").AxisConfig<import("..").ScaleName, any, import("..").ChartsXAxisProps>, "id">[];
6
6
  yAxis?: import("../internals").MakeOptional<import("..").AxisConfig<import("..").ScaleName, any, import("..").ChartsYAxisProps>, "id">[];
7
7
  children?: React.ReactNode;
@@ -2,7 +2,7 @@
2
2
 
3
3
  import _extends from "@babel/runtime/helpers/esm/extends";
4
4
  import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
5
- const _excluded = ["width", "height", "resolveSizeBeforeRender", "margin", "children", "series", "colors", "dataset", "desc", "disableAxisListener", "highlightedItem", "onHighlightChange", "plugins", "sx", "title", "viewBox", "xAxis", "yAxis", "zAxis"];
5
+ const _excluded = ["width", "height", "resolveSizeBeforeRender", "margin", "children", "series", "colors", "dataset", "desc", "disableAxisListener", "highlightedItem", "onHighlightChange", "plugins", "sx", "title", "viewBox", "xAxis", "yAxis", "zAxis", "skipAnimation"];
6
6
  import { useChartContainerDimensions } from "./useChartContainerDimensions.js";
7
7
  export const useResponsiveChartContainerProps = (props, ref) => {
8
8
  const {
@@ -24,7 +24,8 @@ export const useResponsiveChartContainerProps = (props, ref) => {
24
24
  viewBox,
25
25
  xAxis,
26
26
  yAxis,
27
- zAxis
27
+ zAxis,
28
+ skipAnimation
28
29
  } = props,
29
30
  other = _objectWithoutPropertiesLoose(props, _excluded);
30
31
  const {
@@ -56,6 +57,7 @@ export const useResponsiveChartContainerProps = (props, ref) => {
56
57
  xAxis,
57
58
  yAxis,
58
59
  zAxis,
60
+ skipAnimation,
59
61
  width: dWidth,
60
62
  height: dHeight,
61
63
  ref
@@ -198,6 +198,11 @@ process.env.NODE_ENV !== "production" ? ScatterChart.propTypes = {
198
198
  * An array of [[ScatterSeriesType]] objects.
199
199
  */
200
200
  series: PropTypes.arrayOf(PropTypes.object).isRequired,
201
+ /**
202
+ * If `true`, animations are skipped.
203
+ * If unset or `false`, the animations respects the user's `prefers-reduced-motion` setting.
204
+ */
205
+ skipAnimation: PropTypes.bool,
201
206
  /**
202
207
  * The props used for each component slot.
203
208
  * @default {}
@@ -18,13 +18,13 @@ export const getExtremumX = params => {
18
18
  seriesXAxisId: series[seriesId].xAxisId ?? series[seriesId].xAxisKey,
19
19
  seriesYAxisId: series[seriesId].yAxisId ?? series[seriesId].yAxisKey
20
20
  });
21
- const seriesMinMax = series[seriesId].data.reduce((accSeries, d, dataIndex) => {
21
+ const seriesMinMax = series[seriesId].data?.reduce((accSeries, d, dataIndex) => {
22
22
  if (filter && !filter(d, dataIndex)) {
23
23
  return accSeries;
24
24
  }
25
25
  return mergeMinMax(accSeries, [d.x, d.x]);
26
26
  }, [Infinity, -Infinity]);
27
- return mergeMinMax(acc, seriesMinMax);
27
+ return mergeMinMax(acc, seriesMinMax ?? [Infinity, -Infinity]);
28
28
  }, [Infinity, -Infinity]);
29
29
  };
30
30
  export const getExtremumY = params => {
@@ -44,12 +44,12 @@ export const getExtremumY = params => {
44
44
  seriesXAxisId: series[seriesId].xAxisId ?? series[seriesId].xAxisKey,
45
45
  seriesYAxisId: series[seriesId].yAxisId ?? series[seriesId].yAxisKey
46
46
  });
47
- const seriesMinMax = series[seriesId].data.reduce((accSeries, d, dataIndex) => {
47
+ const seriesMinMax = series[seriesId].data?.reduce((accSeries, d, dataIndex) => {
48
48
  if (filter && !filter(d, dataIndex)) {
49
49
  return accSeries;
50
50
  }
51
51
  return mergeMinMax(accSeries, [d.y, d.y]);
52
52
  }, [Infinity, -Infinity]);
53
- return mergeMinMax(acc, seriesMinMax);
53
+ return mergeMinMax(acc, seriesMinMax ?? [Infinity, -Infinity]);
54
54
  }, [Infinity, -Infinity]);
55
55
  };
@@ -1,10 +1,29 @@
1
- import { defaultizeValueFormatter } from "../internals/defaultizeValueFormatter.js";
1
+ import _extends from "@babel/runtime/helpers/esm/extends";
2
2
  const formatter = ({
3
3
  series,
4
4
  seriesOrder
5
- }) => {
5
+ }, dataset) => {
6
+ const completeSeries = Object.fromEntries(Object.entries(series).map(([seriesId, seriesData]) => {
7
+ const datasetKeys = seriesData?.datasetKeys;
8
+ const missingKeys = ['x', 'y', 'id'].filter(key => typeof datasetKeys?.[key] !== 'string');
9
+ if (seriesData?.datasetKeys && missingKeys.length > 0) {
10
+ throw new Error([`MUI X: scatter series with id='${seriesId}' has incomplete datasetKeys.`, `Properties ${missingKeys.map(key => `"${key}"`).join(', ')} are missing.`].join('\n'));
11
+ }
12
+ const data = !datasetKeys ? seriesData.data ?? [] : dataset?.map(d => {
13
+ return {
14
+ x: d[datasetKeys.x],
15
+ y: d[datasetKeys.y],
16
+ z: datasetKeys.z && d[datasetKeys.z],
17
+ id: d[datasetKeys.id]
18
+ };
19
+ }) ?? [];
20
+ return [seriesId, _extends({}, seriesData, {
21
+ data,
22
+ valueFormatter: seriesData.valueFormatter ?? (v => `(${v.x}, ${v.y})`)
23
+ })];
24
+ }));
6
25
  return {
7
- series: defaultizeValueFormatter(series, v => `(${v.x}, ${v.y})`),
26
+ series: completeSeries,
8
27
  seriesOrder
9
28
  };
10
29
  };
@@ -215,6 +215,11 @@ process.env.NODE_ENV !== "production" ? SparkLineChart.propTypes = {
215
215
  * @default false
216
216
  */
217
217
  showTooltip: PropTypes.bool,
218
+ /**
219
+ * If `true`, animations are skipped.
220
+ * If unset or `false`, the animations respects the user's `prefers-reduced-motion` setting.
221
+ */
222
+ skipAnimation: PropTypes.bool,
218
223
  /**
219
224
  * The props used for each component slot.
220
225
  * @default {}
@@ -0,0 +1,15 @@
1
+ export type AnimationProviderProps = {
2
+ /**
3
+ * If `true`, animations are skipped.
4
+ * If unset or `false`, the animations respects the user's `prefers-reduced-motion` setting.
5
+ */
6
+ skipAnimation?: boolean;
7
+ children: React.ReactNode;
8
+ };
9
+ export type AnimationState = {
10
+ /**
11
+ * If `true`, animations are skipped.
12
+ * @default undefined
13
+ */
14
+ skipAnimation?: boolean;
15
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,4 @@
1
+ import * as React from 'react';
2
+ import { Initializable } from '../context.types';
3
+ import { AnimationState } from './Animation.types';
4
+ export declare const AnimationContext: React.Context<Initializable<AnimationState>>;
@@ -0,0 +1,10 @@
1
+ import * as React from 'react';
2
+ export const AnimationContext = /*#__PURE__*/React.createContext({
3
+ isInitialized: false,
4
+ data: {
5
+ skipAnimation: undefined
6
+ }
7
+ });
8
+ if (process.env.NODE_ENV !== 'production') {
9
+ AnimationContext.displayName = 'AnimationContext';
10
+ }
@@ -0,0 +1,4 @@
1
+ import * as React from 'react';
2
+ import { AnimationProviderProps } from './Animation.types';
3
+ declare function AnimationProvider(props: AnimationProviderProps): React.JSX.Element;
4
+ export { AnimationProvider };
@@ -0,0 +1,55 @@
1
+ 'use client';
2
+
3
+ import { Globals, useIsomorphicLayoutEffect } from '@react-spring/web';
4
+ import * as React from 'react';
5
+ import { AnimationContext } from "./AnimationContext.js";
6
+ import { jsx as _jsx } from "react/jsx-runtime";
7
+ function AnimationProvider(props) {
8
+ // Part of the behavior was taken from:
9
+ // https://github.com/pmndrs/react-spring/blob/fd65b605b85c3a24143c4ce9dd322fdfca9c66be/packages/shared/src/hooks/useReducedMotion.ts
10
+ const {
11
+ children,
12
+ skipAnimation: inSkipAnimation
13
+ } = props;
14
+
15
+ // Skip animation test/jsdom
16
+ const isAnimationDisabledEnvironment = typeof window === 'undefined' || !window?.matchMedia;
17
+
18
+ // We use the value of `isAnimationDisabledEnvironment` as the initial value of `skipAnimation` to avoid
19
+ // re-rendering the component on environments where matchMedia is not supported, hence skipAnimation will always be true.
20
+ const [skipAnimation, setSkipAnimation] = React.useState(isAnimationDisabledEnvironment || undefined);
21
+ useIsomorphicLayoutEffect(() => {
22
+ if (isAnimationDisabledEnvironment) {
23
+ return undefined;
24
+ }
25
+ const handleMediaChange = event => {
26
+ // This hook can remove animation but never activate it.
27
+ const inputValue = event.matches || undefined;
28
+ setSkipAnimation(inputValue);
29
+ Globals.assign({
30
+ skipAnimation: inputValue
31
+ });
32
+ };
33
+ const mql = window.matchMedia('(prefers-reduced-motion)');
34
+ handleMediaChange(mql);
35
+
36
+ // MatchMedia is not fully supported in all environments, so we need to check if it exists before calling addEventListener
37
+ mql?.addEventListener?.('change', handleMediaChange);
38
+ return () => {
39
+ mql?.removeEventListener?.('change', handleMediaChange);
40
+ };
41
+ }, []);
42
+ const value = React.useMemo(() => ({
43
+ isInitialized: true,
44
+ data: {
45
+ // If dev sets `skipAnimation` to true, it will skip all animations.
46
+ // If dev sets `skipAnimation` to false, it will use user's preference.
47
+ skipAnimation: inSkipAnimation || skipAnimation
48
+ }
49
+ }), [skipAnimation, inSkipAnimation]);
50
+ return /*#__PURE__*/_jsx(AnimationContext.Provider, {
51
+ value: value,
52
+ children: children
53
+ });
54
+ }
55
+ export { AnimationProvider };
@@ -0,0 +1,4 @@
1
+ export * from './Animation.types';
2
+ export * from './AnimationContext';
3
+ export * from './AnimationProvider';
4
+ export * from './useSkipAnimation';
@@ -0,0 +1,4 @@
1
+ export * from "./Animation.types.js";
2
+ export * from "./AnimationContext.js";
3
+ export * from "./AnimationProvider.js";
4
+ export * from "./useSkipAnimation.js";
@@ -0,0 +1,6 @@
1
+ /**
2
+ * A hook to get if chart animations should be skipped.
3
+ *
4
+ * @returns {boolean|undefined} whether to skip animations
5
+ */
6
+ export declare function useSkipAnimation(skipAnimation?: boolean): boolean | undefined;
@@ -0,0 +1,20 @@
1
+ 'use client';
2
+
3
+ import * as React from 'react';
4
+ import { AnimationContext } from "./AnimationContext.js";
5
+
6
+ /**
7
+ * A hook to get if chart animations should be skipped.
8
+ *
9
+ * @returns {boolean|undefined} whether to skip animations
10
+ */
11
+ export function useSkipAnimation(skipAnimation) {
12
+ const {
13
+ isInitialized,
14
+ data
15
+ } = React.useContext(AnimationContext);
16
+ if (!isInitialized) {
17
+ throw new Error(['MUI X: Could not find the animation ref context.', 'It looks like you rendered your component outside of a ChartsContainer parent component.'].join('\n'));
18
+ }
19
+ return skipAnimation || data.skipAnimation;
20
+ }
package/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @mui/x-charts v7.20.0
2
+ * @mui/x-charts v7.21.0
3
3
  *
4
4
  * @license MIT
5
5
  * This source code is licensed under the MIT license found in the
@@ -62,12 +62,18 @@ export declare function defaultizeColor(series: AllSeriesType, seriesIndex: numb
62
62
  stackOrder?: import("..").StackOrderType;
63
63
  } | {
64
64
  type: "scatter";
65
- data: import("..").ScatterValueType[];
65
+ data?: import("..").ScatterValueType[];
66
66
  markerSize?: number;
67
67
  label?: string | ((location: "tooltip" | "legend") => string);
68
68
  disableHover?: boolean;
69
69
  zAxisKey?: string;
70
70
  zAxisId?: string;
71
+ datasetKeys?: {
72
+ x: string;
73
+ y: string;
74
+ z?: string;
75
+ id: string;
76
+ };
71
77
  id?: import(".").SeriesId;
72
78
  color: string;
73
79
  valueFormatter?: import(".").SeriesValueFormatter<import("..").ScatterValueType> | undefined;
@@ -1,7 +1,6 @@
1
1
  export * from './components/ChartsAxesGradients';
2
2
  export * from '../ResponsiveChartContainer/useChartContainerDimensions';
3
3
  export * from '../ResponsiveChartContainer/ResizableContainer';
4
- export { useReducedMotion } from '../hooks/useReducedMotion';
5
4
  export { useSeries } from '../hooks/useSeries';
6
5
  export { useInteractionItemProps } from '../hooks/useInteractionItemProps';
7
6
  export { useDrawingArea } from '../hooks/useDrawingArea';
@@ -24,6 +23,7 @@ export * from '../context/InteractionProvider';
24
23
  export * from '../context/SeriesProvider';
25
24
  export * from '../context/ZAxisContextProvider';
26
25
  export * from '../context/PluginProvider';
26
+ export * from '../context/AnimationProvider';
27
27
  export type * from '../context/context.types';
28
28
  export { getAxisExtremum } from '../context/CartesianProvider/getAxisExtremum';
29
29
  export * from '../models/seriesType/config';
@@ -4,7 +4,6 @@ export * from "../ResponsiveChartContainer/useChartContainerDimensions.js";
4
4
  export * from "../ResponsiveChartContainer/ResizableContainer.js";
5
5
 
6
6
  // hooks
7
- export { useReducedMotion } from "../hooks/useReducedMotion.js";
8
7
  export { useSeries } from "../hooks/useSeries.js";
9
8
  export { useInteractionItemProps } from "../hooks/useInteractionItemProps.js";
10
9
  export { useDrawingArea } from "../hooks/useDrawingArea.js";
@@ -32,6 +31,7 @@ export * from "../context/InteractionProvider.js";
32
31
  export * from "../context/SeriesProvider/index.js";
33
32
  export * from "../context/ZAxisContextProvider.js";
34
33
  export * from "../context/PluginProvider/index.js";
34
+ export * from "../context/AnimationProvider/index.js";
35
35
  export { getAxisExtremum } from "../context/CartesianProvider/getAxisExtremum.js";
36
36
 
37
37
  // series configuration
@@ -11,7 +11,7 @@ export type ScatterValueType = {
11
11
  };
12
12
  export interface ScatterSeriesType extends CommonSeriesType<ScatterValueType>, CartesianSeriesType {
13
13
  type: 'scatter';
14
- data: ScatterValueType[];
14
+ data?: ScatterValueType[];
15
15
  markerSize?: number;
16
16
  /**
17
17
  * The label to display on the tooltip or the legend. It can be a string or a function.
@@ -31,6 +31,30 @@ export interface ScatterSeriesType extends CommonSeriesType<ScatterValueType>, C
31
31
  * The id of the z-axis used to render the series.
32
32
  */
33
33
  zAxisId?: string;
34
+ /**
35
+ * The keys used to retrieve data from the dataset.
36
+ *
37
+ * When this prop is provided, all of `x`, `y`, and `id` must be provided.
38
+ * While `z` is optional.
39
+ */
40
+ datasetKeys?: {
41
+ /**
42
+ * The key used to retrieve data from the dataset for the X axis.
43
+ */
44
+ x: string;
45
+ /**
46
+ * The key used to retrieve data from the dataset for the Y axis.
47
+ */
48
+ y: string;
49
+ /**
50
+ * The key used to retrieve data from the dataset for the Z axis.
51
+ */
52
+ z?: string;
53
+ /**
54
+ * The key used to retrieve data from the dataset for the id.
55
+ */
56
+ id: string;
57
+ };
34
58
  }
35
59
  /**
36
60
  * An object that allows to identify a single scatter item.
@@ -219,7 +219,7 @@ process.env.NODE_ENV !== "production" ? BarChart.propTypes = {
219
219
  series: PropTypes.arrayOf(PropTypes.object).isRequired,
220
220
  /**
221
221
  * If `true`, animations are skipped.
222
- * @default false
222
+ * If unset or `false`, the animations respects the user's `prefers-reduced-motion` setting.
223
223
  */
224
224
  skipAnimation: PropTypes.bool,
225
225
  /**
@@ -14,7 +14,8 @@ import { BarClipPath } from "./BarClipPath.js";
14
14
  import { BarLabelPlot } from "./BarLabel/BarLabelPlot.js";
15
15
  import { checkScaleErrors } from "./checkScaleErrors.js";
16
16
  import { useBarSeries } from "../hooks/useSeries.js";
17
- import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
17
+ import { useSkipAnimation } from "../context/AnimationProvider/index.js";
18
+
18
19
  /**
19
20
  * Solution of the equations
20
21
  * W = barWidth * N + offset * (N-1)
@@ -24,6 +25,7 @@ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
24
25
  * @param gapRatio The ratio of the gap between bars over the bar width.
25
26
  * @returns The bar width and the offset between bars.
26
27
  */
28
+ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
27
29
  function getBandSize({
28
30
  bandWidth: W,
29
31
  numberOfGroups: N,
@@ -187,12 +189,13 @@ function BarPlot(props) {
187
189
  masksData
188
190
  } = useAggregatedData();
189
191
  const {
190
- skipAnimation,
192
+ skipAnimation: inSkipAnimation,
191
193
  onItemClick,
192
194
  borderRadius,
193
195
  barLabel
194
196
  } = props,
195
197
  other = _objectWithoutPropertiesLoose(props, _excluded);
198
+ const skipAnimation = useSkipAnimation(inSkipAnimation);
196
199
  const withoutBorderRadius = !borderRadius || borderRadius <= 0;
197
200
  const transition = useTransition(completedData, {
198
201
  keys: bar => `${bar.seriesId}-${bar.dataIndex}`,
@@ -284,7 +287,7 @@ process.env.NODE_ENV !== "production" ? BarPlot.propTypes = {
284
287
  onItemClick: PropTypes.func,
285
288
  /**
286
289
  * If `true`, animations are skipped.
287
- * @default false
290
+ * @default undefined
288
291
  */
289
292
  skipAnimation: PropTypes.bool,
290
293
  /**
@@ -76,13 +76,13 @@ export const useBarChartProps = props => {
76
76
  highlightedItem,
77
77
  onHighlightChange,
78
78
  disableAxisListener: tooltip?.trigger !== 'axis' && axisHighlight?.x === 'none' && axisHighlight?.y === 'none' && !onAxisClick,
79
- className
79
+ className,
80
+ skipAnimation
80
81
  });
81
82
  const barPlotProps = {
82
83
  onItemClick,
83
84
  slots,
84
85
  slotProps,
85
- skipAnimation,
86
86
  borderRadius,
87
87
  barLabel
88
88
  };
@@ -12,6 +12,7 @@ import { ChartsAxesGradients } from "../internals/components/ChartsAxesGradients
12
12
  import { HighlightedProvider, ZAxisContextProvider } from "../context/index.js";
13
13
  import { PluginProvider } from "../context/PluginProvider/index.js";
14
14
  import { useChartContainerProps } from "./useChartContainerProps.js";
15
+ import { AnimationProvider } from "../context/AnimationProvider/index.js";
15
16
  import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
16
17
  const ChartContainer = /*#__PURE__*/React.forwardRef(function ChartContainer(props, ref) {
17
18
  const {
@@ -22,7 +23,8 @@ const ChartContainer = /*#__PURE__*/React.forwardRef(function ChartContainer(pro
22
23
  zAxisContextProps,
23
24
  highlightedProviderProps,
24
25
  chartsSurfaceProps,
25
- pluginProviderProps
26
+ pluginProviderProps,
27
+ animationProviderProps
26
28
  } = useChartContainerProps(props, ref);
27
29
  return /*#__PURE__*/_jsx(DrawingProvider, _extends({}, drawingProviderProps, {
28
30
  children: /*#__PURE__*/_jsx(PluginProvider, _extends({}, pluginProviderProps, {
@@ -32,7 +34,9 @@ const ChartContainer = /*#__PURE__*/React.forwardRef(function ChartContainer(pro
32
34
  children: /*#__PURE__*/_jsx(InteractionProvider, {
33
35
  children: /*#__PURE__*/_jsx(HighlightedProvider, _extends({}, highlightedProviderProps, {
34
36
  children: /*#__PURE__*/_jsxs(ChartsSurface, _extends({}, chartsSurfaceProps, {
35
- children: [/*#__PURE__*/_jsx(ChartsAxesGradients, {}), children]
37
+ children: [/*#__PURE__*/_jsx(ChartsAxesGradients, {}), /*#__PURE__*/_jsx(AnimationProvider, _extends({}, animationProviderProps, {
38
+ children: children
39
+ }))]
36
40
  }))
37
41
  }))
38
42
  })
@@ -105,6 +109,11 @@ process.env.NODE_ENV !== "production" ? ChartContainer.propTypes = {
105
109
  * Please refer to the appropriate docs page to learn more about it.
106
110
  */
107
111
  series: PropTypes.arrayOf(PropTypes.object).isRequired,
112
+ /**
113
+ * If `true`, animations are skipped.
114
+ * If unset or `false`, the animations respects the user's `prefers-reduced-motion` setting.
115
+ */
116
+ skipAnimation: PropTypes.bool,
108
117
  sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
109
118
  title: PropTypes.string,
110
119
  viewBox: PropTypes.shape({
@@ -2,11 +2,10 @@
2
2
 
3
3
  import _extends from "@babel/runtime/helpers/esm/extends";
4
4
  import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
5
- const _excluded = ["width", "height", "series", "margin", "xAxis", "yAxis", "zAxis", "colors", "dataset", "sx", "title", "desc", "disableAxisListener", "highlightedItem", "onHighlightChange", "plugins", "children"];
5
+ const _excluded = ["width", "height", "series", "margin", "xAxis", "yAxis", "zAxis", "colors", "dataset", "sx", "title", "desc", "disableAxisListener", "highlightedItem", "onHighlightChange", "plugins", "children", "skipAnimation"];
6
6
  import * as React from 'react';
7
7
  import useForkRef from '@mui/utils/useForkRef';
8
8
  import { useDefaultizeAxis } from "./useDefaultizeAxis.js";
9
- import { useReducedMotion } from "../hooks/useReducedMotion.js";
10
9
  export const useChartContainerProps = (props, ref) => {
11
10
  const {
12
11
  width,
@@ -25,13 +24,12 @@ export const useChartContainerProps = (props, ref) => {
25
24
  highlightedItem,
26
25
  onHighlightChange,
27
26
  plugins,
28
- children
27
+ children,
28
+ skipAnimation
29
29
  } = props,
30
30
  other = _objectWithoutPropertiesLoose(props, _excluded);
31
31
  const svgRef = React.useRef(null);
32
32
  const chartSurfaceRef = useForkRef(ref, svgRef);
33
- useReducedMotion(); // a11y reduce motion (see: https://react-spring.dev/docs/utilities/use-reduced-motion)
34
-
35
33
  const [defaultizedXAxis, defaultizedYAxis] = useDefaultizeAxis(xAxis, yAxis, dataset);
36
34
  const drawingProviderProps = {
37
35
  width,
@@ -39,6 +37,9 @@ export const useChartContainerProps = (props, ref) => {
39
37
  margin,
40
38
  svgRef
41
39
  };
40
+ const animationProviderProps = {
41
+ skipAnimation
42
+ };
42
43
  const pluginProviderProps = {
43
44
  plugins
44
45
  };
@@ -78,6 +79,7 @@ export const useChartContainerProps = (props, ref) => {
78
79
  highlightedProviderProps,
79
80
  chartsSurfaceProps,
80
81
  pluginProviderProps,
82
+ animationProviderProps,
81
83
  xAxis: defaultizedXAxis,
82
84
  yAxis: defaultizedYAxis
83
85
  };