@mui/x-charts-pro 8.0.0-alpha.9 → 8.0.0-beta.0

package/FunnelChart/FunnelChart.js

@@ -0,0 +1,218 @@
+"use strict";
+'use client';
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FunnelChart = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var React = _interopRequireWildcard(require("react"));
+var _styles = require("@mui/material/styles");
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _ChartsOverlay = require("@mui/x-charts/ChartsOverlay");
+var _ChartsTooltip = require("@mui/x-charts/ChartsTooltip");
+var _internals = require("@mui/x-charts/internals");
+var _ChartsLegend = require("@mui/x-charts/ChartsLegend");
+var _ChartsClipPath = require("@mui/x-charts/ChartsClipPath");
+var _ChartsSurface = require("@mui/x-charts/ChartsSurface");
+var _ChartsAxisHighlight = require("@mui/x-charts/ChartsAxisHighlight");
+var _ChartsAxis = require("@mui/x-charts/ChartsAxis");
+var _FunnelPlot = require("./FunnelPlot");
+var _useFunnelChartProps = require("./useFunnelChartProps");
+var _seriesConfig = require("./seriesConfig");
+var _useChartContainerProProps = require("../ChartContainerPro/useChartContainerProProps");
+var _ChartDataProviderPro = require("../ChartDataProviderPro");
+var _jsxRuntime = require("react/jsx-runtime");
+const seriesConfig = {
+  funnel: _seriesConfig.seriesConfig
+};
+const FunnelChart = exports.FunnelChart = /*#__PURE__*/React.forwardRef(function FunnelChart(props, ref) {
+  const themedProps = (0, _styles.useThemeProps)({
+    props,
+    name: 'MuiFunnelChart'
+  });
+  const {
+    chartContainerProps,
+    funnelPlotProps,
+    overlayProps,
+    legendProps,
+    clipPathGroupProps,
+    chartsAxisProps,
+    clipPathProps,
+    chartsWrapperProps,
+    axisHighlightProps,
+    children
+  } = (0, _useFunnelChartProps.useFunnelChartProps)(themedProps);
+  const {
+    chartDataProviderProProps,
+    chartsSurfaceProps
+  } = (0, _useChartContainerProProps.useChartContainerProProps)(chartContainerProps, ref);
+  const Tooltip = themedProps.slots?.tooltip ?? _ChartsTooltip.ChartsTooltip;
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_ChartDataProviderPro.ChartDataProviderPro, (0, _extends2.default)({}, chartDataProviderProProps, {
+    seriesConfig: seriesConfig,
+    children: /*#__PURE__*/(0, _jsxRuntime.jsxs)(_internals.ChartsWrapper, (0, _extends2.default)({}, chartsWrapperProps, {
+      children: [!themedProps.hideLegend && /*#__PURE__*/(0, _jsxRuntime.jsx)(_ChartsLegend.ChartsLegend, (0, _extends2.default)({}, legendProps)), /*#__PURE__*/(0, _jsxRuntime.jsxs)(_ChartsSurface.ChartsSurface, (0, _extends2.default)({}, chartsSurfaceProps, {
+        children: [/*#__PURE__*/(0, _jsxRuntime.jsxs)("g", (0, _extends2.default)({}, clipPathGroupProps, {
+          children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_FunnelPlot.FunnelPlot, (0, _extends2.default)({}, funnelPlotProps)), /*#__PURE__*/(0, _jsxRuntime.jsx)(_ChartsOverlay.ChartsOverlay, (0, _extends2.default)({}, overlayProps)), /*#__PURE__*/(0, _jsxRuntime.jsx)(_ChartsAxisHighlight.ChartsAxisHighlight, (0, _extends2.default)({}, axisHighlightProps))]
+        })), !themedProps.loading && /*#__PURE__*/(0, _jsxRuntime.jsx)(Tooltip, (0, _extends2.default)({}, themedProps.slotProps?.tooltip, {
+          trigger: "item"
+        })), /*#__PURE__*/(0, _jsxRuntime.jsx)(_ChartsAxis.ChartsAxis, (0, _extends2.default)({}, chartsAxisProps)), /*#__PURE__*/(0, _jsxRuntime.jsx)(_ChartsClipPath.ChartsClipPath, (0, _extends2.default)({}, clipPathProps)), children]
+      }))]
+    }))
+  }));
+});
+process.env.NODE_ENV !== "production" ? FunnelChart.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "pnpm proptypes"  |
+  // ----------------------------------------------------------------------
+  apiRef: _propTypes.default.shape({
+    current: _propTypes.default.shape({
+      setZoomData: _propTypes.default.func.isRequired
+    })
+  }),
+  /**
+   * The configuration of axes highlight.
+   * Default is set to 'band' in the bar direction.
+   * Depends on `layout` prop.
+   * @see See {@link https://mui.com/x/react-charts/highlighting/ highlighting docs} for more details.
+   */
+  axisHighlight: _propTypes.default.shape({
+    x: _propTypes.default.oneOf(['band', 'line', 'none']),
+    y: _propTypes.default.oneOf(['band', 'line', 'none'])
+  }),
+  /**
+   * The configuration of the category axis.
+   *
+   * @default { position: 'none' }
+   */
+  categoryAxis: _propTypes.default.shape({
+    categories: _propTypes.default.arrayOf(_propTypes.default.string),
+    disableLine: _propTypes.default.bool,
+    disableTicks: _propTypes.default.bool,
+    id: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]),
+    position: _propTypes.default.oneOf(['bottom', 'left', 'none', 'right', 'top']),
+    scaleType: _propTypes.default.oneOf(['band', 'linear', 'log', 'point', 'pow', 'sqrt', 'time', 'utc']),
+    size: _propTypes.default.number,
+    tickLabelStyle: _propTypes.default.object,
+    tickSize: _propTypes.default.number
+  }),
+  children: _propTypes.default.node,
+  className: _propTypes.default.string,
+  /**
+   * Color palette used to colorize multiple series.
+   * @default rainbowSurgePalette
+   */
+  colors: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.string), _propTypes.default.func]),
+  desc: _propTypes.default.string,
+  /**
+   * If `true`, the charts will not listen to the mouse move event.
+   * It might break interactive features, but will improve performance.
+   * @default false
+   */
+  disableAxisListener: _propTypes.default.bool,
+  /**
+   * The height of the chart in px. If not defined, it takes the height of the parent element.
+   */
+  height: _propTypes.default.number,
+  /**
+   * If `true`, the legend is not rendered.
+   * @default false
+   */
+  hideLegend: _propTypes.default.bool,
+  /**
+   * The highlighted item.
+   * Used when the highlight is controlled.
+   */
+  highlightedItem: _propTypes.default.shape({
+    dataIndex: _propTypes.default.number,
+    seriesId: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]).isRequired
+  }),
+  /**
+   * This prop is used to help implement the accessibility logic.
+   * If you don't provide this prop. It falls back to a randomly generated id.
+   */
+  id: _propTypes.default.string,
+  /**
+   * The list of zoom data related to each axis.
+   * Used to initialize the zoom in a specific configuration without controlling it.
+   */
+  initialZoom: _propTypes.default.arrayOf(_propTypes.default.shape({
+    axisId: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]).isRequired,
+    end: _propTypes.default.number.isRequired,
+    start: _propTypes.default.number.isRequired
+  })),
+  /**
+   * If `true`, a loading overlay is displayed.
+   * @default false
+   */
+  loading: _propTypes.default.bool,
+  /**
+   * The margin between the SVG and the drawing area.
+   * It's used for leaving some space for extra information such as the x- and y-axis or legend.
+   *
+   * Accepts a `number` to be used on all sides or an object with the optional properties: `top`, `bottom`, `left`, and `right`.
+   */
+  margin: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.shape({
+    bottom: _propTypes.default.number,
+    left: _propTypes.default.number,
+    right: _propTypes.default.number,
+    top: _propTypes.default.number
+  })]),
+  /**
+   * The function called for onClick events.
+   * The second argument contains information about all line/bar elements at the current mouse position.
+   * @param {MouseEvent} event The mouse event recorded on the `<svg/>` element.
+   * @param {null | AxisData} data The data about the clicked axis and items associated with it.
+   */
+  onAxisClick: _propTypes.default.func,
+  /**
+   * The callback fired when the highlighted item changes.
+   *
+   * @param {HighlightItemData | null} highlightedItem  The newly highlighted item.
+   */
+  onHighlightChange: _propTypes.default.func,
+  /**
+   * Callback fired when a funnel item is clicked.
+   * @param {React.MouseEvent<SVGElement, MouseEvent>} event The event source of the callback.
+   * @param {FunnelItemIdentifier} funnelItemIdentifier The funnel item identifier.
+   */
+  onItemClick: _propTypes.default.func,
+  /**
+   * The series to display in the funnel chart.
+   * An array of [[FunnelSeriesType]] objects.
+   */
+  series: _propTypes.default.arrayOf(_propTypes.default.object).isRequired,
+  /**
+   * If `true`, animations are skipped.
+   * If unset or `false`, the animations respects the user's `prefers-reduced-motion` setting.
+   */
+  skipAnimation: _propTypes.default.bool,
+  /**
+   * The props used for each component slot.
+   * @default {}
+   */
+  slotProps: _propTypes.default.object,
+  /**
+   * Overridable component slots.
+   * @default {}
+   */
+  slots: _propTypes.default.object,
+  sx: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object, _propTypes.default.bool])), _propTypes.default.func, _propTypes.default.object]),
+  theme: _propTypes.default.oneOf(['dark', 'light']),
+  title: _propTypes.default.string,
+  /**
+   * The width of the chart in px. If not defined, it takes the width of the parent element.
+   */
+  width: _propTypes.default.number,
+  /**
+   * The list of zoom data related to each axis.
+   */
+  zoomData: _propTypes.default.arrayOf(_propTypes.default.shape({
+    axisId: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]).isRequired,
+    end: _propTypes.default.number.isRequired,
+    start: _propTypes.default.number.isRequired
+  }))
+} : void 0;

