@mui/x-charts 8.5.3 → 8.7.0

package/esm/internals/plugins/featurePlugins/useChartVoronoi/useChartVoronoi.js

@@ -1,3 +1,5 @@
+'use client';
+
 import _extends from "@babel/runtime/helpers/esm/extends";
 import * as React from 'react';
 import useEnhancedEffect from '@mui/utils/useEnhancedEffect';
@@ -130,12 +132,28 @@ export const useChartVoronoi = ({
         dataIndex
       };
     }
-    const handleMouseLeave = () => {
-      instance.cleanInteraction?.();
-      instance.clearHighlight?.();
-    };
-    const handleMouseMove = event => {
-      const closestPoint = getClosestPoint(event);
+
+    // Clean the interaction when the mouse leaves the chart.
+    const moveEndHandler = instance.addInteractionListener('moveEnd', event => {
+      if (!event.detail.activeGestures.pan) {
+        instance.cleanInteraction?.();
+        instance.clearHighlight?.();
+      }
+    });
+    const panEndHandler = instance.addInteractionListener('panEnd', event => {
+      if (!event.detail.activeGestures.move) {
+        instance.cleanInteraction?.();
+        instance.clearHighlight?.();
+      }
+    });
+    const pressEndHandler = instance.addInteractionListener('quickPressEnd', event => {
+      if (!event.detail.activeGestures.move && !event.detail.activeGestures.pan) {
+        instance.cleanInteraction?.();
+        instance.clearHighlight?.();
+      }
+    });
+    const gestureHandler = event => {
+      const closestPoint = getClosestPoint(event.detail.srcEvent);
       if (closestPoint === 'outside-chart') {
         instance.cleanInteraction?.();
         instance.clearHighlight?.();
@@ -160,32 +178,31 @@ export const useChartVoronoi = ({
         dataIndex
       });
     };
-    const handleMouseClick = event => {
-      if (!onItemClick) {
-        return;
-      }
-      const closestPoint = getClosestPoint(event);
-      if (typeof closestPoint === 'string') {
-        // No point fond for any reason
-        return;
+    const tapHandler = instance.addInteractionListener('tap', event => {
+      const closestPoint = getClosestPoint(event.detail.srcEvent);
+      if (typeof closestPoint !== 'string' && onItemClick) {
+        const {
+          seriesId,
+          dataIndex
+        } = closestPoint;
+        onItemClick(event.detail.srcEvent, {
+          type: 'scatter',
+          seriesId,
+          dataIndex
+        });
       }
-      const {
-        seriesId,
-        dataIndex
-      } = closestPoint;
-      onItemClick(event, {
-        type: 'scatter',
-        seriesId,
-        dataIndex
-      });
-    };
-    element.addEventListener('pointerleave', handleMouseLeave);
-    element.addEventListener('pointermove', handleMouseMove);
-    element.addEventListener('click', handleMouseClick);
+    });
+    const moveHandler = instance.addInteractionListener('move', gestureHandler);
+    const panHandler = instance.addInteractionListener('pan', gestureHandler);
+    const pressHandler = instance.addInteractionListener('quickPress', gestureHandler);
     return () => {
-      element.removeEventListener('pointerleave', handleMouseLeave);
-      element.removeEventListener('pointermove', handleMouseMove);
-      element.removeEventListener('click', handleMouseClick);
+      tapHandler.cleanup();
+      moveHandler.cleanup();
+      moveEndHandler.cleanup();
+      panHandler.cleanup();
+      panEndHandler.cleanup();
+      pressHandler.cleanup();
+      pressEndHandler.cleanup();
     };
   }, [svgRef, yAxis, xAxis, voronoiMaxRadius, onItemClick, disableVoronoi, drawingArea, instance]);
 

package/esm/internals/plugins/featurePlugins/useChartVoronoi/useChartVoronoi.selectors.d.ts

@@ -1,4 +1,4 @@
-export declare const selectorChartsVoronoiIsVoronoiEnabled: import("reselect").Selector<import("../../corePlugins/useChartId/useChartId.types.js").UseChartIdState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.js").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.js").UseChartSeriesState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.js").UseChartAnimationState & import("./useChartVoronoi.types.js").UseChartVoronoiState & Partial<{}> & {
+export declare const selectorChartsVoronoiIsVoronoiEnabled: import("reselect").Selector<import("../../corePlugins/useChartId/useChartId.types.js").UseChartIdState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.js").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.js").UseChartSeriesState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.js").UseChartAnimationState & import("../../../index.js").UseChartInteractionListenerState & import("./useChartVoronoi.types.js").UseChartVoronoiState & Partial<{}> & {
   cacheKey: import("../../models/index.js").ChartStateCacheKey;
 } & {
   cacheKey: import("../../models/index.js").ChartStateCacheKey;

package/esm/internals/plugins/featurePlugins/useChartZAxis/useChartZAxis.selectors.d.ts

@@ -1,4 +1,4 @@
-export declare const selectorChartZAxis: import("reselect").Selector<import("../../corePlugins/useChartId/useChartId.types.js").UseChartIdState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.js").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.js").UseChartSeriesState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.js").UseChartAnimationState & import("./useChartZAxis.types.js").UseChartZAxisState & Partial<{}> & {
+export declare const selectorChartZAxis: import("reselect").Selector<import("../../corePlugins/useChartId/useChartId.types.js").UseChartIdState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.js").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.js").UseChartSeriesState<keyof import("../../../index.js").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.js").UseChartAnimationState & import("../../../index.js").UseChartInteractionListenerState & import("./useChartZAxis.types.js").UseChartZAxisState & Partial<{}> & {
   cacheKey: import("../../models/index.js").ChartStateCacheKey;
 } & {
   cacheKey: import("../../models/index.js").ChartStateCacheKey;

package/esm/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, ...TSignatures]> & UseChartInteractionState;
+    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;
     publicAPI: ChartPublicAPI<TSignatures>;
     instance: ChartInstance<TSignatures>;
     svgRef: React.RefObject<SVGSVGElement | null>;

