ant-design/components/tooltip/index.zh-CN.md

---
category: Components
subtitle: 文字提示
type: Data Display
title: Tooltip
---

简单的文字提示气泡框。

## 何时使用

鼠标移入则显示提示，移出消失，气泡浮层不承载复杂文本和操作。

可用来代替系统默认的 `title` 提示，提供一个`按钮/文字/操作`的文案解释。

## API

| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| title | 提示文字 | string\|ReactNode\|() => ReactNode | 无 |

### 共同的 API

以下 API 为 Tooltip、Popconfirm、Popover 共享的 API。

| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| arrowPointAtCenter | 箭头是否指向目标元素中心，`antd@1.11+` 支持 | boolean | `false` |
| autoAdjustOverflow | 气泡被遮挡时自动调整位置 | boolean | `true` |
| defaultVisible | 默认是否显隐 | boolean | false |
| getPopupContainer | 浮层渲染父节点，默认渲染到 body 上 | Function(triggerNode) | () => document.body |
| mouseEnterDelay | 鼠标移入后延时多少才显示 Tooltip，单位：秒 | number | 0 |
| mouseLeaveDelay | 鼠标移出后延时多少才隐藏 Tooltip，单位：秒 | number | 0.1 |
| overlayClassName | 卡片类名 | string | 无 |
| overlayStyle | 卡片样式 | object | 无 |
| placement | 气泡框位置，可选 `top` `left` `right` `bottom` `topLeft` `topRight` `bottomLeft` `bottomRight` `leftTop` `leftBottom` `rightTop` `rightBottom` | string | top |
| trigger | 触发行为，可选 `hover/focus/click/contextMenu` | string | hover |
| visible | 用于手动控制浮层显隐 | boolean | false |
| onVisibleChange | 显示隐藏的回调 | (visible) => void | 无 |
| align | 该值将合并到 placement 的配置中，设置参考 [rc-tooltip](https://github.com/react-component/tooltip) | Object | 无 |

## 注意

请确保 `Tooltip` 的子元素能接受 `onMouseEnter`、`onMouseLeave`、`onFocus`、`onClick` 事件。
-												docs: update documentation format

											
										
										
											2016-03-31 14:17:09 +08:00
+								---
 								category: Components
-												docs: update docs details

											
										
										
											2016-09-21 11:28:38 +08:00
+								subtitle: 文字提示
-												docs: 调整组件导航结构 (#3758)

- Layout 更名为 Grid
											
										
										
											2016-11-09 14:43:32 +08:00
+								type: Data Display
-												docs: update docs details

											
										
										
											2016-09-21 11:28:38 +08:00
+								title: Tooltip
-												docs: update documentation format

											
										
										
											2016-03-31 14:17:09 +08:00
+								---
-												挖坑

											
										
										
											2015-05-27 15:43:29 +08:00
-												Add Tooltip

											
										
										
											2015-06-03 17:08:43 +08:00
+								简单的文字提示气泡框。
-												挖坑

											
										
										
											2015-05-27 15:43:29 +08:00
-												Add Tooltip

											
										
										
											2015-06-03 17:08:43 +08:00
+								## 何时使用
-												挖坑

											
										
										
											2015-05-27 15:43:29 +08:00
-												update index.md

											
										
										
											2015-06-03 17:48:52 +08:00
+								鼠标移入则显示提示，移出消失，气泡浮层不承载复杂文本和操作。
-												update popover and tooltip readme

											
										
										
											2015-06-17 17:10:10 +08:00
+								可用来代替系统默认的 `title` 提示，提供一个`按钮/文字/操作`的文案解释。
-												tooltip API

											
										
										
											2015-06-03 17:52:44 +08:00
 								## API
-												docs: sort api table

											
										
										
											2017-10-25 10:25:44 +08:00
+								| 参数 | 说明 | 类型 | 默认值 |
 								| --- | --- | --- | --- |
-												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 | 提示文字 | string\|ReactNode\|() => ReactNode | 无 |
-												docs: update docs for Tooltip Popconfirm Popover

											
										
										
											2016-12-22 12:00:57 +08:00
 								### 共同的 API
 								以下 API 为 Tooltip、Popconfirm、Popover 共享的 API。
-												docs: sort api table

											
										
										
											2017-10-25 10:25:44 +08:00
+								| 参数 | 说明 | 类型 | 默认值 |
 								| --- | --- | --- | --- |
-												docs: Unify type naming (#4636)

* Unify name of ReactNode type in document

* Lowser all string type name

* Lowercase all number type name

* Lowercase all boolean type name

* Unify array type

* Lowercase all object type name

* Unify mutilple types

											
										
										
											2017-01-20 20:10:50 +08:00
+								| arrowPointAtCenter | 箭头是否指向目标元素中心，`antd@1.11+` 支持 | boolean | `false` |
-												docs: sort api table

											
										
										
											2017-10-25 10:25:44 +08:00
+								| autoAdjustOverflow | 气泡被遮挡时自动调整位置 | boolean | `true` |
-												docs: Sort api table

											
										
										
											2017-12-29 20:22:58 +08:00
+								| defaultVisible | 默认是否显隐 | boolean | false |
-												doc: remove old usage instruction

											
										
										
											2018-09-14 11:31:53 +08:00
+								| getPopupContainer | 浮层渲染父节点，默认渲染到 body 上 | Function(triggerNode) | () => document.body |
-												docs: update docs for Tooltip, close: #4724

											
										
										
											2017-01-26 10:56:24 +08:00
+								| mouseEnterDelay | 鼠标移入后延时多少才显示 Tooltip，单位：秒 | number | 0 |
 								| mouseLeaveDelay | 鼠标移出后延时多少才隐藏 Tooltip，单位：秒 | number | 0.1 |
-												docs: sort api table

											
										
										
											2017-10-25 10:25:44 +08:00
+								| overlayClassName | 卡片类名 | string | 无 |
 								| overlayStyle | 卡片样式 | object | 无 |
 								| placement | 气泡框位置，可选 `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 | 触发行为，可选 `hover/focus/click/contextMenu` | string | hover |
-												docs: sort api table

											
										
										
											2017-10-25 10:25:44 +08:00
+								| visible | 用于手动控制浮层显隐 | boolean | false |
 								| onVisibleChange | 显示隐藏的回调 | (visible) => void | 无 |
-												add/fix tooltip align interface (#12354)

* expose align interface

* typescript fix: tooltip 的 align 部分值支持传百分数参数；更新文档

											
										
										
											2018-09-23 14:01:06 +08:00
+								| align | 该值将合并到 placement 的配置中，设置参考 [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
 								## 注意
-												docs: Oops, no onHover event.

											
										
										
											2017-01-22 15:05:32 +08:00
+								请确保 `Tooltip` 的子元素能接受 `onMouseEnter`、`onMouseLeave`、`onFocus`、`onClick` 事件。