package/FunnelChart/FunnelPlot.d.ts

@@ -0,0 +1,16 @@
+import * as React from 'react';
+import { FunnelItemIdentifier } from "./funnel.types.js";
+import { FunnelPlotSlotExtension } from "./funnelPlotSlots.types.js";
+export interface FunnelPlotProps extends FunnelPlotSlotExtension {
+  /**
+   * Callback fired when a funnel item is clicked.
+   * @param {React.MouseEvent<SVGElement, MouseEvent>} event The event source of the callback.
+   * @param {FunnelItemIdentifier} funnelItemIdentifier The funnel item identifier.
+   */
+  onItemClick?: (event: React.MouseEvent<SVGElement, MouseEvent>, funnelItemIdentifier: FunnelItemIdentifier) => void;
+}
+declare function FunnelPlot(props: FunnelPlotProps): React.JSX.Element;
+declare namespace FunnelPlot {
+  var propTypes: any;
+}
+export { FunnelPlot };

package/FunnelChart/FunnelPlot.js

@@ -0,0 +1,191 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FunnelPlot = FunnelPlot;
+var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _react = _interopRequireWildcard(require("react"));
+var React = _react;
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _d3Shape = require("@mui/x-charts-vendor/d3-shape");
+var _internals = require("@mui/x-charts/internals");
+var _hooks = require("@mui/x-charts/hooks");
+var _styles = require("@mui/material/styles");
+var _FunnelSection = require("./FunnelSection");
+var _labelUtils = require("./labelUtils");
+var _funnelStepCurve = require("./funnelStepCurve");
+var _useFunnelSeries = require("../hooks/useFunnelSeries");
+var _jsxRuntime = require("react/jsx-runtime");
+const _excluded = ["onItemClick"];
+_internals.cartesianSeriesTypes.addType('funnel');
+const getFunnelCurve = (curve, isHorizontal) => {
+  if (curve === 'step') {
+    return isHorizontal ? _funnelStepCurve.funnelHorizontalStepCurve : _funnelStepCurve.funnelVerticalStepCurve;
+  }
+  if (curve === 'bump') {
+    return isHorizontal ? (0, _internals.getCurveFactory)('bumpX') : (0, _internals.getCurveFactory)('bumpY');
+  }
+  return (0, _internals.getCurveFactory)(curve ?? 'linear');
+};
+const useAggregatedData = () => {
+  const seriesData = (0, _useFunnelSeries.useFunnelSeriesContext)();
+  const {
+    xAxis,
+    xAxisIds
+  } = (0, _hooks.useXAxes)();
+  const {
+    yAxis,
+    yAxisIds
+  } = (0, _hooks.useYAxes)();
+  const allData = React.useMemo(() => {
+    if (seriesData === undefined) {
+      return [];
+    }
+    const {
+      series,
+      seriesOrder
+    } = seriesData;
+    const defaultXAxisId = xAxisIds[0];
+    const defaultYAxisId = yAxisIds[0];
+    const isHorizontal = Object.values(series).some(s => s.layout === 'horizontal');
+    const result = seriesOrder.map(seriesId => {
+      const currentSeries = series[seriesId];
+      const xAxisId = currentSeries.xAxisId ?? defaultXAxisId;
+      const yAxisId = currentSeries.yAxisId ?? defaultYAxisId;
+      const valueFormatter = currentSeries.valueFormatter;
+      const baseScaleConfig = isHorizontal ? xAxis[xAxisId] : yAxis[yAxisId];
+      const isXAxisBand = xAxis[xAxisId].scaleType === 'band';
+      const isYAxisBand = yAxis[yAxisId].scaleType === 'band';
+      const bandWidth = (isXAxisBand || isYAxisBand) && baseScaleConfig.scale?.bandwidth() || 0;
+      const xScale = xAxis[xAxisId].scale;
+      const yScale = yAxis[yAxisId].scale;
+      const curve = getFunnelCurve(currentSeries.curve, isHorizontal);
+      const xPosition = (value, bandIndex, stackOffset, useBand) => {
+        if (isXAxisBand) {
+          const position = xScale(bandIndex);
+          return useBand ? position + bandWidth : position;
+        }
+        return xScale(isHorizontal ? value + (stackOffset || 0) : value);
+      };
+      const yPosition = (value, bandIndex, stackOffset, useBand) => {
+        if (isYAxisBand) {
+          const position = yScale(bandIndex);
+          return useBand ? position + bandWidth : position;
+        }
+        return yScale(isHorizontal ? value : value + (stackOffset || 0));
+      };
+      return currentSeries.dataPoints.map((values, dataIndex) => {
+        const color = currentSeries.data[dataIndex].color;
+        const id = `${seriesId}-${dataIndex}`;
+        const sectionLabel = typeof currentSeries.sectionLabel === 'function' ? currentSeries.sectionLabel({
+          dataIndex,
+          seriesId,
+          value: currentSeries.data[dataIndex].value
+        }) : currentSeries.sectionLabel;
+        const line = (0, _d3Shape.line)().x(d => xPosition(d.x, baseScaleConfig.data?.[dataIndex], d.stackOffset, d.useBandWidth)).y(d => yPosition(d.y, baseScaleConfig.data?.[dataIndex], d.stackOffset, d.useBandWidth)).curve(curve);
+        return {
+          d: line(values),
+          color,
+          id,
+          seriesId,
+          dataIndex,
+          label: sectionLabel !== false && (0, _extends2.default)({}, (0, _labelUtils.positionLabel)((0, _extends2.default)({}, sectionLabel, {
+            xPosition,
+            yPosition,
+            isHorizontal,
+            values,
+            dataIndex,
+            baseScaleData: baseScaleConfig.data ?? []
+          })), (0, _labelUtils.alignLabel)(sectionLabel ?? {}), {
+            value: valueFormatter ? valueFormatter(currentSeries.data[dataIndex], {
+              dataIndex
+            }) : currentSeries.data[dataIndex].value?.toLocaleString()
+          })
+        };
+      });
+    });
+    return result.flat();
+  }, [seriesData, xAxis, xAxisIds, yAxis, yAxisIds]);
+  return allData;
+};
+function FunnelPlot(props) {
+  const {
+      onItemClick
+    } = props,
+    other = (0, _objectWithoutPropertiesLoose2.default)(props, _excluded);
+  const theme = (0, _styles.useTheme)();
+  const data = useAggregatedData();
+  return /*#__PURE__*/(0, _jsxRuntime.jsxs)(React.Fragment, {
+    children: [data.map(({
+      d,
+      color,
+      id,
+      seriesId,
+      dataIndex
+    }) => /*#__PURE__*/(0, _react.createElement)(_FunnelSection.FunnelSection, (0, _extends2.default)({}, other, {
+      d: d,
+      color: color,
+      key: id,
+      dataIndex: dataIndex,
+      seriesId: seriesId,
+      onClick: onItemClick && (event => {
+        onItemClick(event, {
+          type: 'funnel',
+          seriesId,
+          dataIndex
+        });
+      })
+    }))), data.map(({
+      id,
+      label
+    }) => {
+      if (!label) {
+        return null;
+      }
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)("text", {
+        x: label.x,
+        y: label.y,
+        textAnchor: label.textAnchor,
+        dominantBaseline: label.dominantBaseline,
+        stroke: "none",
+        pointerEvents: "none",
+        fontFamily: theme.typography.body2.fontFamily,
+        fontSize: theme.typography.body2.fontSize,
+        fontSizeAdjust: theme.typography.body2.fontSizeAdjust,
+        fontWeight: theme.typography.body2.fontWeight,
+        letterSpacing: theme.typography.body2.letterSpacing,
+        fontStretch: theme.typography.body2.fontStretch,
+        fontStyle: theme.typography.body2.fontStyle,
+        fontVariant: theme.typography.body2.fontVariant,
+        fill: (theme.vars || theme)?.palette?.text?.primary,
+        children: label.value
+      }, id);
+    })]
+  });
+}
+process.env.NODE_ENV !== "production" ? FunnelPlot.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "pnpm proptypes"  |
+  // ----------------------------------------------------------------------
+  /**
+   * Callback fired when a funnel item is clicked.
+   * @param {React.MouseEvent<SVGElement, MouseEvent>} event The event source of the callback.
+   * @param {FunnelItemIdentifier} funnelItemIdentifier The funnel item identifier.
+   */
+  onItemClick: _propTypes.default.func,
+  /**
+   * The props used for each component slot.
+   * @default {}
+   */
+  slotProps: _propTypes.default.object,
+  /**
+   * Overridable component slots.
+   * @default {}
+   */
+  slots: _propTypes.default.object
+} : void 0;