package/esm/locales/elGR.d.ts

@@ -0,0 +1,19 @@
+import { ChartsLocaleText } from "./utils/chartsLocaleTextApi.js";
+export declare const elGRLocaleText: Partial<ChartsLocaleText>;
+export declare const elGR: {
+  components: {
+    MuiChartsLocalizationProvider: {
+      defaultProps: {
+        localeText: {
+          loading?: string | undefined;
+          noData?: string | undefined;
+          zoomIn?: string | undefined;
+          zoomOut?: string | undefined;
+          toolbarExport?: string | undefined;
+          toolbarExportPrint?: string | undefined;
+          toolbarExportImage?: ((mimeType: import("./utils/imageMimeTypes.js").ChartImageExportMimeType | (string & {})) => string) | undefined;
+        };
+      };
+    };
+  };
+};

package/esm/locales/elGR.js

@@ -0,0 +1,15 @@
+import { imageMimeTypes } from "./utils/imageMimeTypes.js";
+import { getChartsLocalization } from "./utils/getChartsLocalization.js";
+export const elGRLocaleText = {
+  // Overlay
+  loading: 'Φόρτωση δεδομένων…',
+  noData: 'Δεν υπάρχουν δεδομένα για εμφάνιση',
+  // Toolbar
+  zoomIn: 'Μεγέθυνση',
+  zoomOut: 'Σμίκρυνση',
+  toolbarExport: 'Εξαγωγή',
+  // Toolbar Export Menu
+  toolbarExportPrint: 'Εκτύπωση',
+  toolbarExportImage: mimeType => `Εξαγωγή ως ${imageMimeTypes[mimeType] ?? mimeType}`
+};
+export const elGR = getChartsLocalization(elGRLocaleText);

package/esm/locales/enUS.d.ts

@@ -10,6 +10,9 @@ export declare const enUS: {
           noData?: string | undefined;
           zoomIn?: string | undefined;
           zoomOut?: string | undefined;
+          toolbarExport?: string | undefined;
+          toolbarExportPrint?: string | undefined;
+          toolbarExportImage?: ((mimeType: import("./utils/imageMimeTypes.js").ChartImageExportMimeType | (string & {})) => string) | undefined;
         };
       };
     };

package/esm/locales/enUS.js

