@mui/x-charts 7.6.2 → 7.7.0

package/modern/ScatterChart/ScatterChart.js

@@ -6,7 +6,7 @@ import { ResponsiveChartContainer } from '../ResponsiveChartContainer';
 import { ChartsAxis } from '../ChartsAxis';
 import { ChartsTooltip } from '../ChartsTooltip';
 import { ChartsLegend } from '../ChartsLegend';
-import { ChartsOverlay } from '../ChartsOverlay/ChartsOverlay';
+import { ChartsOverlay } from '../ChartsOverlay';
 import { ChartsAxisHighlight } from '../ChartsAxisHighlight';
 import { ChartsVoronoiHandler } from '../ChartsVoronoiHandler/ChartsVoronoiHandler';
 import { ChartsGrid } from '../ChartsGrid';

package/modern/SparkLineChart/SparkLineChart.js

@@ -27,6 +27,7 @@ const SPARKLINE_DEFAULT_MARGIN = {
 const SparkLineChart = /*#__PURE__*/React.forwardRef(function SparkLineChart(props, ref) {
   const {
     xAxis,
+    yAxis,
     width,
     height,
     margin = SPARKLINE_DEFAULT_MARGIN,
@@ -73,6 +74,9 @@ const SparkLineChart = /*#__PURE__*/React.forwardRef(function SparkLineChart(pro
       }, (_, index) => index),
       hideTooltip: xAxis === undefined
     }, xAxis)],
+    yAxis: [_extends({
+      id: DEFAULT_X_AXIS_KEY
+    }, yAxis)],
     colors: colors,
     sx: sx,
     disableAxisListener: (!showTooltip || tooltip?.trigger !== 'axis') && axisHighlight?.x === 'none' && axisHighlight?.y === 'none',
@@ -233,7 +237,7 @@ process.env.NODE_ENV !== "production" ? SparkLineChart.propTypes = {
   width: PropTypes.number,
   /**
    * The xAxis configuration.
-   * Notice it is a single configuration object, not an array of configuration.
+   * Notice it is a single [[AxisConfig]] object, not an array of configuration.
    */
   xAxis: PropTypes.shape({
     axisId: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
@@ -282,6 +286,58 @@ process.env.NODE_ENV !== "production" ? SparkLineChart.propTypes = {
     tickPlacement: PropTypes.oneOf(['end', 'extremities', 'middle', 'start']),
     tickSize: PropTypes.number,
     valueFormatter: PropTypes.func
+  }),
+  /**
+   * The yAxis configuration.
+   * Notice it is a single [[AxisConfig]] object, not an array of configuration.
+   */
+  yAxis: PropTypes.shape({
+    axisId: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+    classes: PropTypes.object,
+    colorMap: PropTypes.oneOfType([PropTypes.shape({
+      colors: PropTypes.arrayOf(PropTypes.string).isRequired,
+      type: PropTypes.oneOf(['ordinal']).isRequired,
+      unknownColor: PropTypes.string,
+      values: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number, PropTypes.string]).isRequired)
+    }), PropTypes.shape({
+      color: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string.isRequired), PropTypes.func]).isRequired,
+      max: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
+      min: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
+      type: PropTypes.oneOf(['continuous']).isRequired
+    }), PropTypes.shape({
+      colors: PropTypes.arrayOf(PropTypes.string).isRequired,
+      thresholds: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]).isRequired).isRequired,
+      type: PropTypes.oneOf(['piecewise']).isRequired
+    })]),
+    data: PropTypes.array,
+    dataKey: PropTypes.string,
+    disableLine: PropTypes.bool,
+    disableTicks: PropTypes.bool,
+    fill: PropTypes.string,
+    hideTooltip: PropTypes.bool,
+    id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+    label: PropTypes.string,
+    labelFontSize: PropTypes.number,
+    labelStyle: PropTypes.object,
+    max: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
+    min: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
+    position: PropTypes.oneOf(['left', 'right']),
+    reverse: PropTypes.bool,
+    scaleType: PropTypes.oneOf(['band', 'linear', 'log', 'point', 'pow', 'sqrt', 'time', 'utc']),
+    slotProps: PropTypes.object,
+    slots: PropTypes.object,
+    stroke: PropTypes.string,
+    tickFontSize: PropTypes.number,
+    tickInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.array, PropTypes.func]),
+    tickLabelInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.func]),
+    tickLabelPlacement: PropTypes.oneOf(['middle', 'tick']),
+    tickLabelStyle: PropTypes.object,
+    tickMaxStep: PropTypes.number,
+    tickMinStep: PropTypes.number,
+    tickNumber: PropTypes.number,
+    tickPlacement: PropTypes.oneOf(['end', 'extremities', 'middle', 'start']),
+    tickSize: PropTypes.number,
+    valueFormatter: PropTypes.func
   })
 } : void 0;
 export { SparkLineChart };