package/FunnelChart/FunnelSection.d.ts

@@ -0,0 +1,15 @@
+import * as React from 'react';
+import { SeriesId } from '@mui/x-charts/internals';
+import { FunnelSectionClasses } from "./funnelSectionClasses.js";
+export interface FunnelSectionProps extends Omit<React.SVGProps<SVGPathElement>, 'ref' | 'id'> {
+  seriesId: SeriesId;
+  dataIndex: number;
+  color: string;
+  classes?: Partial<FunnelSectionClasses>;
+}
+export declare const FunnelSectionPath: import("@emotion/styled").StyledComponent<import("@mui/system").MUIStyledCommonProps<import("@mui/material").Theme>, React.SVGProps<SVGPathElement>, {}>;
+/**
+ * @ignore - internal component.
+ */
+declare const FunnelSection: React.ForwardRefExoticComponent<FunnelSectionProps & React.RefAttributes<{}>>;
+export { FunnelSection };

package/FunnelChart/FunnelSection.js

@@ -0,0 +1,62 @@
+"use strict";
+'use client';
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FunnelSectionPath = exports.FunnelSection = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
+var React = _interopRequireWildcard(require("react"));
+var _styles = require("@mui/material/styles");
+var _internals = require("@mui/x-charts/internals");
+var _hooks = require("@mui/x-charts/hooks");
+var _clsx = _interopRequireDefault(require("clsx"));
+var _funnelSectionClasses = require("./funnelSectionClasses");
+var _jsxRuntime = require("react/jsx-runtime");
+const _excluded = ["seriesId", "dataIndex", "classes", "color", "onClick", "className"];
+const FunnelSectionPath = exports.FunnelSectionPath = (0, _styles.styled)('path')(() => ({
+  transition: 'opacity 0.2s ease-in, fill 0.2s ease-in'
+}));
+
+/**
+ * @ignore - internal component.
+ */
+const FunnelSection = exports.FunnelSection = (0, _internals.consumeSlots)('MuiFunnelSection', 'funnelSection', {
+  classesResolver: _funnelSectionClasses.useUtilityClasses
+}, /*#__PURE__*/React.forwardRef(function FunnelSection(props, ref) {
+  const {
+      seriesId,
+      dataIndex,
+      classes,
+      color,
+      onClick,
+      className
+    } = props,
+    other = (0, _objectWithoutPropertiesLoose2.default)(props, _excluded);
+  const interactionProps = (0, _internals.useInteractionItemProps)({
+    type: 'funnel',
+    seriesId,
+    dataIndex
+  });
+  const {
+    isFaded,
+    isHighlighted
+  } = (0, _hooks.useItemHighlighted)({
+    seriesId,
+    dataIndex
+  });
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(FunnelSectionPath, (0, _extends2.default)({}, interactionProps, {
+    filter: isHighlighted ? 'brightness(120%)' : undefined,
+    opacity: isFaded ? 0.3 : 1,
+    fill: color,
+    stroke: "none",
+    cursor: onClick ? 'pointer' : 'unset',
+    onClick: onClick,
+    className: (0, _clsx.default)(classes?.root, className, isHighlighted && classes?.highlighted, isFaded && classes?.faded)
+  }, other, {
+    ref: ref
+  }));
+}));

