@mui/x-charts 8.7.0 → 8.8.0

package/internals/plugins/utils/useLazySelectorEffect.js

@@ -0,0 +1,77 @@
+"use strict";
+'use client';
+
+/* eslint-disable react-compiler/react-compiler */
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useLazySelectorEffect = useLazySelectorEffect;
+var React = _interopRequireWildcard(require("react"));
+var _useLazyRef = _interopRequireDefault(require("@mui/utils/useLazyRef"));
+const noop = () => {};
+function useLazySelectorEffect(store, selector, effect,
+/**
+ * If true, the selector will be ignored.
+ */
+skip) {
+  const instance = (0, _useLazyRef.default)(initialize, {
+    store,
+    selector,
+    skip
+  }).current;
+  instance.effect = effect;
+  // eslint-disable-next-line react-hooks/exhaustive-deps
+  React.useEffect(instance.onMount(skip), [skip]);
+}
+
+// `useLazyRef` typings are incorrect, `params` should not be optional
+function initialize(params) {
+  const {
+    store,
+    selector,
+    skip: initialSkip
+  } = params;
+  let isRunning = false;
+  let previousState;
+
+  // We want a single subscription done right away and cleared on unmount only,
+  // but React triggers `useOnMount` multiple times in dev, so we need to manage
+  // the subscription anyway.
+  const subscribe = () => {
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    instance.dispose ?? (instance.dispose = store.subscribe(state => {
+      const nextState = selector(state);
+      // eslint-disable-next-line @typescript-eslint/no-use-before-define
+      instance.effect(previousState, nextState);
+      previousState = nextState;
+    }));
+  };
+  const instance = {
+    effect: noop,
+    dispose: null,
+    onMount: skip => () => {
+      if (skip) {
+        return undefined;
+      }
+      if (!isRunning) {
+        // Initialize values
+        isRunning = true;
+        previousState = selector(store.value);
+      }
+      subscribe();
+      return () => {
+        instance.dispose?.();
+        instance.dispose = null;
+      };
+    }
+  };
+  if (!initialSkip) {
+    // Initialize values
+    isRunning = true;
+    previousState = selector(store.value);
+    subscribe();
+  }
+  return instance;
+}

package/internals/store/useCharts.d.ts

