@mui/x-charts
Version:
The community edition of the charts components (MUI X).
65 lines (64 loc) • 2.13 kB
TypeScript
import * as React from 'react';
import { PopperProps } from '@mui/base/Popper';
import { TriggerOptions } from './utils';
import { ChartsItemContentProps } from './ChartsItemTooltipContent';
import { ChartsAxisContentProps } from './ChartsAxisTooltipContent';
import { ChartsTooltipClasses } from './chartsTooltipClasses';
export interface ChartsTooltipSlots {
popper?: React.ElementType<PopperProps>;
axisContent?: React.ElementType<ChartsAxisContentProps>;
itemContent?: React.ElementType<ChartsItemContentProps>;
}
export interface ChartsTooltipSlotProps {
popper?: Partial<PopperProps>;
axisContent?: Partial<ChartsAxisContentProps>;
itemContent?: Partial<ChartsItemContentProps>;
}
export type ChartsTooltipProps = {
/**
* 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 'item'
*/
trigger?: TriggerOptions;
/**
* Component to override the tooltip content when triger is set to 'item'.
* @deprecated Use slots.itemContent instead
*/
itemContent?: React.ElementType<ChartsItemContentProps<any>>;
/**
* Component to override the tooltip content when triger 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;
/**
* The props used for each component slot.
* @default {}
*/
slotProps?: ChartsTooltipSlotProps;
};
/**
* Demos:
*
* - [ChartsTooltip](https://mui.com/x/react-charts/tooltip/)
*
* API:
*
* - [ChartsTooltip API](https://mui.com/x/api/charts/charts-tool-tip/)
*/
declare function ChartsTooltip(props: ChartsTooltipProps): React.JSX.Element | null;
declare namespace ChartsTooltip {
var propTypes: any;
}
export { ChartsTooltip };