package/FunnelChart/categoryAxis.types.d.ts

@@ -0,0 +1,24 @@
+import { AxisConfig, ScaleName } from '@mui/x-charts/models';
+import { MakeOptional } from '@mui/x-internals/types';
+export type CategoryAxis = {
+  /**
+   * The categories to be displayed on the axis.
+   * The order of the categories is the order in which they are displayed.
+   */
+  categories?: string[];
+  /**
+   * The position of the axis.
+   * - 'left' - The axis is positioned on the left side of the chart.
+   * - 'right' - The axis is positioned on the right side of the chart.
+   * - 'top' - The axis is positioned on the top side of the chart.
+   * - 'bottom' - The axis is positioned on the bottom side of the chart.
+   * - 'none' - The axis is not displayed.
+   */
+  position?: 'left' | 'right' | 'top' | 'bottom' | 'none';
+  /**
+   * The size of the axis.
+   * - If the axis is horizontal, the size is the height of the axis.
+   * - If the axis is vertical, the size is the width of the axis.
+   */
+  size?: number;
+} & MakeOptional<Pick<AxisConfig<ScaleName, any>, 'disableLine' | 'disableTicks' | 'scaleType' | 'tickLabelStyle' | 'tickSize' | 'id'>, 'id'>;

package/FunnelChart/funnel.types.d.ts