@@ -1,13 +1,19 @@
+import { imageMimeTypes } from "./utils/imageMimeTypes.js";
 import { getChartsLocalization } from "./utils/getChartsLocalization.js";
 
 // This object is not Partial<ChartsLocaleText> because it is the default values
 
 export const enUSLocaleText = {
-  // Overlay
+  /* Overlay */
   loading: 'Loading data…',
   noData: 'No data to display',
+  /* Toolbar */
   zoomIn: 'Zoom in',
-  zoomOut: 'Zoom out'
+  zoomOut: 'Zoom out',
+  toolbarExport: 'Export',
+  /* Toolbar Export Menu */
+  toolbarExportPrint: 'Print',
+  toolbarExportImage: mimeType => `Export as ${imageMimeTypes[mimeType] ?? mimeType}`
 };
 export const DEFAULT_LOCALE = enUSLocaleText;
 export const enUS = getChartsLocalization(enUSLocaleText);

package/esm/locales/frFR.d.ts

@@ -9,6 +9,9 @@ export declare const frFR: {
           noData?: string | undefined;
           zoomIn?: string | undefined;
           zoomOut?: string | undefined;
+          toolbarExport?: string | undefined;
+          toolbarExportPrint?: string | undefined;
+          toolbarExportImage?: ((mimeType: import("./utils/imageMimeTypes.js").ChartImageExportMimeType | (string & {})) => string) | undefined;
         };
       };
     };

package/esm/locales/frFR.js

@@ -3,7 +3,14 @@ export const frFRLocalText = {
   // Overlay
   loading: 'Chargement…',
   noData: 'Pas de données'
+
+  // Toolbar
   // zoomIn: 'Zoom in',
   // zoomOut: 'Zoom out',
+  // toolbarExport: 'Export',
+
+  // Toolbar Export Menu
+  // toolbarExportPrint: 'Print',
+  // toolbarExportImage: mimeType => `Export as ${imageMimeTypes[mimeType] ?? mimeType}`,
 };
 export const frFR = getChartsLocalization(frFRLocalText);

package/esm/locales/index.d.ts

@@ -1,4 +1,5 @@
 export type { ChartsLocaleText } from "./utils/chartsLocaleTextApi.js";
+export * from "./elGR.js";
 export * from "./enUS.js";
 export * from "./frFR.js";
 export * from "./ptBR.js";

package/esm/locales/index.js

@@ -1,3 +1,4 @@
+export * from "./elGR.js";
 export * from "./enUS.js";
 export * from "./frFR.js";
 export * from "./ptBR.js";

package/esm/locales/ptBR.d.ts

@@ -9,6 +9,9 @@ export declare const ptBR: {
           noData?: string | undefined;
           zoomIn?: string | undefined;
           zoomOut?: string | undefined;
+          toolbarExport?: string | undefined;
+          toolbarExportPrint?: string | undefined;
+          toolbarExportImage?: ((mimeType: import("./utils/imageMimeTypes.js").ChartImageExportMimeType | (string & {})) => string) | undefined;
         };
       };
     };

package/esm/locales/ptBR.js

@@ -1,9 +1,15 @@
+import { imageMimeTypes } from "./utils/imageMimeTypes.js";
 import { getChartsLocalization } from "./utils/getChartsLocalization.js";
 export const ptBRLocaleText = {
   // Overlay
   loading: 'Carregando dados…',
   noData: 'Sem dados para exibir',
+  // Toolbar
   zoomIn: 'Aumentar zoom',
-  zoomOut: 'Diminuir zoom'
+  zoomOut: 'Diminuir zoom',
+  toolbarExport: 'Exportar',
+  // Toolbar Export Menu
+  toolbarExportPrint: 'Imprimir',
+  toolbarExportImage: mimeType => `Exportar como ${imageMimeTypes[mimeType] ?? mimeType}`
 };
 export const ptBR = getChartsLocalization(ptBRLocaleText);

package/esm/locales/ptPT.d.ts

@@ -9,6 +9,9 @@ export declare const ptPT: {
           noData?: string | undefined;
           zoomIn?: string | undefined;
           zoomOut?: string | undefined;
+          toolbarExport?: string | undefined;
+          toolbarExportPrint?: string | undefined;
+          toolbarExportImage?: ((mimeType: import("./utils/imageMimeTypes.js").ChartImageExportMimeType | (string & {})) => string) | undefined;
         };
       };
     };

package/esm/locales/ptPT.js

