import * as React from 'react'; import { StandardProps } from '..'; import { TransitionProps } from '../transitions/transition'; import { PopperProps } from '../Popper/Popper'; export interface TooltipProps extends StandardProps, TooltipClassKey, 'title'> { /** * If `true`, adds an arrow to the tooltip. */ arrow?: boolean; /** * Tooltip reference element. */ children: React.ReactElement; /** * Do not respond to focus events. */ disableFocusListener?: boolean; /** * Do not respond to hover events. */ disableHoverListener?: boolean; /** * Do not respond to long press touch events. */ disableTouchListener?: boolean; /** * The number of milliseconds to wait before showing the tooltip. * This prop won't impact the enter touch delay (`enterTouchDelay`). */ enterDelay?: number; /** * The number of milliseconds to wait before showing the tooltip when one was already recently opened. */ enterNextDelay?: number; /** * The number of milliseconds a user must touch the element before showing the tooltip. */ enterTouchDelay?: number; /** * 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?: string; /** * Makes a tooltip interactive, i.e. will not close when the user * hovers over the tooltip before the `leaveDelay` is expired. */ interactive?: boolean; /** * The number of milliseconds to wait before hiding the tooltip. * This prop won't impact the leave touch delay (`leaveTouchDelay`). */ leaveDelay?: number; /** * The number of milliseconds after the user stops touching an element before hiding the tooltip. */ leaveTouchDelay?: number; /** * Callback fired when the component requests to be closed. * * @param {object} event The event source of the callback. */ onClose?: (event: React.ChangeEvent<{}>) => void; /** * Callback fired when the component requests to be open. * * @param {object} event The event source of the callback. */ onOpen?: (event: React.ChangeEvent<{}>) => void; /** * If `true`, the tooltip is shown. */ open?: boolean; /** * Tooltip placement. */ placement?: | 'bottom-end' | 'bottom-start' | 'bottom' | 'left-end' | 'left-start' | 'left' | 'right-end' | 'right-start' | 'right' | 'top-end' | 'top-start' | 'top'; /** * The component used for the popper. */ PopperComponent?: React.ComponentType; /** * Props applied to the [`Popper`](/api/popper/) element. */ PopperProps?: Partial; /** * Tooltip title. Zero-length titles string are never displayed. */ title: NonNullable; /** * The component used for the transition. * [Follow this guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component. */ TransitionComponent?: React.ComponentType< TransitionProps & { children?: React.ReactElement } >; /** * Props applied to the [`Transition`](http://reactcommunity.org/react-transition-group/transition#Transition-props) element. */ TransitionProps?: TransitionProps; } export type TooltipClassKey = | 'popper' | 'popperInteractive' | 'popperArrow' | 'tooltip' | 'tooltipArrow' | 'arrow' | 'touch' | 'tooltipPlacementLeft' | 'tooltipPlacementRight' | 'tooltipPlacementTop' | 'tooltipPlacementBottom'; /** * * Demos: * * - [Tooltips](https://mui.com/components/tooltips/) * * API: * * - [Tooltip API](https://mui.com/api/tooltip/) */ export default function Tooltip(props: TooltipProps): JSX.Element;