@mui/x-charts 8.9.2 → 8.10.0

package/esm/ChartsXAxis/ChartsGroupedXAxis.js

@@ -0,0 +1,136 @@
+'use client';
+
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import { useDrawingArea } from "../hooks/useDrawingArea.js";
+import { isBandScale } from "../internals/isBandScale.js";
+import { useChartContext } from "../context/ChartProvider/useChartContext.js";
+import { TICK_LABEL_GAP, XAxisRoot } from "./utilities.js";
+import { useTicksGrouped } from "../hooks/useTicksGrouped.js";
+import { useAxisProps } from "./useAxisProps.js";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+const DEFAULT_GROUPING_CONFIG = {
+  tickSize: 6
+};
+const getGroupingConfig = (groups, groupIndex, tickSize) => {
+  const config = groups[groupIndex] ?? {};
+  const defaultTickSize = tickSize ?? DEFAULT_GROUPING_CONFIG.tickSize;
+  const calculatedTickSize = defaultTickSize * groupIndex * 2 + defaultTickSize;
+  return _extends({}, DEFAULT_GROUPING_CONFIG, config, {
+    tickSize: config.tickSize ?? calculatedTickSize
+  });
+};
+
+/**
+ * @ignore - internal component.
+ */
+function ChartsGroupedXAxis(inProps) {
+  const {
+    xScale,
+    defaultizedProps,
+    tickNumber,
+    positionSign,
+    skipAxisRendering,
+    classes,
+    Line,
+    Tick,
+    TickLabel,
+    Label,
+    axisTickLabelProps,
+    axisLabelProps
+  } = useAxisProps(inProps);
+  if (!isBandScale(xScale)) {
+    throw new Error('MUI X Charts: ChartsGroupedXAxis only supports the `band` and `point` scale types.');
+  }
+  const {
+    position,
+    disableLine,
+    disableTicks,
+    label,
+    tickSize,
+    valueFormatter,
+    slotProps,
+    tickInterval,
+    tickPlacement,
+    tickLabelPlacement,
+    sx,
+    offset,
+    height: axisHeight
+  } = defaultizedProps;
+  const groups = defaultizedProps.groups;
+  const drawingArea = useDrawingArea();
+  const {
+    left,
+    top,
+    width,
+    height
+  } = drawingArea;
+  const {
+    instance
+  } = useChartContext();
+  const labelRefPoint = {
+    x: left + width / 2,
+    y: positionSign * axisHeight
+  };
+  const xTicks = useTicksGrouped({
+    scale: xScale,
+    tickNumber,
+    valueFormatter,
+    tickInterval,
+    tickPlacement,
+    tickLabelPlacement,
+    direction: 'x',
+    groups
+  });
+
+  // Skip axis rendering if no data is available
+  // - The domain is an empty array for band/point scales.
+  // - The domains contains Infinity for continuous scales.
+  // - The position is set to 'none'.
+  if (skipAxisRendering) {
+    return null;
+  }
+  return /*#__PURE__*/_jsxs(XAxisRoot, {
+    transform: `translate(0, ${position === 'bottom' ? top + height + offset : top - offset})`,
+    className: classes.root,
+    sx: sx,
+    children: [!disableLine && /*#__PURE__*/_jsx(Line, _extends({
+      x1: left,
+      x2: left + width,
+      className: classes.line
+    }, slotProps?.axisLine)), xTicks.map((item, index) => {
+      const {
+        offset: tickOffset,
+        labelOffset
+      } = item;
+      const xTickLabel = labelOffset ?? 0;
+      const showTick = instance.isXInside(tickOffset);
+      const tickLabel = item.formattedValue;
+      const ignoreTick = item.ignoreTick ?? false;
+      const groupIndex = item.groupIndex ?? 0;
+      const groupConfig = getGroupingConfig(groups, groupIndex, tickSize);
+      const tickYSize = positionSign * groupConfig.tickSize;
+      const labelPositionY = positionSign * (groupConfig.tickSize + TICK_LABEL_GAP);
+      return /*#__PURE__*/_jsxs("g", {
+        transform: `translate(${tickOffset}, 0)`,
+        className: classes.tickContainer,
+        "data-group-index": groupIndex,
+        children: [!disableTicks && !ignoreTick && showTick && /*#__PURE__*/_jsx(Tick, _extends({
+          y2: tickYSize,
+          className: classes.tick
+        }, slotProps?.axisTick)), tickLabel !== undefined && /*#__PURE__*/_jsx(TickLabel, _extends({
+          x: xTickLabel,
+          y: labelPositionY
+        }, axisTickLabelProps, {
+          text: tickLabel
+        }))]
+      }, index);
+    }), label && /*#__PURE__*/_jsx("g", {
+      className: classes.label,
+      children: /*#__PURE__*/_jsx(Label, _extends({}, labelRefPoint, axisLabelProps, {
+        text: label
+      }))
+    })]
+  });
+}
+export { ChartsGroupedXAxis };

