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

45 lines
1.9 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
2016-09-21 11:28:38 +08:00
subtitle: 文字提示
type: 数据展示
2016-09-21 11:28:38 +08:00
title: Tooltip
2016-03-31 14:17:09 +08:00
---
2015-05-27 15:43:29 +08:00
2015-06-03 17:08:43 +08:00
简单的文字提示气泡框。
2015-05-27 15:43:29 +08:00
2015-06-03 17:08:43 +08:00
## 何时使用
2015-05-27 15:43:29 +08:00
2015-06-03 17:48:52 +08:00
鼠标移入则显示提示,移出消失,气泡浮层不承载复杂文本和操作。
2015-06-17 17:10:10 +08:00
可用来代替系统默认的 `title` 提示,提供一个`按钮/文字/操作`的文案解释。
2015-06-03 17:52:44 +08:00
## API
2017-10-25 10:25:44 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| title | 提示文字 | string\|ReactNode\|() => ReactNode | 无 |
### 共同的 API
以下 API 为 Tooltip、Popconfirm、Popover 共享的 API。
2017-10-25 10:25:44 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| arrowPointAtCenter | 箭头是否指向目标元素中心,`antd@1.11+` 支持 | boolean | `false` |
2017-10-25 10:25:44 +08:00
| autoAdjustOverflow | 气泡被遮挡时自动调整位置 | boolean | `true` |
2017-12-29 20:22:58 +08:00
| defaultVisible | 默认是否显隐 | boolean | false |
2018-09-14 11:31:53 +08:00
| getPopupContainer | 浮层渲染父节点,默认渲染到 body 上 | Function(triggerNode) | () => document.body |
| mouseEnterDelay | 鼠标移入后延时多少才显示 Tooltip单位秒 | number | 0 |
| mouseLeaveDelay | 鼠标移出后延时多少才隐藏 Tooltip单位秒 | number | 0.1 |
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 |
2018-03-06 15:21:37 +08:00
| trigger | 触发行为,可选 `hover/focus/click/contextMenu` | string | hover |
2017-10-25 10:25:44 +08:00
| visible | 用于手动控制浮层显隐 | boolean | false |
| onVisibleChange | 显示隐藏的回调 | (visible) => void | 无 |
| align | 该值将合并到 placement 的配置中,设置参考 [rc-tooltip](https://github.com/react-component/tooltip) | Object | 无 |
## 注意
2017-01-22 15:05:32 +08:00
请确保 `Tooltip` 的子元素能接受 `onMouseEnter`、`onMouseLeave`、`onFocus`、`onClick` 事件。