@@ -16,7 +16,7 @@ import { ChartSeriesConfig } from "../plugins/models/seriesConfig/index.js";
  */
 export declare function useCharts<TSeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]>(inPlugins: ConvertSignaturesIntoPlugins<TSignatures>, props: Partial<UseChartBaseProps<TSignatures>>, seriesConfig: ChartSeriesConfig<TSeriesType>): {
   contextValue: {
-    store: ChartStore<readonly [import("../index.js").UseChartIdSignature, import("../index.js").UseChartDimensionsSignature, import("../index.js").UseChartSeriesSignature, import("../plugins/corePlugins/useChartAnimation/index.js").UseChartAnimationSignature, import("../index.js").UseChartInteractionListenerSignature, ...TSignatures]> & UseChartInteractionState;
+    store: ChartStore<readonly [import("../index.js").UseChartIdSignature, import("../plugins/corePlugins/useChartExperimentalFeature/index.js").UseChartExperimentalFeaturesSignature, import("../index.js").UseChartDimensionsSignature, import("../index.js").UseChartSeriesSignature, import("../plugins/corePlugins/useChartAnimation/index.js").UseChartAnimationSignature, import("../index.js").UseChartInteractionListenerSignature, ...TSignatures]> & UseChartInteractionState;
     publicAPI: ChartPublicAPI<TSignatures>;
     instance: ChartInstance<TSignatures>;
     svgRef: React.RefObject<SVGSVGElement | null>;

package/models/axis.d.ts

@@ -408,6 +408,21 @@ export interface ChartsAxisData {
    */
   seriesValues: Record<string, number | null | undefined>;
 }
+export type CartesianDirection = 'x' | 'y';
+export type PolarDirection = 'rotation' | 'radius';
+/**
+ * Identifies a data point within an axis.
+ */
+export interface AxisItemIdentifier {
+  /**
+   * The axis id.
+   */
+  axisId: AxisId;
+  /**
+   * The data index.
+   */
+  dataIndex: number;
+}
 export type XAxis<S extends ScaleName = ScaleName, V = any> = S extends ScaleName ? MakeOptional<AxisConfig<S, V, ChartsXAxisProps>, 'id'> : never;
 export type YAxis<S extends ScaleName = ScaleName, V = any> = S extends ScaleName ? MakeOptional<AxisConfig<S, V, ChartsYAxisProps>, 'id'> : never;
 export type RotationAxis<S extends ScaleName = ScaleName, V = any> = S extends ScaleName ? AxisConfig<S, V, ChartsRotationAxisProps> : never;

package/models/axis.js

@@ -29,6 +29,10 @@ function isPointScaleConfig(scaleConfig) {
  * The data format returned by onAxisClick.
  */
 
+/**
+ * Identifies a data point within an axis.
+ */
+
 /**
  * The axis configuration with missing values filled with default values.
  */

package/models/index.d.ts

@@ -1,7 +1,7 @@
 export * from "./seriesType/index.js";
 export * from "./stacking.js";
 export * from "./slots/index.js";
-export type { AxisConfig, ChartsYAxisProps, ChartsXAxisProps, ScaleName, ContinuousScaleName, ChartsAxisData, XAxis, YAxis, RadiusAxis, RotationAxis, AxisValueFormatterContext } from "./axis.js";
+export type { AxisConfig, ChartsYAxisProps, ChartsXAxisProps, ScaleName, ContinuousScaleName, ChartsAxisData, XAxis, YAxis, RadiusAxis, RotationAxis, AxisItemIdentifier, AxisValueFormatterContext } from "./axis.js";
 export type { PropsFromSlot } from '@mui/x-internals/slots';
 export type { Position } from "./position.js";
 export type { CurveType } from "./curve.js";

package/models/seriesType/scatter.d.ts

@@ -1,4 +1,4 @@
-import { DefaultizedProps } from '@mui/x-internals/types';
+import { DefaultizedProps, MakeRequired } from '@mui/x-internals/types';
 import { CartesianSeriesType, CommonDefaultizedProps, CommonSeriesType, SeriesId } from "./common.js";
 export type ScatterValueType = {
   x: number;
@@ -50,6 +50,13 @@ export interface ScatterSeriesType extends CommonSeriesType<ScatterValueType | n
      */
     id?: string;
   };
+  preview?: {
+    /**
+     * The size of the preview marker.
+     * @default 1
+     */
+    markerSize?: number;
+  };
 }
 /**
  * An object that allows to identify a single scatter item.
@@ -60,4 +67,6 @@ export type ScatterItemIdentifier = {
   seriesId: SeriesId;
   dataIndex: number;
 };
-export interface DefaultizedScatterSeriesType extends DefaultizedProps<ScatterSeriesType, CommonDefaultizedProps | 'color' | 'markerSize'> {}
+export interface DefaultizedScatterSeriesType extends DefaultizedProps<ScatterSeriesType, CommonDefaultizedProps | 'color' | 'markerSize'> {
+  preview: MakeRequired<NonNullable<ScatterSeriesType['preview']>, 'markerSize'>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-charts",
-  "version": "8.7.0",
+  "version": "8.8.0",
   "author": "MUI Team",
   "description": "The community edition of MUI X Charts components.",
   "main": "./index.js",
@@ -30,15 +30,15 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.27.6",
-    "@mui/utils": "^7.1.1",
+    "@mui/utils": "^7.2.0",
     "bezier-easing": "^2.1.0",
     "clsx": "^2.1.1",
     "prop-types": "^15.8.1",
     "reselect": "^5.1.1",
     "use-sync-external-store": "^1.5.0",
     "@mui/x-charts-vendor": "8.5.3",
-    "@mui/x-internal-gestures": "0.2.0",
-    "@mui/x-internals": "8.7.0"
+    "@mui/x-internals": "8.8.0",
+    "@mui/x-internal-gestures": "0.2.1"
   },
   "peerDependencies": {
     "@emotion/react": "^11.9.0",

package/themeAugmentation/components.d.ts

@@ -33,6 +33,9 @@ export interface ChartsComponents<Theme = unknown> {
     defaultProps?: ComponentsProps['MuiChartsSurface'];
     styleOverrides?: ComponentsOverrides<Theme>['MuiChartsSurface'];
   };
+  MuiChartDataProvider?: {
+    defaultProps?: ComponentsProps['MuiChartDataProvider'];
+  };
   MuiBarChart?: {
     defaultProps?: ComponentsProps['MuiBarChart'];
   };

package/themeAugmentation/props.d.ts

@@ -9,6 +9,7 @@ import { ScatterChartProps } from "../ScatterChart/ScatterChart.js";
 import { PieChartProps } from "../PieChart/PieChart.js";
 import { ChartsXAxisProps, ChartsYAxisProps } from "../models/axis.js";
 import { ChartsLocalizationProviderProps } from "../ChartsLocalizationProvider/index.js";
+import { ChartDataProviderProps } from "../ChartDataProvider/index.js";
 export interface ChartsComponentsPropsList {
   MuiChartsXAxis: ChartsXAxisProps;
   MuiChartsYAxis: ChartsYAxisProps;
@@ -17,6 +18,7 @@ export interface ChartsComponentsPropsList {
   MuiChartsLocalizationProvider: ChartsLocalizationProviderProps;
   MuiChartsTooltip: ChartsTooltipProps;
   MuiChartsSurface: ChartsSurfaceProps;
+  MuiChartDataProvider: ChartDataProviderProps;
   MuiBarChart: BarChartProps;
   MuiBarLabel: BarLabelProps;
   MuiLineChart: LineChartProps;