@@ -1,9 +1,15 @@
+import { imageMimeTypes } from "./utils/imageMimeTypes.js";
 import { getChartsLocalization } from "./utils/getChartsLocalization.js";
 export const ptPTLocaleText = {
   // Overlay
   loading: 'Carregando dados…',
   noData: 'Sem dados para mostrar',
+  // Toolbar
   zoomIn: 'Aumentar zoom',
-  zoomOut: 'Diminuir zoom'
+  zoomOut: 'Diminuir zoom',
+  toolbarExport: 'Exportar',
+  // Toolbar Export Menu
+  toolbarExportPrint: 'Imprimir',
+  toolbarExportImage: mimeType => `Exportar como ${imageMimeTypes[mimeType] ?? mimeType}`
 };
 export const ptPT = getChartsLocalization(ptPTLocaleText);

package/esm/locales/utils/chartsLocaleTextApi.d.ts

@@ -1,3 +1,4 @@
+import { ChartImageExportMimeType } from "./imageMimeTypes.js";
 export interface ChartsLocaleText {
   /**
    * Title displayed in the overlay if `loading` is `true`.
@@ -15,5 +16,21 @@ export interface ChartsLocaleText {
    * Tooltip text shown when hovering over the zoom out button.
    */
   zoomOut: string;
+  /**
+   * Text for the export button tooltip in the toolbar.
+   */
+  toolbarExport: string;
+  /**
+   * Text for the print button in the toolbar's export menu.
+   */
+  toolbarExportPrint: string;
+  /**
+   * Text for an "Export as {image type}" button in the toolbar's export menu.
+   * The only format supported in all browsers is 'image/png'.
+   *
+   * @param {string} mimeType The MIME type of the image to export, e.g., 'image/png'.
+   * @returns {string} The localized string for an export image button.
+   */
+  toolbarExportImage: (mimeType: ChartImageExportMimeType | (string & {})) => string;
 }
 export type ChartsTranslationKeys = keyof ChartsLocaleText;

package/esm/locales/utils/getChartsLocalization.d.ts

@@ -13,6 +13,9 @@ export declare const getChartsLocalization: (chartsTranslations: Partial<ChartsL
           noData?: string | undefined;
           zoomIn?: string | undefined;
           zoomOut?: string | undefined;
+          toolbarExport?: string | undefined;
+          toolbarExportPrint?: string | undefined;
+          toolbarExportImage?: ((mimeType: import("./imageMimeTypes.js").ChartImageExportMimeType | (string & {})) => string) | undefined;
         };
       };
     };

package/esm/locales/utils/imageMimeTypes.d.ts

@@ -0,0 +1,2 @@
+export declare const imageMimeTypes: Record<string, string | undefined>;
+export type ChartImageExportMimeType = 'image/png' | 'image/jpeg' | 'image/webp';

package/esm/locales/utils/imageMimeTypes.js

@@ -0,0 +1,5 @@
+export const imageMimeTypes = {
+  'image/png': 'PNG',
+  'image/jpeg': 'JPEG',
+  'image/webp': 'WebP'
+};

package/esm/models/slots/chartsBaseSlotProps.d.ts

@@ -7,14 +7,18 @@ export type ChartBaseCommonProps<T = HTMLElement> = React.DOMAttributes<T> & {
 };
 export type ChartBaseIconProps = ChartBaseCommonProps<SVGSVGElement> & {
   titleAccess?: string;
+  fontSize?: 'small' | 'medium' | 'large' | 'inherit';
 };
 export type ChartBaseButtonProps = ChartBaseCommonProps & {
   ref?: React.Ref<HTMLButtonElement>;
+  id?: string;
   disabled?: boolean;
   tabIndex?: number;
 };
 export type ChartBaseIconButtonProps = ChartBaseCommonProps & {
   ref?: React.Ref<HTMLButtonElement>;
+  id?: string;
   disabled?: boolean;
   tabIndex?: number;
+  size?: 'small' | 'medium' | 'large';
 };

package/hooks/useInteractionItemProps.d.ts

@@ -1,16 +1,21 @@
 import * as React from 'react';
 import { SeriesItemIdentifier } from "../models/index.js";
