--- productId: material-ui title: React Tooltip component components: Tooltip githubLabel: 'scope: tooltip' materialDesign: https://m2.material.io/components/tooltips waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/tooltip/ githubSource: packages/mui-material/src/Tooltip --- # Tooltip Tooltips display informative text when users hover over, focus on, or tap an element. When activated, Tooltips display a text label identifying an element, such as a description of its function. ## Basic tooltip ```tsx import DeleteIcon from '@mui/icons-material/Delete'; import IconButton from '@mui/material/IconButton'; import Tooltip from '@mui/material/Tooltip'; export default function BasicTooltip() { return ( ); } ``` ## Labels and descriptions By default, the tooltip only labels its child element. This is notably different from `title` which can either label or describe its child depending on whether the child already has a label. For example, in the element below, the `title` acts as an accessible description: ```html ``` If you want the tooltip to act as an accessible description, you can pass the `describeChild` prop. You shouldn't use `describeChild` if the tooltip provides the only visual label. In that case, the child would have no accessible name and the tooltip would violate [WCAG 2.2 Success Criterion 2.5.3](https://www.w3.org/WAI/WCAG22/Understanding/label-in-name.html). If the trigger already has either visible text or an `aria-label`, use the tooltip as a description and pass the `describeChild` prop. Otherwise, you can use the default behavior and let the tooltip label the trigger. ```tsx import DeleteIcon from '@mui/icons-material/Delete'; import Button from '@mui/material/Button'; import IconButton from '@mui/material/IconButton'; import Tooltip from '@mui/material/Tooltip'; export default function AccessibilityTooltips() { return (
); } ``` ## Positioned tooltips The `Tooltip` has 12 **placement** choices. They don't have directional arrows; instead, they rely on motion emanating from the source to convey direction. ```tsx import Box from '@mui/material/Box'; import Stack from '@mui/material/Stack'; import Button from '@mui/material/Button'; import Tooltip from '@mui/material/Tooltip'; export default function PositionedTooltips() { return ( ); } ``` ## Customization Here are some examples of customizing the component. You can learn more about this in the [overrides documentation page](/material-ui/customization/how-to-customize/). ```tsx import * as React from 'react'; import { styled } from '@mui/material/styles'; import Button from '@mui/material/Button'; import Tooltip, { TooltipProps, tooltipClasses } from '@mui/material/Tooltip'; import Typography from '@mui/material/Typography'; const LightTooltip = styled(({ className, ...props }: TooltipProps) => ( ))(({ theme }) => ({ [`& .${tooltipClasses.tooltip}`]: { backgroundColor: theme.palette.common.white, color: 'rgba(0, 0, 0, 0.87)', boxShadow: theme.shadows[1], fontSize: 11, }, })); const BootstrapTooltip = styled(({ className, ...props }: TooltipProps) => ( ))(({ theme }) => ({ [`& .${tooltipClasses.arrow}`]: { color: theme.palette.common.black, }, [`& .${tooltipClasses.tooltip}`]: { backgroundColor: theme.palette.common.black, }, })); const HtmlTooltip = styled(({ className, ...props }: TooltipProps) => ( ))(({ theme }) => ({ [`& .${tooltipClasses.tooltip}`]: { backgroundColor: '#f5f5f9', color: 'rgba(0, 0, 0, 0.87)', maxWidth: 220, fontSize: theme.typography.pxToRem(12), border: '1px solid #dadde9', }, })); export default function CustomizedTooltips() { return (
Tooltip with HTML {"And here's"} {'some'} {'amazing content'}.{' '} {"It's very engaging. Right?"} } >
); } ``` ## Arrow tooltips You can use the `arrow` prop to give your tooltip an arrow indicating which element it refers to. ```tsx import Button from '@mui/material/Button'; import Tooltip from '@mui/material/Tooltip'; export default function ArrowTooltips() { return ( ); } ``` ## Distance from anchor To adjust the distance between the tooltip and its anchor, you can use the `slotProps` prop to modify the [offset](https://popper.js.org/docs/v2/modifiers/offset/) of the popper. ```tsx import Button from '@mui/material/Button'; import Tooltip from '@mui/material/Tooltip'; export default function TooltipOffset() { return ( ); } ``` Alternatively, you can use the `slotProps` prop to customize the margin of the popper. ```tsx import Button from '@mui/material/Button'; import Tooltip, { tooltipClasses } from '@mui/material/Tooltip'; export default function TooltipMargin() { return ( ); } ``` ## Custom child element The tooltip needs to apply DOM event listeners to its child element. If the child is a custom React element, you need to make sure that it spreads its props to the underlying DOM element. ```jsx const MyComponent = React.forwardRef(function MyComponent(props, ref) { // Spread the props to the underlying DOM element. return (
Bin
); }); // ... ; ``` If using a class component as a child, you'll also need to ensure that the ref is forwarded to the underlying DOM element. (A ref to the class component itself will not work.) ```jsx class MyComponent extends React.Component { render() { const { innerRef, ...props } = this.props; // Spread the props to the underlying DOM element. return (
Bin
); } } // Wrap MyComponent to forward the ref as expected by Tooltip const WrappedMyComponent = React.forwardRef(function WrappedMyComponent(props, ref) { return ; }); // ... ; ``` ## Triggers You can define the types of events that cause a tooltip to show. The touch action requires a long press due to the `enterTouchDelay` prop being set to `700`ms by default. ```tsx import * as React from 'react'; import Grid from '@mui/material/Grid'; import Button from '@mui/material/Button'; import Tooltip from '@mui/material/Tooltip'; import ClickAwayListener from '@mui/material/ClickAwayListener'; export default function TriggersTooltips() { const [open, setOpen] = React.useState(false); const handleTooltipClose = () => { setOpen(false); }; const handleTooltipOpen = () => { setOpen(true); }; return (
); } ``` ## Controlled tooltips You can use the `open`, `onOpen` and `onClose` props to control the behavior of the tooltip. ```tsx import * as React from 'react'; import Button from '@mui/material/Button'; import Tooltip from '@mui/material/Tooltip'; export default function ControlledTooltips() { const [open, setOpen] = React.useState(false); const handleClose = () => { setOpen(false); }; const handleOpen = () => { setOpen(true); }; return ( ); } ``` ## Variable width The `Tooltip` wraps long text by default to make it readable. ```tsx import { styled } from '@mui/material/styles'; import Button from '@mui/material/Button'; import Tooltip, { TooltipProps, tooltipClasses } from '@mui/material/Tooltip'; const CustomWidthTooltip = styled(({ className, ...props }: TooltipProps) => ( ))({ [`& .${tooltipClasses.tooltip}`]: { maxWidth: 500, }, }); const NoMaxWidthTooltip = styled(({ className, ...props }: TooltipProps) => ( ))({ [`& .${tooltipClasses.tooltip}`]: { maxWidth: 'none', }, }); const longText = ` Aliquam eget finibus ante, non facilisis lectus. Sed vitae dignissim est, vel aliquam tellus. Praesent non nunc mollis, fermentum neque at, semper arcu. Nullam eget est sed sem iaculis gravida eget vitae justo. `; export default function VariableWidth() { return (
); } ``` ## Interactive Tooltips are interactive by default (to pass [WCAG 2.2 Success Criterion 1.4.13](https://www.w3.org/WAI/WCAG22/Understanding/content-on-hover-or-focus.html)). It won't close when the user hovers over the tooltip before the `leaveDelay` is expired. You can disable this behavior (thus failing the success criterion which is required to reach Level AA) by passing `disableInteractive`. ```tsx import Button from '@mui/material/Button'; import Tooltip from '@mui/material/Tooltip'; export default function NonInteractiveTooltips() { return ( ); } ``` ## Disabled elements By default disabled elements like `
); } ``` :::warning If you're not wrapping a MaterialĀ UI component that inherits from `ButtonBase`, for instance, a native `
``` ## Transitions Use `slots.transition` and `slotProps.transition` to use a different transition. ```tsx import Button from '@mui/material/Button'; import Tooltip from '@mui/material/Tooltip'; import Fade from '@mui/material/Fade'; import Zoom from '@mui/material/Zoom'; export default function TransitionsTooltips() { return (
); } ``` ## Follow cursor You can enable the tooltip to follow the cursor by setting `followCursor={true}`. ```tsx import Box from '@mui/material/Box'; import Tooltip from '@mui/material/Tooltip'; export default function FollowCursorTooltips() { return ( Disabled Action ); } ``` ## Virtual element In the event you need to implement a custom placement, you can use the `anchorEl` prop: The value of the `anchorEl` prop can be a reference to a fake DOM element. You need to create an object shaped like the [`VirtualElement`](https://popper.js.org/docs/v2/virtual-elements/). ```tsx import * as React from 'react'; import Box from '@mui/material/Box'; import Tooltip from '@mui/material/Tooltip'; import { Instance } from '@popperjs/core'; export default function AnchorElTooltips() { const positionRef = React.useRef<{ x: number; y: number }>({ x: 0, y: 0, }); const popperRef = React.useRef(null); const areaRef = React.useRef(null); const handleMouseMove = (event: React.MouseEvent) => { positionRef.current = { x: event.clientX, y: event.clientY }; if (popperRef.current != null) { popperRef.current.update(); } }; return ( { return new DOMRect( positionRef.current.x, areaRef.current!.getBoundingClientRect().y, 0, 0, ); }, }, }, }} > Hover ); } ``` ## Showing and hiding The tooltip is normally shown immediately when the user's mouse hovers over the element, and hides immediately when the user's mouse leaves. A delay in showing or hiding the tooltip can be added through the `enterDelay` and `leaveDelay` props. On mobile, the tooltip is displayed when the user longpresses the element and hides after a delay of 1500ms. You can disable this feature with the `disableTouchListener` prop. ```tsx import Button from '@mui/material/Button'; import Tooltip from '@mui/material/Tooltip'; export default function DelayTooltips() { return ( ); } ``` ## Accessibility (WAI-ARIA: https://www.w3.org/WAI/ARIA/apg/patterns/tooltip/) Tooltips should wrap triggers that are focusable and hoverable (for example, buttons) so that all users can activate them. When tooltips are displayed, they are automatically linked to the trigger. The trigger element is either labeled or described by the tooltip content. However, tooltip content should not be used as a full text alternative for truncated content. # Tooltip API ## Demos For examples and details on the usage of this React component, visit the component demo pages: - [Tooltip](https://mui.com/material-ui/react-tooltip/) ## Import ```jsx import Tooltip from '@mui/material/Tooltip'; // or import { Tooltip } from '@mui/material'; ``` ## Props | Name | Type | Default | Required | Description | |------|------|---------|----------|-------------| | children | `element` | - | Yes | | | arrow | `bool` | `false` | No | | | classes | `object` | - | No | Override or extend the styles applied to the component. | | describeChild | `bool` | `false` | No | | | disableFocusListener | `bool` | `false` | No | | | disableHoverListener | `bool` | `false` | No | | | disableInteractive | `bool` | `false` | No | | | disableTouchListener | `bool` | `false` | No | | | enterDelay | `number` | `100` | No | | | enterNextDelay | `number` | `0` | No | | | enterTouchDelay | `number` | `700` | No | | | followCursor | `bool` | `false` | No | | | id | `string` | - | No | | | leaveDelay | `number` | `0` | No | | | leaveTouchDelay | `number` | `1500` | No | | | onClose | `function(event: React.SyntheticEvent) => void` | - | No | | | onOpen | `function(event: React.SyntheticEvent) => void` | - | No | | | open | `bool` | - | No | | | placement | `'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'` | `'bottom'` | No | | | slotProps | `{ arrow?: func \| object, popper?: func \| object, tooltip?: func \| object, transition?: func \| object }` | `{}` | No | | | slots | `{ arrow?: elementType, popper?: elementType, tooltip?: elementType, transition?: elementType }` | `{}` | No | | | sx | `Array \| func \| object` | - | No | The system prop that allows defining system overrides as well as additional CSS styles. | | title | `node` | - | No | | > **Note**: The `ref` is forwarded to the root element (HTMLButtonElement). > Any other props supplied will be provided to the root element (native element). ## Theme default props You can use `MuiTooltip` to change the default props of this component with the theme. ## Slots | Name | Default | Class | Description | |------|---------|-------|-------------| | popper | `Popper` | `.MuiTooltip-popper` | The component used for the popper. | | transition | `Grow` | - | The component used for the transition. [Follow this guide](/material-ui/transitions/#transition-slots) to learn more about the requirements for this component. | | tooltip | `undefined` | `.MuiTooltip-tooltip` | The component used for the tooltip. | | arrow | `undefined` | `.MuiTooltip-arrow` | The component used for the arrow. | ## CSS ### Rule name | Global class | Rule name | Description | |--------------|-----------|-------------| | - | popperArrow | Styles applied to the Popper component if `arrow={true}`. | | - | popperClose | Styles applied to the Popper component unless the tooltip is open. | | - | popperInteractive | Styles applied to the Popper component unless `disableInteractive={true}`. | | - | tooltipArrow | Styles applied to the tooltip (label wrapper) element if `arrow={true}`. | | - | tooltipPlacementBottom | Styles applied to the tooltip (label wrapper) element if `placement` contains "bottom". | | - | tooltipPlacementLeft | Styles applied to the tooltip (label wrapper) element if `placement` contains "left". | | - | tooltipPlacementRight | Styles applied to the tooltip (label wrapper) element if `placement` contains "right". | | - | tooltipPlacementTop | Styles applied to the tooltip (label wrapper) element if `placement` contains "top". | | - | touch | Styles applied to the tooltip (label wrapper) element if the tooltip is opened by touch. | ## Source code If you did not find the information on this page, consider having a look at the implementation of the component for more detail. - [/packages/mui-material/src/Tooltip/Tooltip.js](https://github.com/mui/material-ui/tree/HEAD/packages/mui-material/src/Tooltip/Tooltip.js)