@mui/x-charts 8.26.0 → 8.27.4

package/internals/plugins/featurePlugins/useChartItemClick/useChartItemClick.types.d.ts

@@ -0,0 +1,22 @@
+import type { ChartPluginSignature, ChartSeriesTypeRequiredPlugins } from "../../models/index.js";
+import type { ChartSeriesType } from "../../../../models/seriesType/config.js";
+import type { SeriesItemIdentifier } from "../../../../models/seriesType/index.js";
+export interface UseChartItemClickParameters<SeriesType extends ChartSeriesType = ChartSeriesType> {
+  /**
+   * The callback fired when an item is clicked.
+   *
+   * @param {React.MouseEvent<SVGSVGElement, MouseEvent>} event The click event.
+   * @param {SeriesItemIdentifier<SeriesType>} item The clicked item.
+   */
+  onItemClick?: (event: React.MouseEvent<SVGSVGElement, MouseEvent>, item: SeriesItemIdentifier<SeriesType>) => void;
+}
+export interface UseChartItemClickInstance {
+  handleClick?: (event: React.MouseEvent<SVGSVGElement, MouseEvent>) => void;
+}
+export interface UseChartItemClickState {}
+export type UseChartItemClickSignature<SeriesType extends ChartSeriesType = ChartSeriesType> = ChartPluginSignature<{
+  params: UseChartItemClickParameters<SeriesType>;
+  defaultizedParams: UseChartItemClickParameters<SeriesType>;
+  instance: UseChartItemClickInstance;
+  dependencies: ChartSeriesTypeRequiredPlugins<SeriesType>;
+}>;

package/internals/plugins/featurePlugins/useChartItemClick/useChartItemClick.types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/internals/plugins/models/seriesConfig/getItemAtPosition.types.d.ts

@@ -0,0 +1,8 @@
+import type { SeriesItemIdentifier } from "../../../../models/seriesType/index.js";
+import type { ChartState } from "../chart.js";
+import type { ChartSeriesType } from "../../../../models/seriesType/config.js";
+import type { ChartSeriesTypeRequiredPlugins } from "./seriesConfig.types.js";
+export type GetItemAtPosition<TSeriesType extends ChartSeriesType> = (state: ChartState<ChartSeriesTypeRequiredPlugins<TSeriesType>>, point: {
+  x: number;
+  y: number;
+}) => SeriesItemIdentifier<TSeriesType> | undefined;

package/internals/plugins/models/seriesConfig/getItemAtPosition.types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/internals/plugins/models/seriesConfig/seriesConfig.types.d.ts

@@ -1,5 +1,5 @@
 import type { SeriesProcessor } from "./seriesProcessor.types.js";
-import type { CartesianChartSeriesType, ChartSeriesType, PolarChartSeriesType } from "../../../../models/seriesType/config.js";
+import type { CartesianChartSeriesType, ChartSeriesType, ChartsSeriesConfig, PolarChartSeriesType } from "../../../../models/seriesType/config.js";
 import type { ColorProcessor } from "./colorProcessor.types.js";
 import type { CartesianExtremumGetter } from "./cartesianExtremumGetter.types.js";
 import type { LegendGetter } from "./legendGetter.types.js";
@@ -10,6 +10,14 @@ import { type TooltipItemPositionGetter } from "./tooltipItemPositionGetter.type
 import { type SeriesLayoutGetter } from "./seriesLayout.types.js";
 import { type KeyboardFocusHandler } from "../../featurePlugins/useChartKeyboardNavigation/keyboardFocusHandler.types.js";
 import { type IdentifierSerializer } from "./identifierSerializer.types.js";
+import { type GetItemAtPosition } from "./getItemAtPosition.types.js";
+import { type UseChartCartesianAxisSignature } from "../../featurePlugins/useChartCartesianAxis/index.js";
+import { type UseChartPolarAxisSignature } from "../../featurePlugins/useChartPolarAxis/index.js";
+export type ChartSeriesTypeRequiredPlugins<TSeriesType extends ChartSeriesType> = ChartsSeriesConfig[TSeriesType] extends {
+  axisType: 'cartesian';
+} ? [UseChartCartesianAxisSignature] : ChartsSeriesConfig[TSeriesType] extends {
+  axisType: 'polar';
+} ? [UseChartPolarAxisSignature] : [];
 export type ChartSeriesTypeConfig<TSeriesType extends ChartSeriesType> = {
   seriesProcessor: SeriesProcessor<TSeriesType>;
   /**
@@ -28,6 +36,7 @@ export type ChartSeriesTypeConfig<TSeriesType extends ChartSeriesType> = {
    * @returns {string} A unique string representation of the identifier.
    */
   identifierSerializer: IdentifierSerializer<TSeriesType>;
+  getItemAtPosition?: GetItemAtPosition<TSeriesType>;
 } & (TSeriesType extends CartesianChartSeriesType ? {
   xExtremumGetter: CartesianExtremumGetter<TSeriesType>;
   yExtremumGetter: CartesianExtremumGetter<TSeriesType>;

package/internals/store/useStore.js

@@ -9,7 +9,7 @@ var _ChartProvider = require("../../context/ChartProvider");
 function useStore() {
   const context = (0, _ChartProvider.useChartContext)();
   if (!context) {
-    throw new Error(['MUI X Charts: Could not find the charts context.', 'It looks like you rendered your component outside of a ChartContainer parent component.'].join('\n'));
+    throw new Error('MUI X Charts: Could not find the Charts context. ' + 'This happens when the component is rendered outside of a ChartsContainer parent component. ' + 'Wrap your component in a ChartsContainer or ChartsDataProvider.');
   }
   return context.store;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-charts",
-  "version": "8.26.0",
+  "version": "8.27.4",
   "author": "MUI Team",
   "description": "The community edition of MUI X Charts components.",
   "license": "MIT",
@@ -34,9 +34,9 @@
     "prop-types": "^15.8.1",
     "reselect": "^5.1.1",
     "use-sync-external-store": "^1.6.0",
-    "@mui/x-charts-vendor": "8.26.0",
+    "@mui/x-internal-gestures": "0.4.0",
     "@mui/x-internals": "8.26.0",
-    "@mui/x-internal-gestures": "0.4.0"
+    "@mui/x-charts-vendor": "8.26.0"
   },
   "peerDependencies": {
     "@emotion/react": "^11.9.0",

package/themeAugmentation/components.d.ts

@@ -33,6 +33,10 @@ export interface ChartsComponents<Theme = unknown> {
     defaultProps?: ComponentsProps['MuiChartsSurface'];
     styleOverrides?: ComponentsOverrides<Theme>['MuiChartsSurface'];
   };
+  MuiChartsDataProvider?: {
+    defaultProps?: ComponentsProps['MuiChartsDataProvider'];
+  };
+  /** @deprecated Use `MuiChartsDataProvider` instead. */
   MuiChartDataProvider?: {
     defaultProps?: ComponentsProps['MuiChartDataProvider'];
   };

package/themeAugmentation/props.d.ts

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