Skip to content

Tooltip API

API reference docs for the React Tooltip component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import Tooltip from '@mui/material/Tooltip';
// or
import { Tooltip } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
children*element-

Tooltip reference element.

arrowboolfalse

If true, adds an arrow to the tooltip.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

components{ Arrow?: elementType, Popper?: elementType, Tooltip?: elementType, Transition?: elementType }{}

The components used for each slot inside.

componentsProps{ arrow?: object, popper?: object, tooltip?: object, transition?: object }{}

The extra props for the slot components. You can override the existing props or add new ones.

describeChildboolfalse

Set to true if the title acts as an accessible description. By default the title acts as an accessible label for the child.

disableFocusListenerboolfalse

Do not respond to focus-visible events.

disableHoverListenerboolfalse

Do not respond to hover events.

disableInteractiveboolfalse

Makes a tooltip not interactive, i.e. it will close when the user hovers over the tooltip before the leaveDelay is expired.

disableTouchListenerboolfalse

Do not respond to long press touch events.

enterDelaynumber100

The number of milliseconds to wait before showing the tooltip. This prop won't impact the enter touch delay (enterTouchDelay).

enterNextDelaynumber0

The number of milliseconds to wait before showing the tooltip when one was already recently opened.

enterTouchDelaynumber700

The number of milliseconds a user must touch the element before showing the tooltip.

followCursorboolfalse

If true, the tooltip follow the cursor over the wrapped element.

idstring-

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.

leaveDelaynumber0

The number of milliseconds to wait before hiding the tooltip. This prop won't impact the leave touch delay (leaveTouchDelay).

leaveTouchDelaynumber1500

The number of milliseconds after the user stops touching an element before hiding the tooltip.

onClosefunc-

Callback fired when the component requests to be closed.

Signature:function(event: React.SyntheticEvent) => void
  • event The event source of the callback.
onOpenfunc-

Callback fired when the component requests to be open.

Signature:function(event: React.SyntheticEvent) => void
  • event The event source of the callback.
openbool-

If true, the component is shown.

placement'bottom-end'
| 'bottom-start'
| 'bottom'
| 'left-end'
| 'left-start'
| 'left'
| 'right-end'
| 'right-start'
| 'right'
| 'top-end'
| 'top-start'
| 'top'		'bottom'

Tooltip placement.

PopperComponentelementTypePopper

The component used for the popper.

PopperPropsobject{}

Props applied to the Popper element.

slotProps{ arrow?: object, popper?: object, tooltip?: object, transition?: object }{}

The extra props for the slot components. You can override the existing props or add new ones.
This prop is an alias for the componentsProps prop, which will be deprecated in the future.

slots{ arrow?: elementType, popper?: elementType, tooltip?: elementType, transition?: elementType }{}

The components used for each slot inside.
This prop is an alias for the components prop, which will be deprecated in the future.

sxArray<func
| object
| bool>
| func
| object		-

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

titlenode-

Tooltip title. Zero-length titles string, undefined, null and false are never displayed.

TransitionComponentelementTypeGrow

The component used for the transition. Follow this guide to learn more about the requirements for this component.

TransitionPropsobject-

Props applied to the transition element. By default, the element is based on this Transition component.

The ref is forwarded to the root element.

Theme default props

You can use MuiTooltip to change the default props of this component with the theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.MuiTooltip-arrowarrowStyles applied to the arrow element.
.MuiTooltip-popperpopperStyles applied to the Popper component.
.MuiTooltip-popperArrowpopperArrowStyles applied to the Popper component if arrow={true}.
.MuiTooltip-popperClosepopperCloseStyles applied to the Popper component unless the tooltip is open.
.MuiTooltip-popperInteractivepopperInteractiveStyles applied to the Popper component unless disableInteractive={true}.
.MuiTooltip-tooltiptooltipStyles applied to the tooltip (label wrapper) element.
.MuiTooltip-tooltipArrowtooltipArrowStyles applied to the tooltip (label wrapper) element if arrow={true}.
.MuiTooltip-tooltipPlacementBottomtooltipPlacementBottomStyles applied to the tooltip (label wrapper) element if placement contains "bottom".
.MuiTooltip-tooltipPlacementLefttooltipPlacementLeftStyles applied to the tooltip (label wrapper) element if placement contains "left".
.MuiTooltip-tooltipPlacementRighttooltipPlacementRightStyles applied to the tooltip (label wrapper) element if placement contains "right".
.MuiTooltip-tooltipPlacementToptooltipPlacementTopStyles applied to the tooltip (label wrapper) element if placement contains "top".
.MuiTooltip-touchtouchStyles applied to the tooltip (label wrapper) element if the tooltip is opened by touch.

You can override the style of the component using one of these customization options:

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.