package/esm/ChartsXAxis/ChartsSingleXAxis.d.ts

@@ -0,0 +1,7 @@
+import * as React from 'react';
+import { ChartsXAxisProps } from "../models/axis.js";
+/**
+ * @ignore - internal component.
+ */
+declare function ChartsSingleXAxis(inProps: ChartsXAxisProps): React.JSX.Element | null;
+export { ChartsSingleXAxis };

package/esm/ChartsXAxis/ChartsSingleXAxis.js

@@ -0,0 +1,140 @@
+'use client';
+
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import { useIsHydrated } from "../hooks/useIsHydrated.js";
+import { getStringSize } from "../internals/domUtils.js";
+import { useTicks } from "../hooks/useTicks.js";
+import { useMounted } from "../hooks/useMounted.js";
+import { useDrawingArea } from "../hooks/useDrawingArea.js";
+import { useChartContext } from "../context/ChartProvider/useChartContext.js";
+import { shortenLabels } from "./shortenLabels.js";
+import { getVisibleLabels } from "./getVisibleLabels.js";
+import { AXIS_LABEL_TICK_LABEL_GAP, TICK_LABEL_GAP, XAxisRoot } from "./utilities.js";
+import { useAxisProps } from "./useAxisProps.js";
+
+/**
+ * @ignore - internal component.
+ */
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+function ChartsSingleXAxis(inProps) {
+  const {
+    xScale,
+    defaultizedProps,
+    tickNumber,
+    positionSign,
+    skipAxisRendering,
+    classes,
+    Line,
+    Tick,
+    TickLabel,
+    Label,
+    axisTickLabelProps,
+    axisLabelProps,
+    reverse,
+    isRtl
+  } = useAxisProps(inProps);
+  const isMounted = useMounted();
+  const {
+    position,
+    disableLine,
+    disableTicks,
+    label,
+    tickSize: tickSizeProp,
+    valueFormatter,
+    slotProps,
+    tickInterval,
+    tickLabelInterval,
+    tickPlacement,
+    tickLabelPlacement,
+    tickLabelMinGap,
+    sx,
+    offset,
+    height: axisHeight
+  } = defaultizedProps;
+  const drawingArea = useDrawingArea();
+  const {
+    left,
+    top,
+    width,
+    height
+  } = drawingArea;
+  const {
+    instance
+  } = useChartContext();
+  const isHydrated = useIsHydrated();
+  const tickSize = disableTicks ? 4 : tickSizeProp;
+  const xTicks = useTicks({
+    scale: xScale,
+    tickNumber,
+    valueFormatter,
+    tickInterval,
+    tickPlacement,
+    tickLabelPlacement,
+    direction: 'x'
+  });
+  const visibleLabels = getVisibleLabels(xTicks, {
+    tickLabelStyle: axisTickLabelProps.style,
+    tickLabelInterval,
+    tickLabelMinGap,
+    reverse,
+    isMounted,
+    isXInside: instance.isXInside
+  });
+
+  // Skip axis rendering if no data is available
+  // - The domain is an empty array for band/point scales.
+  // - The domains contains Infinity for continuous scales.
+  // - The position is set to 'none'.
+  if (skipAxisRendering) {
+    return null;
+  }
+  const labelHeight = label ? getStringSize(label, axisLabelProps.style).height : 0;
+  const labelRefPoint = {
+    x: left + width / 2,
+    y: positionSign * axisHeight
+  };
+
+  /* If there's an axis title, the tick labels have less space to render  */
+  const tickLabelsMaxHeight = Math.max(0, axisHeight - (label ? labelHeight + AXIS_LABEL_TICK_LABEL_GAP : 0) - tickSize - TICK_LABEL_GAP);
+  const tickLabels = isHydrated ? shortenLabels(visibleLabels, drawingArea, tickLabelsMaxHeight, isRtl, axisTickLabelProps.style) : new Map(Array.from(visibleLabels).map(item => [item, item.formattedValue]));
+  return /*#__PURE__*/_jsxs(XAxisRoot, {
+    transform: `translate(0, ${position === 'bottom' ? top + height + offset : top - offset})`,
+    className: classes.root,
+    sx: sx,
+    children: [!disableLine && /*#__PURE__*/_jsx(Line, _extends({
+      x1: left,
+      x2: left + width,
+      className: classes.line
+    }, slotProps?.axisLine)), xTicks.map((item, index) => {
+      const {
+        offset: tickOffset,
+        labelOffset
+      } = item;
+      const xTickLabel = labelOffset ?? 0;
+      const yTickLabel = positionSign * (tickSize + TICK_LABEL_GAP);
+      const showTick = instance.isXInside(tickOffset);
+      const tickLabel = tickLabels.get(item);
+      const showTickLabel = visibleLabels.has(item);
+      return /*#__PURE__*/_jsxs("g", {
+        transform: `translate(${tickOffset}, 0)`,
+        className: classes.tickContainer,
+        children: [!disableTicks && showTick && /*#__PURE__*/_jsx(Tick, _extends({
+          y2: positionSign * tickSize,
+          className: classes.tick
+        }, slotProps?.axisTick)), tickLabel !== undefined && showTickLabel && /*#__PURE__*/_jsx(TickLabel, _extends({
+          x: xTickLabel,
+          y: yTickLabel
+        }, axisTickLabelProps, {
+          text: tickLabel
+        }))]
+      }, index);
+    }), label && /*#__PURE__*/_jsx("g", {
+      className: classes.label,
+      children: /*#__PURE__*/_jsx(Label, _extends({}, labelRefPoint, axisLabelProps, {
+        text: label
+      }))
+    })]
+  });
+}
+export { ChartsSingleXAxis };

