@mui/x-charts/ChartsTooltip/ChartsTooltipContainer.d.ts

The community edition of MUI X Charts components.

import * as React from 'react';
import { type PopperProps } from '@mui/material/Popper';
import { type TriggerOptions } from "./utils.js";
import { type ChartsTooltipClasses } from "./chartsTooltipClasses.js";
type PopperSlots = NonNullable<PopperProps['slots']>;
type PopperSlotProps = NonNullable<PopperProps['slotProps']>;
export interface ChartsTooltipContainerSlots extends PopperSlots {}
export interface ChartsTooltipContainerSlotProps extends PopperSlotProps {}
export interface ChartsTooltipContainerClasses extends ChartsTooltipClasses {}
export interface ChartsTooltipContainerProps<T extends TriggerOptions = TriggerOptions> 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?: T;
  /**
   * Override or extend the styles applied to the component.
   */
  classes?: Partial<ChartsTooltipContainerClasses>;
  /**
   * Overridable component slots.
   * @default {}
   */
  slots?: ChartsTooltipContainerSlots;
  /**
   * The props used for each component slot.
   * @default {}
   */
  slotProps?: ChartsTooltipContainerSlotProps;
  /**
   * Determine if the tooltip should be placed on the pointer location or on the node.
   * @default 'pointer'
   */
  anchor?: T extends 'item' ? 'pointer' | 'node' : T extends 'axis' ? 'pointer' | 'chart' : 'pointer';
  /**
   * Determines the tooltip position relatively to the anchor.
   */
  position?: 'top' | 'bottom' | 'left' | 'right';
  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): import("react/jsx-runtime").JSX.Element | null;
declare namespace ChartsTooltipContainer {
  var propTypes: any;
}
export { ChartsTooltipContainer };