+import { UseChartHighlightSignature } from "../internals/plugins/featurePlugins/useChartHighlight/index.js";
+import { UseChartInteractionSignature } from "../internals/plugins/featurePlugins/useChartInteraction/index.js";
+import { ChartItemIdentifier, ChartSeriesType } from "../models/seriesType/config.js";
+import { ChartInstance } from "../internals/plugins/models/index.js";
 export declare const useInteractionItemProps: (data: SeriesItemIdentifier, skip?: boolean) => {
   onPointerEnter?: () => void;
   onPointerLeave?: () => void;
   onPointerDown?: (event: React.PointerEvent) => void;
 };
-export declare const useInteractionAllItemProps: (data: SeriesItemIdentifier[], skip?: boolean) => ({
-  onPointerEnter?: undefined;
-  onPointerLeave?: undefined;
-  onPointerDown?: undefined;
-} | {
-  onPointerEnter: () => void;
-  onPointerLeave: () => void;
-  onPointerDown: (event: React.PointerEvent) => void;
-})[];
+export declare const useInteractionAllItemProps: (data: SeriesItemIdentifier[], skip?: boolean) => {
+  onPointerEnter?: () => void;
+  onPointerLeave?: () => void;
+  onPointerDown?: (event: React.PointerEvent) => void;
+}[];
+export declare function getInteractionItemProps(instance: ChartInstance<[UseChartInteractionSignature, UseChartHighlightSignature]>, item: ChartItemIdentifier<ChartSeriesType>): {
+  onPointerEnter?: () => void;
+  onPointerLeave?: () => void;
+  onPointerDown?: (event: React.PointerEvent) => void;
+};

package/hooks/useInteractionItemProps.js

@@ -5,14 +5,15 @@ var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWild
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.getInteractionItemProps = getInteractionItemProps;
 exports.useInteractionItemProps = exports.useInteractionAllItemProps = void 0;
 var React = _interopRequireWildcard(require("react"));
 var _ChartProvider = require("../context/ChartProvider");
-const onPointerDown = event => {
+function onPointerDown(event) {
   if ('hasPointerCapture' in event.currentTarget && event.currentTarget.hasPointerCapture(event.pointerId)) {
     event.currentTarget.releasePointerCapture(event.pointerId);
   }
-};
+}
 const useInteractionItemProps = (data, skip) => {
   const {
     instance
@@ -63,33 +64,33 @@ const useInteractionAllItemProps = (data, skip) => {
   } = (0, _ChartProvider.useChartContext)();
   const results = React.useMemo(() => {
     return data.map(item => {
-      if (skip) {
-        return {};
-      }
-      const onPointerEnter = () => {
-        if (!item) {
-          return;
-        }
-        instance.setItemInteraction(item);
-        instance.setHighlight({
-          seriesId: item.seriesId,
-          dataIndex: item.dataIndex
-        });
-      };
-      const onPointerLeave = () => {
-        if (!item) {
-          return;
-        }
-        instance.removeItemInteraction(item);
-        instance.clearHighlight();
-      };
-      return {
-        onPointerEnter,
-        onPointerLeave,
-        onPointerDown
-      };
+      return skip ? {} : getInteractionItemProps(instance, item);
     });
   }, [data, instance, skip]);
   return results;
 };
-exports.useInteractionAllItemProps = useInteractionAllItemProps;
+exports.useInteractionAllItemProps = useInteractionAllItemProps;
+function getInteractionItemProps(instance, item) {
+  function onPointerEnter() {
+    if (!item) {
+      return;
+    }
+    instance.setItemInteraction(item);
+    instance.setHighlight({
+      seriesId: item.seriesId,
+      dataIndex: item.dataIndex
+    });
+  }
+  function onPointerLeave() {
+    if (!item) {
+      return;
+    }
+    instance.removeItemInteraction(item);
+    instance.clearHighlight();
+  }
+  return {
+    onPointerEnter,
+    onPointerLeave,
+    onPointerDown
+  };
+}

package/index.d.ts

@@ -23,6 +23,7 @@ export * from "./SparkLineChart/index.js";
 export * from "./Gauge/index.js";
 export * from "./RadarChart/index.js";
 export * from "./ChartsSurface/index.js";
-export * from "./ChartContainer/index.js";
+export { ChartContainer } from "./ChartContainer/index.js";
+export type { ChartContainerProps } from "./ChartContainer/index.js";
 export * from "./ChartDataProvider/index.js";
 export * from "./Toolbar/index.js";