package/esm/ChartsXAxis/ChartsXAxis.d.ts

@@ -9,7 +9,7 @@ import { ChartsXAxisProps } from "../models/axis.js";
  *
  * - [ChartsXAxis API](https://mui.com/x/api/charts/charts-x-axis/)
  */
-declare function ChartsXAxis(inProps: ChartsXAxisProps): React.JSX.Element | null;
+declare function ChartsXAxis(inProps: ChartsXAxisProps): React.JSX.Element;
 declare namespace ChartsXAxis {
   var propTypes: any;
 }

package/esm/ChartsXAxis/ChartsXAxis.js

@@ -1,62 +1,11 @@
 'use client';
 
 import _extends from "@babel/runtime/helpers/esm/extends";
-import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
-const _excluded = ["scale", "tickNumber", "reverse"];
 import * as React from 'react';
 import PropTypes from 'prop-types';
-import useSlotProps from '@mui/utils/useSlotProps';
-import composeClasses from '@mui/utils/composeClasses';
-import { useThemeProps, useTheme, styled } from '@mui/material/styles';
-import { useRtl } from '@mui/system/RtlProvider';
-import { useIsHydrated } from "../hooks/useIsHydrated.js";
-import { getStringSize } from "../internals/domUtils.js";
-import { useTicks } from "../hooks/useTicks.js";
-import { getAxisUtilityClass } from "../ChartsAxis/axisClasses.js";
-import { AxisRoot } from "../internals/components/AxisSharedComponents.js";
-import { ChartsText } from "../ChartsText/index.js";
-import { useMounted } from "../hooks/useMounted.js";
-import { useDrawingArea } from "../hooks/useDrawingArea.js";
-import { isInfinity } from "../internals/isInfinity.js";
-import { isBandScale } from "../internals/isBandScale.js";
-import { useChartContext } from "../context/ChartProvider/useChartContext.js";
 import { useXAxes } from "../hooks/useAxis.js";
-import { getDefaultBaseline, getDefaultTextAnchor } from "../ChartsText/defaultTextPlacement.js";
-import { invertTextAnchor } from "../internals/invertTextAnchor.js";
-import { shortenLabels } from "./shortenLabels.js";
-import { getVisibleLabels } from "./getVisibleLabels.js";
-import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-const useUtilityClasses = ownerState => {
-  const {
-    classes,
-    position,
-    id
-  } = ownerState;
-  const slots = {
-    root: ['root', 'directionX', position, `id-${id}`],
-    line: ['line'],
-    tickContainer: ['tickContainer'],
-    tick: ['tick'],
-    tickLabel: ['tickLabel'],
-    label: ['label']
-  };
-  return composeClasses(slots, getAxisUtilityClass, classes);
-};
-
-/* Gap between a tick and its label. */
-const TICK_LABEL_GAP = 3;
-/* Gap between the axis label and tick labels. */
-const AXIS_LABEL_TICK_LABEL_GAP = 4;
-const XAxisRoot = styled(AxisRoot, {
-  name: 'MuiChartsXAxis',
-  slot: 'Root'
-})({});
-const defaultProps = {
-  disableLine: false,
-  disableTicks: false,
-  tickSize: 6,
-  tickLabelMinGap: 4
-};
+import { ChartsSingleXAxis } from "./ChartsSingleXAxis.js";
+import { ChartsGroupedXAxis } from "./ChartsGroupedXAxis.js";
 
 /**
  * Demos:
@@ -67,166 +16,17 @@ const defaultProps = {
  *
  * - [ChartsXAxis API](https://mui.com/x/api/charts/charts-x-axis/)
  */
+import { jsx as _jsx } from "react/jsx-runtime";
 function ChartsXAxis(inProps) {
   const {
     xAxis,
     xAxisIds
   } = useXAxes();
-  const _xAxis = xAxis[inProps.axisId ?? xAxisIds[0]],
-    {
-      scale: xScale,
-      tickNumber,
-      reverse
-    } = _xAxis,
-    settings = _objectWithoutPropertiesLoose(_xAxis, _excluded);
-  const isMounted = useMounted();
-  const themedProps = useThemeProps({
-    props: _extends({}, settings, inProps),
-    name: 'MuiChartsXAxis'
-  });
-  const defaultizedProps = _extends({}, defaultProps, themedProps);
-  const {
-    position,
-    disableLine,
-    disableTicks,
-    tickLabelStyle,
-    label,
-    labelStyle,
-    tickSize: tickSizeProp,
-    valueFormatter,
-    slots,
-    slotProps,
-    tickInterval,
-    tickLabelInterval,
-    tickPlacement,
-    tickLabelPlacement,
-    tickLabelMinGap,
-    sx,
-    offset,
-    height: axisHeight
-  } = defaultizedProps;
-  const theme = useTheme();
-  const isRtl = useRtl();
-  const classes = useUtilityClasses(defaultizedProps);
-  const drawingArea = useDrawingArea();
-  const {
-    left,
-    top,
-    width,
-    height
-  } = drawingArea;
-  const {
-    instance
-  } = useChartContext();
-  const isHydrated = useIsHydrated();
-  const tickSize = disableTicks ? 4 : tickSizeProp;
-  const positionSign = position === 'bottom' ? 1 : -1;
-  const Line = slots?.axisLine ?? 'line';
-  const Tick = slots?.axisTick ?? 'line';
-  const TickLabel = slots?.axisTickLabel ?? ChartsText;
-  const Label = slots?.axisLabel ?? ChartsText;
-  const defaultTextAnchor = getDefaultTextAnchor((position === 'bottom' ? 0 : 180) - (tickLabelStyle?.angle ?? 0));
-  const defaultDominantBaseline = getDefaultBaseline((position === 'bottom' ? 0 : 180) - (tickLabelStyle?.angle ?? 0));
-  const axisTickLabelProps = useSlotProps({
-    elementType: TickLabel,
-    externalSlotProps: slotProps?.axisTickLabel,
-    additionalProps: {
-      style: _extends({}, theme.typography.caption, {
-        fontSize: 12,
-        lineHeight: 1.25,
-        textAnchor: isRtl ? invertTextAnchor(defaultTextAnchor) : defaultTextAnchor,
-        dominantBaseline: defaultDominantBaseline
-      }, tickLabelStyle)
-    },
-    className: classes.tickLabel,
-    ownerState: {}
-  });
-  const xTicks = useTicks({
-    scale: xScale,
-    tickNumber,
-    valueFormatter,
-    tickInterval,
-    tickPlacement,
-    tickLabelPlacement,
-    direction: 'x'
-  });
-  const visibleLabels = getVisibleLabels(xTicks, {
-    tickLabelStyle: axisTickLabelProps.style,
-    tickLabelInterval,
-    tickLabelMinGap,
-    reverse,
-    isMounted,
-    isXInside: instance.isXInside
-  });
-  const axisLabelProps = useSlotProps({
-    elementType: Label,
-    externalSlotProps: slotProps?.axisLabel,
-    additionalProps: {
-      style: _extends({}, theme.typography.body1, {
-        lineHeight: 1,
-        fontSize: 14,
-        textAnchor: 'middle',
-        dominantBaseline: position === 'bottom' ? 'text-after-edge' : 'text-before-edge'
-      }, labelStyle)
-    },
-    ownerState: {}
-  });
-  const domain = xScale.domain();
-  const ordinalAxis = isBandScale(xScale);
-  // Skip axis rendering if no data is available
-  // - The domain is an empty array for band/point scales.
-  // - The domains contains Infinity for continuous scales.
-  // - The position is set to 'none'.
-  if (ordinalAxis && domain.length === 0 || !ordinalAxis && domain.some(isInfinity) || position === 'none') {
-    return null;
+  const axis = xAxis[inProps.axisId ?? xAxisIds[0]];
+  if ('groups' in axis && Array.isArray(axis.groups)) {
+    return /*#__PURE__*/_jsx(ChartsGroupedXAxis, _extends({}, inProps));
   }
-  const labelHeight = label ? getStringSize(label, axisLabelProps.style).height : 0;
-  const labelRefPoint = {
-    x: left + width / 2,
-    y: positionSign * axisHeight
-  };
-
-  /* If there's an axis title, the tick labels have less space to render  */
-  const tickLabelsMaxHeight = Math.max(0, axisHeight - (label ? labelHeight + AXIS_LABEL_TICK_LABEL_GAP : 0) - tickSize - TICK_LABEL_GAP);
-  const tickLabels = isHydrated ? shortenLabels(visibleLabels, drawingArea, tickLabelsMaxHeight, isRtl, axisTickLabelProps.style) : new Map(Array.from(visibleLabels).map(item => [item, item.formattedValue]));
-  return /*#__PURE__*/_jsxs(XAxisRoot, {
-    transform: `translate(0, ${position === 'bottom' ? top + height + offset : top - offset})`,
-    className: classes.root,
-    sx: sx,
-    children: [!disableLine && /*#__PURE__*/_jsx(Line, _extends({
-      x1: left,
-      x2: left + width,
-      className: classes.line
-    }, slotProps?.axisLine)), xTicks.map((item, index) => {
-      const {
-        offset: tickOffset,
-        labelOffset
-      } = item;
-      const xTickLabel = labelOffset ?? 0;
-      const yTickLabel = positionSign * (tickSize + TICK_LABEL_GAP);
-      const showTick = instance.isXInside(tickOffset);
-      const tickLabel = tickLabels.get(item);
-      const showTickLabel = visibleLabels.has(item);
-      return /*#__PURE__*/_jsxs("g", {
-        transform: `translate(${tickOffset}, 0)`,
-        className: classes.tickContainer,
-        children: [!disableTicks && showTick && /*#__PURE__*/_jsx(Tick, _extends({
-          y2: positionSign * tickSize,
-          className: classes.tick
-        }, slotProps?.axisTick)), tickLabel !== undefined && showTickLabel && /*#__PURE__*/_jsx(TickLabel, _extends({
-          x: xTickLabel,
-          y: yTickLabel
-        }, axisTickLabelProps, {
-          text: tickLabel
-        }))]
-      }, index);
-    }), label && /*#__PURE__*/_jsx("g", {
-      className: classes.label,
-      children: /*#__PURE__*/_jsx(Label, _extends({}, labelRefPoint, axisLabelProps, {
-        text: label
-      }))
-    })]
-  });
+  return /*#__PURE__*/_jsx(ChartsSingleXAxis, _extends({}, inProps));
 }
 process.env.NODE_ENV !== "production" ? ChartsXAxis.propTypes = {
   // ----------------------------- Warning --------------------------------

package/esm/ChartsXAxis/getVisibleLabels.d.ts

@@ -1,6 +1,6 @@
 import { TickItemType } from "../hooks/useTicks.js";
 import { ChartsXAxisProps, ComputedXAxis } from "../models/axis.js";
-export declare function getVisibleLabels(xTicks: TickItemType[], {
+export declare function getVisibleLabels<T extends TickItemType>(xTicks: T[], {
   tickLabelStyle: style,
   tickLabelInterval,
   tickLabelMinGap,
@@ -11,4 +11,4 @@ export declare function getVisibleLabels(xTicks: TickItemType[], {
   isMounted: boolean;
   tickLabelMinGap: NonNullable<ChartsXAxisProps['tickLabelMinGap']>;
   isXInside: (x: number) => boolean;
-}): Set<TickItemType>;
+}): Set<T>;