2016-08-02 16:06:46 +08:00
---
category: Components
2016-11-09 14:43:32 +08:00
type: Data Display
2016-08-02 16:06:46 +08:00
title: Tooltip
---
A simple text popup tip.
## When To Use
2017-09-18 10:28:22 +08:00
- The tip is shown on mouse enter, and is hidden on mouse leave. The Tooltip doesn't support complex text or operations.
- To provide an explanation of a `button/text/operation` . It's often used instead of the html `title` attribute.
2016-08-02 16:06:46 +08:00
## API
2019-05-07 14:57:32 +08:00
| Property | Description | Type | Default |
| -------- | ----------------------------- | ---------------------------------- | ------- |
| title | The text shown in the tooltip | string\|ReactNode\|() => ReactNode | - |
2016-12-22 12:00:57 +08:00
### Common API
The following APIs are shared by Tooltip, Popconfirm, Popover.
2017-10-25 10:25:44 +08:00
| Property | Description | Type | Default |
2019-05-07 14:57:32 +08:00
| --- | --- | --- | --- |
2017-09-18 10:28:22 +08:00
| arrowPointAtCenter | Whether the arrow is pointed at the center of target, supported after `antd@1.11+` | boolean | `false` |
| autoAdjustOverflow | Whether to adjust popup placement automatically when popup is off screen | boolean | `true` |
2017-12-29 20:22:58 +08:00
| defaultVisible | Whether the floating tooltip card is visible by default | boolean | `false` |
2018-09-14 11:31:53 +08:00
| getPopupContainer | The DOM container of the tip, the default behavior is to create a `div` element in `body` | Function(triggerNode) | () => document.body |
2019-03-15 16:58:47 +08:00
| mouseEnterDelay | Delay in seconds, before tooltip is shown on mouse enter | number | 0.1 |
2017-09-18 10:28:22 +08:00
| mouseLeaveDelay | Delay in seconds, before tooltip is hidden on mouse leave | number | 0.1 |
2017-10-25 10:25:44 +08:00
| overlayClassName | Class name of the tooltip card | string | - |
| overlayStyle | Style of the tooltip card | object | - |
| placement | The position of the tooltip relative to the target, which can be one of `top` `left` `right` `bottom` `topLeft` `topRight` `bottomLeft` `bottomRight` `leftTop` `leftBottom` `rightTop` `rightBottom` | string | `top` |
2018-03-06 15:21:37 +08:00
| trigger | Tooltip trigger mode | `hover` \| `focus` \| `click` \| `contextMenu` | `hover` |
2017-10-25 10:25:44 +08:00
| visible | Whether the floating tooltip card is visible or not | boolean | `false` |
| onVisibleChange | Callback executed when visibility of the tooltip card is changed | (visible) => void | - |
2018-09-23 14:01:06 +08:00
| align | this value will be merged into placement's config, please refer to the settings [rc-tooltip ](https://github.com/react-component/tooltip ) | Object | - |
2017-01-22 14:26:46 +08:00
## Note
2017-09-18 10:28:22 +08:00
Please ensure that the child node of `Tooltip` accepts `onMouseEnter` , `onMouseLeave` , `onFocus` , `onClick` events.
