@mui/x-charts 8.0.0-alpha.0 → 8.0.0-alpha.1

package/ChartsTooltip/ChartsTooltip.d.ts

@@ -1,72 +1,6 @@
 import * as React from 'react';
-import { SxProps, Theme } from '@mui/material/styles';
-import { PopperProps as BasePopperProps } from '@mui/material/Popper';
-import { TriggerOptions } from './utils';
-import { ChartSeriesType } from '../models/seriesType/config';
-import { ChartsItemContentProps } from './ChartsItemTooltipContent';
-import { ChartsAxisContentProps } from './ChartsAxisTooltipContent';
-import { ChartsTooltipClasses } from './chartsTooltipClasses';
-export type PopperProps = BasePopperProps & {
-    /**
-     * The system prop that allows defining system overrides as well as additional CSS styles.
-     */
-    sx?: SxProps<Theme>;
-};
-export interface ChartsTooltipSlots<T extends ChartSeriesType> {
-    /**
-     * Custom component for the tooltip popper.
-     * @default ChartsTooltipRoot
-     */
-    popper?: React.ElementType<PopperProps>;
-    /**
-     * Custom component for displaying tooltip content when triggered by axis event.
-     * @default DefaultChartsAxisTooltipContent
-     */
-    axisContent?: React.ElementType<ChartsAxisContentProps>;
-    /**
-     * Custom component for displaying tooltip content when triggered by item event.
-     * @default DefaultChartsItemTooltipContent
-     */
-    itemContent?: React.ElementType<ChartsItemContentProps<T>>;
-}
-export interface ChartsTooltipSlotProps<T extends ChartSeriesType> {
-    popper?: Partial<PopperProps>;
-    axisContent?: Partial<ChartsAxisContentProps>;
-    itemContent?: Partial<ChartsItemContentProps<T>>;
-}
-export interface ChartsTooltipProps<T extends ChartSeriesType> {
-    /**
-     * Select the kind of tooltip to display
-     * - 'item': Shows data about the item below the mouse.
-     * - 'axis': Shows values associated with the hovered x value
-     * - 'none': Does not display tooltip
-     * @default 'axis'
-     */
-    trigger?: TriggerOptions;
-    /**
-     * Component to override the tooltip content when trigger is set to 'item'.
-     * @deprecated Use slots.itemContent instead
-     */
-    itemContent?: React.ElementType<ChartsItemContentProps<any>>;
-    /**
-     * Component to override the tooltip content when trigger is set to 'axis'.
-     * @deprecated Use slots.axisContent instead
-     */
-    axisContent?: React.ElementType<ChartsAxisContentProps>;
-    /**
-     * Override or extend the styles applied to the component.
-     */
-    classes?: Partial<ChartsTooltipClasses>;
-    /**
-     * Overridable component slots.
-     * @default {}
-     */
-    slots?: ChartsTooltipSlots<T>;
-    /**
-     * The props used for each component slot.
-     * @default {}
-     */
-    slotProps?: ChartsTooltipSlotProps<T>;
+import { ChartsTooltipContainerProps } from './ChartsTooltipContainer';
+export interface ChartsTooltipProps extends Omit<ChartsTooltipContainerProps, 'children'> {
 }
 /**
  * Demos:
@@ -77,7 +11,7 @@ export interface ChartsTooltipProps<T extends ChartSeriesType> {
  *
  * - [ChartsTooltip API](https://mui.com/x/api/charts/charts-tool-tip/)
  */
-declare function ChartsTooltip<T extends ChartSeriesType>(inProps: ChartsTooltipProps<T>): React.JSX.Element | null;
+declare function ChartsTooltip(props: ChartsTooltipProps): React.JSX.Element;
 declare namespace ChartsTooltip {
     var propTypes: any;
 }

package/ChartsTooltip/ChartsTooltip.js

@@ -3,47 +3,11 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
 import * as React from 'react';
 import PropTypes from 'prop-types';
-import composeClasses from '@mui/utils/composeClasses';
-import useLazyRef from '@mui/utils/useLazyRef';
-import { styled, useThemeProps } from '@mui/material/styles';
-import Popper from '@mui/material/Popper';
-import NoSsr from '@mui/material/NoSsr';
-import useSlotProps from '@mui/utils/useSlotProps';
-import { InteractionContext } from "../context/InteractionProvider.js";
-import { useSvgRef } from "../hooks/useSvgRef.js";
-import { getTooltipHasData, usePointerType } from "./utils.js";
 import { ChartsItemTooltipContent } from "./ChartsItemTooltipContent.js";
 import { ChartsAxisTooltipContent } from "./ChartsAxisTooltipContent.js";
-import { getChartsTooltipUtilityClass } from "./chartsTooltipClasses.js";
+import { ChartsTooltipContainer } from "./ChartsTooltipContainer.js";
+import { useUtilityClasses } from "./chartsTooltipClasses.js";
 import { jsx as _jsx } from "react/jsx-runtime";
-const useUtilityClasses = ownerState => {
-  const {
-    classes
-  } = ownerState;
-  const slots = {
-    root: ['root'],
-    paper: ['paper'],
-    table: ['table'],
-    row: ['row'],
-    cell: ['cell'],
-    mark: ['mark'],
-    markCell: ['markCell'],
-    labelCell: ['labelCell'],
-    valueCell: ['valueCell']
-  };
-  return composeClasses(slots, getChartsTooltipUtilityClass, classes);
-};
-const ChartsTooltipRoot = styled(Popper, {
-  name: 'MuiChartsTooltip',
-  slot: 'Root',
-  overridesResolver: (_, styles) => styles.root
-})(({
-  theme
-}) => ({
-  pointerEvents: 'none',
-  zIndex: theme.zIndex.modal
-}));
-
 /**
  * Demos:
  *
@@ -53,108 +17,20 @@ const ChartsTooltipRoot = styled(Popper, {
  *
  * - [ChartsTooltip API](https://mui.com/x/api/charts/charts-tool-tip/)
  */
-function ChartsTooltip(inProps) {
-  const props = useThemeProps({
-    props: inProps,
-    name: 'MuiChartsTooltip'
-  });
+function ChartsTooltip(props) {
   const {
-    trigger = 'axis',
-    itemContent,
-    axisContent,
-    slots,
-    slotProps
+    classes: propClasses,
+    trigger = 'axis'
   } = props;
-  const svgRef = useSvgRef();
-  const pointerType = usePointerType();
-  const popperRef = React.useRef(null);
-  const positionRef = useLazyRef(() => ({
-    x: 0,
-    y: 0
+  const classes = useUtilityClasses(propClasses);
+  return /*#__PURE__*/_jsx(ChartsTooltipContainer, _extends({}, props, {
+    classes: classes,
+    children: trigger === 'axis' ? /*#__PURE__*/_jsx(ChartsAxisTooltipContent, {
+      classes: classes
+    }) : /*#__PURE__*/_jsx(ChartsItemTooltipContent, {
+      classes: classes
+    })
   }));
-  const {
-    item,
-    axis
-  } = React.useContext(InteractionContext);
-  const displayedData = trigger === 'item' ? item : axis;
-  const tooltipHasData = getTooltipHasData(trigger, displayedData);
-  const popperOpen = pointerType !== null && tooltipHasData;
-  const classes = useUtilityClasses({
-    classes: props.classes
-  });
-  const PopperComponent = slots?.popper ?? ChartsTooltipRoot;
-  const popperProps = useSlotProps({
-    elementType: PopperComponent,
-    externalSlotProps: slotProps?.popper,
-    additionalProps: {
-      open: popperOpen,
-      placement: pointerType?.pointerType === 'mouse' ? 'right-start' : 'top',
-      popperRef,
-      anchorEl: {
-        getBoundingClientRect: () => ({
-          x: positionRef.current.x,
-          y: positionRef.current.y,
-          top: positionRef.current.y,
-          left: positionRef.current.x,
-          right: positionRef.current.x,
-          bottom: positionRef.current.y,
-          width: 0,
-          height: 0,
-          toJSON: () => ''
-        })
-      },
-      modifiers: [{
-        name: 'offset',
-        options: {
-          offset: [0, pointerType?.pointerType === 'touch' ? 40 - pointerType.height : 0]
-        }
-      }]
-    },
-    ownerState: {}
-  });
-  React.useEffect(() => {
-    const element = svgRef.current;
-    if (element === null) {
-      return () => {};
-    }
-    const handleMove = event => {
-      // eslint-disable-next-line react-compiler/react-compiler
-      positionRef.current = {
-        x: event.clientX,
-        y: event.clientY
-      };
-      popperRef.current?.update();
-    };
-    element.addEventListener('pointermove', handleMove);
-    return () => {
-      element.removeEventListener('pointermove', handleMove);
-    };
-  }, [svgRef, positionRef]);
-  if (trigger === 'none') {
-    return null;
-  }
-  return /*#__PURE__*/_jsx(NoSsr, {
-    children: popperOpen && /*#__PURE__*/_jsx(PopperComponent, _extends({}, popperProps, {
-      className: classes.root,
-      children: trigger === 'item' ? /*#__PURE__*/_jsx(ChartsItemTooltipContent, {
-        itemData: displayedData,
-        content: slots?.itemContent ?? itemContent,
-        contentProps: slotProps?.itemContent,
-        sx: {
-          mx: 2
-        },
-        classes: classes
-      }) : /*#__PURE__*/_jsx(ChartsAxisTooltipContent, {
-        axisData: displayedData,
-        content: slots?.axisContent ?? axisContent,
-        contentProps: slotProps?.axisContent,
-        sx: {
-          mx: 2
-        },
-        classes: classes
-      })
-    }))
-  });
 }
 process.env.NODE_ENV !== "production" ? ChartsTooltip.propTypes = {
   // ----------------------------- Warning --------------------------------
@@ -162,29 +38,169 @@ process.env.NODE_ENV !== "production" ? ChartsTooltip.propTypes = {
   // | To update them edit the TypeScript types and run "pnpm proptypes"  |
   // ----------------------------------------------------------------------
   /**
-   * Component to override the tooltip content when trigger is set to 'axis'.
-   * @deprecated Use slots.axisContent instead
+   * An HTML element, [virtualElement](https://popper.js.org/docs/v2/virtual-elements/),
+   * or a function that returns either.
+   * It's used to set the position of the popper.
+   * The return value will passed as the reference object of the Popper instance.
    */
-  axisContent: PropTypes.elementType,
+  anchorEl: PropTypes.oneOfType([(props, propName) => {
+    if (props[propName] == null) {
+      return new Error(`Prop '${propName}' is required but wasn't specified`);
+    }
+    if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {
+      return new Error(`Expected prop '${propName}' to be of type Element`);
+    }
+    return null;
+  }, PropTypes.func, PropTypes.shape({
+    contextElement: (props, propName) => {
+      if (props[propName] == null) {
+        return null;
+      }
+      if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {
+        return new Error(`Expected prop '${propName}' to be of type Element`);
+      }
+      return null;
+    },
+    getBoundingClientRect: PropTypes.func.isRequired
+  })]),
   /**
    * Override or extend the styles applied to the component.
    */
   classes: PropTypes.object,
   /**
-   * Component to override the tooltip content when trigger is set to 'item'.
-   * @deprecated Use slots.itemContent instead
+   * The component used for the root node.
+   * Either a string to use a HTML element or a component.
+   */
+  component: PropTypes.elementType,
+  /**
+   * The components used for each slot inside the Popper.
+   * Either a string to use a HTML element or a component.
+   * @default {}
+   */
+  components: PropTypes.shape({
+    Root: PropTypes.elementType
+  }),
+  /**
+   * The props used for each slot inside the Popper.
+   * @default {}
+   */
+  componentsProps: PropTypes.shape({
+    root: PropTypes.oneOfType([PropTypes.func, PropTypes.object])
+  }),
+  /**
+   * An HTML element or function that returns one.
+   * The `container` will have the portal children appended to it.
+   *
+   * You can also provide a callback, which is called in a React layout effect.
+   * This lets you set the container from a ref, and also makes server-side rendering possible.
+   *
+   * By default, it uses the body of the top-level document object,
+   * so it's simply `document.body` most of the time.
+   */
+  container: PropTypes.oneOfType([(props, propName) => {
+    if (props[propName] == null) {
+      return new Error(`Prop '${propName}' is required but wasn't specified`);
+    }
+    if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) {
+      return new Error(`Expected prop '${propName}' to be of type Element`);
+    }
+    return null;
+  }, PropTypes.func]),
+  /**
+   * The `children` will be under the DOM hierarchy of the parent component.
+   * @default false
+   */
+  disablePortal: PropTypes.bool,
+  /**
+   * Always keep the children in the DOM.
+   * This prop can be useful in SEO situation or
+   * when you want to maximize the responsiveness of the Popper.
+   * @default false
+   */
+  keepMounted: PropTypes.bool,
+  /**
+   * Popper.js is based on a "plugin-like" architecture,
+   * most of its features are fully encapsulated "modifiers".
+   *
+   * A modifier is a function that is called each time Popper.js needs to
+   * compute the position of the popper.
+   * For this reason, modifiers should be very performant to avoid bottlenecks.
+   * To learn how to create a modifier, [read the modifiers documentation](https://popper.js.org/docs/v2/modifiers/).
+   */
+  modifiers: PropTypes.arrayOf(PropTypes.shape({
+    data: PropTypes.object,
+    effect: PropTypes.func,
+    enabled: PropTypes.bool,
+    fn: PropTypes.func,
+    name: PropTypes.any,
+    options: PropTypes.object,
+    phase: PropTypes.oneOf(['afterMain', 'afterRead', 'afterWrite', 'beforeMain', 'beforeRead', 'beforeWrite', 'main', 'read', 'write']),
+    requires: PropTypes.arrayOf(PropTypes.string),
+    requiresIfExists: PropTypes.arrayOf(PropTypes.string)
+  })),
+  /**
+   * If `true`, the component is shown.
+   */
+  open: PropTypes.bool,
+  /**
+   * Popper placement.
+   * @default 'bottom'
+   */
+  placement: PropTypes.oneOf(['auto-end', 'auto-start', 'auto', 'bottom-end', 'bottom-start', 'bottom', 'left-end', 'left-start', 'left', 'right-end', 'right-start', 'right', 'top-end', 'top-start', 'top']),
+  /**
+   * Options provided to the [`Popper.js`](https://popper.js.org/docs/v2/constructors/#options) instance.
+   * @default {}
+   */
+  popperOptions: PropTypes.shape({
+    modifiers: PropTypes.array,
+    onFirstUpdate: PropTypes.func,
+    placement: PropTypes.oneOf(['auto-end', 'auto-start', 'auto', 'bottom-end', 'bottom-start', 'bottom', 'left-end', 'left-start', 'left', 'right-end', 'right-start', 'right', 'top-end', 'top-start', 'top']),
+    strategy: PropTypes.oneOf(['absolute', 'fixed'])
+  }),
+  /**
+   * A ref that points to the used popper instance.
    */
-  itemContent: PropTypes.elementType,
+  popperRef: PropTypes.oneOfType([PropTypes.func, PropTypes.shape({
+    current: PropTypes.shape({
+      destroy: PropTypes.func.isRequired,
+      forceUpdate: PropTypes.func.isRequired,
+      setOptions: PropTypes.func.isRequired,
+      state: PropTypes.shape({
+        attributes: PropTypes.object.isRequired,
+        elements: PropTypes.object.isRequired,
+        modifiersData: PropTypes.object.isRequired,
+        options: PropTypes.object.isRequired,
+        orderedModifiers: PropTypes.arrayOf(PropTypes.object).isRequired,
+        placement: PropTypes.oneOf(['auto-end', 'auto-start', 'auto', 'bottom-end', 'bottom-start', 'bottom', 'left-end', 'left-start', 'left', 'right-end', 'right-start', 'right', 'top-end', 'top-start', 'top']).isRequired,
+        rects: PropTypes.object.isRequired,
+        reset: PropTypes.bool.isRequired,
+        scrollParents: PropTypes.object.isRequired,
+        strategy: PropTypes.oneOf(['absolute', 'fixed']).isRequired,
+        styles: PropTypes.object.isRequired
+      }).isRequired,
+      update: PropTypes.func.isRequired
+    })
+  })]),
   /**
-   * The props used for each component slot.
+   * The props used for each slot inside the Popper.
    * @default {}
    */
   slotProps: PropTypes.object,
   /**
-   * Overridable component slots.
+   * The components used for each slot inside the Popper.
+   * Either a string to use a HTML element or a component.
    * @default {}
    */
   slots: PropTypes.object,
+  /**
+   * The system prop that allows defining system overrides as well as additional CSS styles.
+   */
+  sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
+  /**
+   * Help supporting a react-transition-group/Transition component.
+   * @default false
+   */
+  transition: PropTypes.bool,
   /**
    * Select the kind of tooltip to display
    * - 'item': Shows data about the item below the mouse.

package/ChartsTooltip/ChartsTooltipContainer.d.ts

@@ -0,0 +1,33 @@
+import * as React from 'react';
+import { PopperProps } from '@mui/material/Popper';
+import { TriggerOptions } from './utils';
+import { ChartsTooltipClasses } from './chartsTooltipClasses';
+export interface ChartsTooltipContainerProps extends Partial<PopperProps> {
+    /**
+     * Select the kind of tooltip to display
+     * - 'item': Shows data about the item below the mouse.
+     * - 'axis': Shows values associated with the hovered x value
+     * - 'none': Does not display tooltip
+     * @default 'axis'
+     */
+    trigger?: TriggerOptions;
+    /**
+     * Override or extend the styles applied to the component.
+     */
+    classes?: Partial<ChartsTooltipClasses>;
+    children?: React.ReactNode;
+}
+/**
+ * Demos:
+ *
+ * - [ChartsTooltip](https://mui.com/x/react-charts/tooltip/)
+ *
+ * API:
+ *
+ * - [ChartsTooltip API](https://mui.com/x/api/charts/charts-tool-tip/)
+ */
+declare function ChartsTooltipContainer(inProps: ChartsTooltipContainerProps): React.JSX.Element | null;
+declare namespace ChartsTooltipContainer {
+    var propTypes: any;
+}
+export { ChartsTooltipContainer };