@@ -0,0 +1,124 @@
+import { ChartsLabelMarkProps } from '@mui/x-charts/ChartsLabel';
+import { CommonSeriesType, CartesianSeriesType, CommonDefaultizedProps, SeriesId } from '@mui/x-charts/internals';
+import { CurveType, Position } from '@mui/x-charts/models';
+import { DefaultizedProps, MakeRequired } from '@mui/x-internals/types';
+export type FunnelItemId = string | number;
+export type FunnelCurveType = Extract<CurveType, 'linear' | 'step'> | 'bump';
+export type FunnelValueType = {
+  /**
+   * A unique identifier of the funnel section.
+   */
+  id?: FunnelItemId;
+  /**
+   * The value of the funnel section.
+   */
+  value: number;
+  /**
+   * The label to display on the tooltip, funnel section, or the legend. It can be a string or a function.
+   */
+  label?: string | ((location: 'tooltip' | 'legend' | 'section') => string);
+  /**
+   * The color of the funnel section
+   */
+  color?: string;
+  /**
+   * Defines the mark type for the funnel item.
+   * @default 'square'
+   */
+  labelMarkType?: ChartsLabelMarkProps['type'];
+};
+export interface FunnelSeriesType extends Omit<CommonSeriesType<FunnelValueType>, 'color'>, CartesianSeriesType {
+  type: 'funnel';
+  /**
+   * Data associated to the funnel section.
+   */
+  data: Readonly<FunnelValueType[]>;
+  /**
+   * The label to display on the tooltip or the legend. It can be a string or a function.
+   */
+  label?: string | ((location: 'tooltip' | 'legend') => string);
+  /**
+   * Layout of the funnel.
+   * @default 'vertical'
+   */
+  layout?: 'horizontal' | 'vertical';
+  /**
+   * The type of curve to use for the line. Read more about curves at
+   * [line interpolation](https://mui.com/x/react-charts/lines/#interpolation).
+   * @default 'linear'
+   */
+  curve?: FunnelCurveType;
+  /**
+   * The label configuration for the funnel plot.
+   * Allows to customize the position and margin of the label that is displayed on the funnel sections.
+   *
+   * If set to `false`, the label will not be displayed.
+   * @default { vertical: 'middle', horizontal: 'center' }
+   */
+  sectionLabel?: FunnelLabelOptions | ((item: FunnelItem) => FunnelLabelOptions | false) | false;
+}
+/**
+ * An object that allows to identify a funnel item.
+ * Used for item interaction
+ */
+export type FunnelItemIdentifier = {
+  type: 'funnel';
+  /**
+   * The series id of the funnel.
+   */
+  seriesId: SeriesId;
+  /**
+   * The index of the data point in the series.
+   */
+  dataIndex: number;
+};
+export type FunnelItem = {
+  /**
+   * The series id of the funnel.
+   */
+  seriesId: SeriesId;
+  /**
+   * The index of the data point in the series.
+   */
+  dataIndex: number;
+  /**
+   * The value of the data point.
+   */
+  value: number;
+};
+export interface DefaultizedFunnelSeriesType extends DefaultizedProps<FunnelSeriesType, CommonDefaultizedProps | 'layout'> {
+  dataPoints: FunnelDataPoints[][];
+  data: Readonly<MakeRequired<FunnelValueType, 'id' | 'color'>[]>;
+}
+export type FunnelDataPoints = Record<'x' | 'y', number> & {
+  useBandWidth: boolean;
+  stackOffset: number;
+};
+export type FunnelLabelOptions = {
+  /**
+   * The position of the label.
+   * @default { vertical: 'middle', horizontal: 'center' }
+   */
+  position?: Position;
+  /**
+   * The text anchor of the label. Affects the horizontal alignment of the text.
+   *
+   * Default value depends on the position.
+   */
+  textAnchor?: 'start' | 'middle' | 'end';
+  /**
+   * The dominant baseline of the label. Affects the vertical alignment of the text.
+   *
+   * Default value depends on the position.
+   */
+  dominantBaseline?: 'auto' | 'baseline' | 'hanging' | 'middle' | 'central' | 'text-after-edge' | 'text-before-edge';
+  /**
+   * The offset of the label from the anchor point.
+   * If a single number is provided, the offset will be applied in both directions.
+   * @default 0
+   */
+  offset?: number | {
+    x?: number;
+    y?: number;
+  };
+};

package/FunnelChart/funnelPlotSlots.types.d.ts

@@ -0,0 +1,20 @@
+import * as React from 'react';
+import type { FunnelSectionProps } from './FunnelSection';
+export interface FunnelPlotSlots {
+  funnelSection?: React.ElementType<FunnelSectionProps>;
+}
+export interface FunnelPlotSlotProps {
+  funnelSection?: FunnelSectionProps;
+}
+export interface FunnelPlotSlotExtension {
+  /**
+   * Overridable component slots.
+   * @default {}
+   */
+  slots?: FunnelPlotSlots;
+  /**
+   * The props used for each component slot.
+   * @default {}
+   */
+  slotProps?: FunnelPlotSlotProps;
+}