ant-design/components/tooltip/index.en-US.md

---
category: Components
type: Data Display
title: Tooltip
---

A simple text popup tip.

## When To Use

- 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.

## API

| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| title | The text shown in the tooltip | string\|ReactNode\|() => ReactNode | - |

### Common API

The following APIs are shared by Tooltip, Popconfirm, Popover.

| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| 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` |
| defaultVisible | Whether the floating tooltip card is visible by default | boolean | `false` |
| getPopupContainer | The DOM container of the tip, the default behavior is to create a `div` element in `body` | Function(triggerNode) | () => document.body |
| mouseEnterDelay | Delay in seconds, before tooltip is shown on mouse enter | number | 0.1 |
| mouseLeaveDelay | Delay in seconds, before tooltip is hidden on mouse leave | number | 0.1 |
| 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` |
| trigger | Tooltip trigger mode | `hover` \| `focus` \| `click` \| `contextMenu` | `hover` |
| 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 | - |
| align | this value will be merged into placement's config, please refer to the settings [rc-tooltip](https://github.com/react-component/tooltip) | Object | - |

## Note

Please ensure that the child node of `Tooltip` accepts `onMouseEnter`, `onMouseLeave`, `onFocus`, `onClick` events.
docs: translation tooltip (#2577) 2016-08-02 16:06:46 +08:00			`---`
			`category: Components`
docs: 调整组件导航结构 (#3758) - Layout 更名为 Grid 2016-11-09 14:43:32 +08:00			`type: Data Display`
docs: translation tooltip (#2577) 2016-08-02 16:06:46 +08:00			`title: Tooltip`
			`---`

			`A simple text popup tip.`

			`## When To Use`

docs: update Tooltip english doc (#7642) Fixed typos. 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.
docs: translation tooltip (#2577) 2016-08-02 16:06:46 +08:00
			`## API`

docs: sort api table 2017-10-25 10:25:44 +08:00			`\| Property \| Description \| Type \| Default \|`
			`\| -------- \| ----------- \| ---- \| ------- \|`
Update dependendies (#8150) * deps: upgrade rc-menu, and close: #2837 * test: update snapshots * Update rc-calendar * Update rc-cascader * Update rc-dialog * Update dropdown * Update rc-select@7.1.0 * Update rc-slider * Update rc-time-picker * Update rc-tooltip * Update rc-tree-select * Mock rc-trigger and Portal * Fix animation warning when inlineCollapsed changes * fix: should use SubMenu[popupClassName] * Fix typescript error * Fix lint * fix: style for menu * Mock rc-trigger for React 15 * Remvoe allow_failures 2017-11-11 00:07:03 +08:00			`\| title \| The text shown in the tooltip \| string\\|ReactNode\\|() => ReactNode \| - \|`
docs: update docs for Tooltip Popconfirm Popover 2016-12-22 12:00:57 +08:00
			`### Common API`

			`The following APIs are shared by Tooltip, Popconfirm, Popover.`

docs: sort api table 2017-10-25 10:25:44 +08:00			`\| Property \| Description \| Type \| Default \|`
			`\| -------- \| ----------- \| ---- \| ------- \|`
docs: update Tooltip english doc (#7642) Fixed typos. 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` \|
docs: Sort api table 2017-12-29 20:22:58 +08:00			\| defaultVisible \| Whether the floating tooltip card is visible by default \| boolean \| `false` \|
doc: remove old usage instruction 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 \|
docs: Correct the default value of mouseEnterDelay 2019-03-15 16:58:47 +08:00			`\| mouseEnterDelay \| Delay in seconds, before tooltip is shown on mouse enter \| number \| 0.1 \|`
docs: update Tooltip english doc (#7642) Fixed typos. 2017-09-18 10:28:22 +08:00			`\| mouseLeaveDelay \| Delay in seconds, before tooltip is hidden on mouse leave \| number \| 0.1 \|`
docs: sort api table 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` \|
add Tooltip contextMenu doc 2018-03-06 15:21:37 +08:00			\| trigger \| Tooltip trigger mode \| `hover` \\| `focus` \\| `click` \\| `contextMenu` \| `hover` \|
docs: sort api table 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 \| - \|`
add/fix tooltip align interface (#12354) * expose align interface * typescript fix: tooltip 的 align 部分值支持传百分数参数；更新文档 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 \| - \|`
docs: Add note to Popconfirm, Popover and tooltip about child node. Related issue: #4672 2017-01-22 14:26:46 +08:00
			`## Note`

docs: update Tooltip english doc (#7642) Fixed typos. 2017-09-18 10:28:22 +08:00			Please ensure that the child node of `Tooltip` accepts `onMouseEnter`, `onMouseLeave`, `onFocus`, `onClick` events.