package/modern/context/CartesianContextProvider.js

@@ -1,9 +1,6 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
 import * as React from 'react';
 import { scaleBand, scalePoint } from 'd3-scale';
-import { getExtremumX as getBarExtremumX, getExtremumY as getBarExtremumY } from '../BarChart/extremums';
-import { getExtremumX as getScatterExtremumX, getExtremumY as getScatterExtremumY } from '../ScatterChart/extremums';
-import { getExtremumX as getLineExtremumX, getExtremumY as getLineExtremumY } from '../LineChart/extremums';
 import { isBandScaleConfig, isPointScaleConfig } from '../models/axis';
 import { getScale } from '../internals/getScale';
 import { DEFAULT_X_AXIS_KEY, DEFAULT_Y_AXIS_KEY } from '../constants';
@@ -14,18 +11,6 @@ import { useSeries } from '../hooks/useSeries';
 import { jsx as _jsx } from "react/jsx-runtime";
 const DEFAULT_CATEGORY_GAP_RATIO = 0.2;
 const DEFAULT_BAR_GAP_RATIO = 0.1;
-
-// TODO: those might be better placed in a distinct file
-const xExtremumGetters = {
-  bar: getBarExtremumX,
-  scatter: getScatterExtremumX,
-  line: getLineExtremumX
-};
-const yExtremumGetters = {
-  bar: getBarExtremumY,
-  scatter: getScatterExtremumY,
-  line: getLineExtremumY
-};
 export const CartesianContext = /*#__PURE__*/React.createContext({
   xAxis: {},
   yAxis: {},
@@ -40,6 +25,8 @@ function CartesianContextProvider(props) {
     xAxis: inXAxis,
     yAxis: inYAxis,
     dataset,
+    xExtremumGetters,
+    yExtremumGetters,
     children
   } = props;
   const formattedSeries = useSeries();
@@ -72,11 +59,11 @@ function CartesianContextProvider(props) {
     const axisExtremumCallback = (acc, chartType, axis, getters, isDefaultAxis) => {
       const getter = getters[chartType];
       const series = formattedSeries[chartType]?.series ?? {};
-      const [minChartTypeData, maxChartTypeData] = getter({
+      const [minChartTypeData, maxChartTypeData] = getter?.({
         series,
         axis,
         isDefaultAxis
-      });
+      }) ?? [null, null];
       const [minData, maxData] = acc;
       if (minData === null || maxData === null) {
         return [minChartTypeData, maxChartTypeData];
@@ -213,7 +200,7 @@ function CartesianContextProvider(props) {
         id
       }) => id)
     };
-  }, [drawingArea.height, drawingArea.left, drawingArea.top, drawingArea.width, formattedSeries, xAxis, yAxis]);
+  }, [drawingArea.height, drawingArea.left, drawingArea.top, drawingArea.width, formattedSeries, xAxis, xExtremumGetters, yAxis, yExtremumGetters]);
 
   // @ts-ignore
   return /*#__PURE__*/_jsx(CartesianContext.Provider, {

package/modern/context/ColorProvider.js

@@ -0,0 +1,16 @@
+import * as React from 'react';
+import { jsx as _jsx } from "react/jsx-runtime";
+export const ColorContext = /*#__PURE__*/React.createContext({});
+if (process.env.NODE_ENV !== 'production') {
+  ColorContext.displayName = 'ColorContext';
+}
+export function ColorProvider(props) {
+  const {
+    colorProcessors,
+    children
+  } = props;
+  return /*#__PURE__*/_jsx(ColorContext.Provider, {
+    value: colorProcessors,
+    children: children
+  });
+}

package/modern/hooks/index.js

@@ -1,5 +1,6 @@
 export * from './useDrawingArea';
 export * from './useChartId';
 export * from './useScale';
+export * from './useColorScale';
 export * from './useSvgRef';
 export { useSeries as unstable_useSeries, usePieSeries as unstable_usePieSeries, useLineSeries as unstable_useLineSeries, useBarSeries as unstable_useBarSeries, useScatterSeries as unstable_useScatterSeries } from './useSeries';

package/modern/hooks/useColor.js

@@ -0,0 +1,9 @@
+import * as React from 'react';
+import { ColorContext } from '../context/ColorProvider';
+export function useColorProcessor(seriesType) {
+  const colorProcessors = React.useContext(ColorContext);
+  if (!seriesType) {
+    return colorProcessors;
+  }
+  return colorProcessors[seriesType];
+}

package/modern/hooks/useColorScale.js

@@ -0,0 +1,27 @@
+import * as React from 'react';
+import { CartesianContext } from '../context/CartesianContextProvider';
+import { ZAxisContext } from '../context/ZAxisContextProvider';
+export function useXColorScale(identifier) {
+  const {
+    xAxis,
+    xAxisIds
+  } = React.useContext(CartesianContext);
+  const id = typeof identifier === 'string' ? identifier : xAxisIds[identifier ?? 0];
+  return xAxis[id].colorScale;
+}
+export function useYColorScale(identifier) {
+  const {
+    yAxis,
+    yAxisIds
+  } = React.useContext(CartesianContext);
+  const id = typeof identifier === 'string' ? identifier : yAxisIds[identifier ?? 0];
+  return yAxis[id].colorScale;
+}
+export function useZColorScale(identifier) {
+  const {
+    zAxis,
+    zAxisIds
+  } = React.useContext(ZAxisContext);
+  const id = typeof identifier === 'string' ? identifier : zAxisIds[identifier ?? 0];
+  return zAxis[id]?.colorScale;
+}

package/modern/hooks/useReducedMotion.js

@@ -11,6 +11,13 @@ export const useReducedMotion = () => {
   // Taken from: https://github.com/pmndrs/react-spring/blob/02ec877bbfab0df46da0e4a47d5f68d3e731206a/packages/shared/src/hooks/useReducedMotion.ts#L13
 
   useIsomorphicLayoutEffect(() => {
+    if (!window.matchMedia) {
+      // skip animation in environments where `window.matchMedia` would not be available (i.e. test/jsdom)
+      Globals.assign({
+        skipAnimation: true
+      });
+      return () => {};
+    }
     const mql = window.matchMedia('(prefers-reduced-motion)');
     const handleMediaChange = e => {
       Globals.assign({

package/modern/index.js

@@ -1,5 +1,5 @@
 /**
- * @mui/x-charts v7.6.2
+ * @mui/x-charts v7.7.0
  *
  * @license MIT
  * This source code is licensed under the MIT license found in the

package/modern/internals/index.js

@@ -1 +1,27 @@
-export * from './configInit';
+// Components
+export * from './components/ChartsAxesGradients';
+export * from '../ResponsiveChartContainer/useChartContainerDimensions';
+export * from '../ResponsiveChartContainer/ResizableContainer';
+
+// hooks
+export { useReducedMotion } from '../hooks/useReducedMotion';
+export { useSeries } from '../hooks/useSeries';
+
+// utils
+export * from './defaultizeValueFormatter';
+export * from './configInit';
+
+// contexts
+
+export * from '../context/CartesianContextProvider';
+export * from '../context/DrawingProvider';
+export * from '../context/InteractionProvider';
+export * from '../context/SeriesContextProvider';
+export * from '../context/ZAxisContextProvider';
+
+// series configuration
+export * from '../models/seriesType/config';
+export * from '../models/seriesType/common';
+export * from '../models/helpers';
+export * from '../models/z-axis';
+export * from '../models/axis';

package/modern/internals/warning.js

@@ -0,0 +1,13 @@
+export function buildWarning(message, gravity = 'warning') {
+  let alreadyWarned = false;
+  return (...args) => {
+    if (!alreadyWarned) {
+      alreadyWarned = true;
+      if (gravity === 'error') {
+        console.error(message(...args));
+      } else {
+        console.warn(message(...args));
+      }
+    }
+  };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-charts",
-  "version": "7.6.2",
+  "version": "7.7.0",
   "description": "The community edition of the Charts components (MUI X).",
   "author": "MUI Team",
   "main": "./index.js",
@@ -29,7 +29,7 @@
     "directory": "packages/x-charts"
   },
   "dependencies": {
-    "@babel/runtime": "^7.24.6",
+    "@babel/runtime": "^7.24.7",
     "@mui/base": "^5.0.0-beta.40",
     "@mui/system": "^5.15.15",
     "@mui/utils": "^5.15.14",

package/themeAugmentation/components.d.ts

@@ -1,9 +1,9 @@
 import { ComponentsProps, ComponentsOverrides } from '@mui/material/styles';
 
-export interface ChartsComponents {
+export interface ChartsComponents<Theme = unknown> {
   MuiChartsAxis?: {
     defaultProps?: ComponentsProps['MuiChartsAxis'];
-    styleOverrides?: ComponentsOverrides['MuiChartsAxis'];
+    styleOverrides?: ComponentsOverrides<Theme>['MuiChartsAxis'];
   };
   MuiChartsXAxis?: {
     defaultProps?: ComponentsProps['MuiChartsXAxis'];
@@ -13,22 +13,22 @@ export interface ChartsComponents {
   };
   MuiChartsAxisHighlight?: {
     defaultProps?: ComponentsProps['MuiChartsAxisHighlight'];
-    styleOverrides?: ComponentsOverrides['MuiChartsAxisHighlight'];
+    styleOverrides?: ComponentsOverrides<Theme>['MuiChartsAxisHighlight'];
   };
   MuiChartsClipPath?: {
     defaultProps?: ComponentsProps['MuiChartsClipPath'];
   };
   MuiChartsGrid?: {
     defaultProps?: ComponentsProps['MuiChartsGrid'];
-    styleOverrides?: ComponentsOverrides['MuiChartsGrid'];
+    styleOverrides?: ComponentsOverrides<Theme>['MuiChartsGrid'];
   };
   MuiChartsLegend?: {
     defaultProps?: ComponentsProps['MuiChartsLegend'];
-    styleOverrides?: ComponentsOverrides['MuiChartsLegend'];
+    styleOverrides?: ComponentsOverrides<Theme>['MuiChartsLegend'];
   };
   MuiChartsTooltip?: {
     defaultProps?: ComponentsProps['MuiChartsTooltip'];
-    styleOverrides?: ComponentsOverrides['MuiChartsTooltip'];
+    styleOverrides?: ComponentsOverrides<Theme>['MuiChartsTooltip'];
   };
   MuiChartsSurface?: {
     defaultProps?: ComponentsProps['MuiChartsSurface'];
@@ -38,26 +38,26 @@ export interface ChartsComponents {
   };
   MuiBarElement?: {
     defaultProps?: ComponentsProps['MuiBarElement'];
-    styleOverrides?: ComponentsOverrides['MuiBarElement'];
+    styleOverrides?: ComponentsOverrides<Theme>['MuiBarElement'];
   };
   MuiBarLabel?: {
     defaultProps?: ComponentsProps['MuiBarLabel'];
-    styleOverrides?: ComponentsOverrides['MuiBarLabel'];
+    styleOverrides?: ComponentsOverrides<Theme>['MuiBarLabel'];
   };
   MuiLineChart?: {
     defaultProps?: ComponentsProps['MuiLineChart'];
   };
   MuiAreaElement?: {
     defaultProps?: ComponentsProps['MuiAreaElement'];
-    styleOverrides?: ComponentsOverrides['MuiAreaElement'];
+    styleOverrides?: ComponentsOverrides<Theme>['MuiAreaElement'];
   };
   MuiLineElement?: {
     defaultProps?: ComponentsProps['MuiLineElement'];
-    styleOverrides?: ComponentsOverrides['MuiLineElement'];
+    styleOverrides?: ComponentsOverrides<Theme>['MuiLineElement'];
   };
   MuiMarkElement?: {
     defaultProps?: ComponentsProps['MuiMarkElement'];
-    styleOverrides?: ComponentsOverrides['MuiMarkElement'];
+    styleOverrides?: ComponentsOverrides<Theme>['MuiMarkElement'];
   };
   MuiScatterChart?: {
     defaultProps?: ComponentsProps['MuiScatterChart'];
@@ -68,5 +68,5 @@ export interface ChartsComponents {
 }
 
 declare module '@mui/material/styles' {
-  interface Components extends ChartsComponents {}
+  interface Components<Theme = unknown> extends ChartsComponents<Theme> {}
 }

package/esm/internals/colorGetter.js

@@ -1,22 +0,0 @@
-import getBarColor from '../BarChart/getColor';
-import getLineColor from '../LineChart/getColor';
-import getScatterColor from '../ScatterChart/getColor';
-import getPieColor from '../PieChart/getColor';
-function getColor(series, xAxis, yAxis, zAxis) {
-  if (xAxis !== undefined && yAxis !== undefined) {
-    if (series.type === 'bar') {
-      return getBarColor(series, xAxis, yAxis);
-    }
-    if (series.type === 'line') {
-      return getLineColor(series, xAxis, yAxis);
-    }
-    if (series.type === 'scatter') {
-      return getScatterColor(series, xAxis, yAxis, zAxis);
-    }
-  }
-  if (series.type === 'pie') {
-    return getPieColor(series);
-  }
-  throw Error(`MUI X Charts: getColor called with unexpected arguments for series with id "${series.id}"`);
-}
-export default getColor;

package/internals/colorGetter.d.ts

@@ -1,7 +0,0 @@
-import { DefaultizedBarSeriesType, DefaultizedLineSeriesType, DefaultizedPieSeriesType, DefaultizedScatterSeriesType } from '../models';
-import { AxisDefaultized } from '../models/axis';
-import { ZAxisDefaultized } from '../models/z-axis';
-declare function getColor(series: DefaultizedPieSeriesType): (dataIndex: number) => string;
-declare function getColor(series: DefaultizedBarSeriesType | DefaultizedLineSeriesType, xAxis: AxisDefaultized, yAxis: AxisDefaultized): (dataIndex: number) => string;
-declare function getColor(series: DefaultizedScatterSeriesType, xAxis: AxisDefaultized, yAxis: AxisDefaultized, zAxis?: ZAxisDefaultized): (dataIndex: number) => string;
-export default getColor;

package/internals/colorGetter.js

@@ -1,29 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _getColor = _interopRequireDefault(require("../BarChart/getColor"));
-var _getColor2 = _interopRequireDefault(require("../LineChart/getColor"));
-var _getColor3 = _interopRequireDefault(require("../ScatterChart/getColor"));
-var _getColor4 = _interopRequireDefault(require("../PieChart/getColor"));
-function getColor(series, xAxis, yAxis, zAxis) {
-  if (xAxis !== undefined && yAxis !== undefined) {
-    if (series.type === 'bar') {
-      return (0, _getColor.default)(series, xAxis, yAxis);
-    }
-    if (series.type === 'line') {
-      return (0, _getColor2.default)(series, xAxis, yAxis);
-    }
-    if (series.type === 'scatter') {
-      return (0, _getColor3.default)(series, xAxis, yAxis, zAxis);
-    }
-  }
-  if (series.type === 'pie') {
-    return (0, _getColor4.default)(series);
-  }
-  throw Error(`MUI X Charts: getColor called with unexpected arguments for series with id "${series.id}"`);
-}
-var _default = exports.default = getColor;

package/modern/internals/colorGetter.js

@@ -1,22 +0,0 @@
-import getBarColor from '../BarChart/getColor';
-import getLineColor from '../LineChart/getColor';
-import getScatterColor from '../ScatterChart/getColor';
-import getPieColor from '../PieChart/getColor';
-function getColor(series, xAxis, yAxis, zAxis) {
-  if (xAxis !== undefined && yAxis !== undefined) {
-    if (series.type === 'bar') {
-      return getBarColor(series, xAxis, yAxis);
-    }
-    if (series.type === 'line') {
-      return getLineColor(series, xAxis, yAxis);
-    }
-    if (series.type === 'scatter') {
-      return getScatterColor(series, xAxis, yAxis, zAxis);
-    }
-  }
-  if (series.type === 'pie') {
-    return getPieColor(series);
-  }
-  throw Error(`MUI X Charts: getColor called with unexpected arguments for series with id "${series.id}"`);
-}
-export default getColor;