Browse Source

docs: update docs for Tooltip, close: #4724

pull/4727/head
Benjy Cui 8 years ago
parent
commit
879bc9320c
  1. 2
      components/tooltip/index.en-US.md
  2. 2
      components/tooltip/index.tsx
  3. 2
      components/tooltip/index.zh-CN.md

2
components/tooltip/index.en-US.md

@ -28,6 +28,8 @@ The following APIs are shared by Tooltip, Popconfirm, Popover.
| arrowPointAtCenter | whether arrow pointed at the center of target, supported after `antd@1.11+` | boolean | `false` | | arrowPointAtCenter | whether arrow pointed at the center of target, supported after `antd@1.11+` | boolean | `false` |
| visible | make the float card visible or not | boolean | false | | visible | make the float card visible or not | boolean | false |
| onVisibleChange | callback of the visible attribute changed | (visible) => void | none | | onVisibleChange | callback of the visible attribute changed | (visible) => void | none |
| mouseEnterDelay | delay time to show when mouse enter.unit: s | number | 0 |
| mouseLeaveDelay | delay time to hide when mouse leave.unit: s | number | 0.1 |
| trigger | triggering mode: can be hover, focus, or click. | string | hover | | trigger | triggering mode: can be hover, focus, or click. | string | hover |
| overlayClassName | class name of the card | string | none | | overlayClassName | class name of the card | string | none |
| overlayStyle | style of the card | object | none | | overlayStyle | style of the card | object | none |

2
components/tooltip/index.tsx

@ -18,6 +18,8 @@ export interface AbstractTooltipProps {
builtinPlacements?: Object; builtinPlacements?: Object;
visible?: boolean; visible?: boolean;
onVisibleChange?: (visible: boolean) => void; onVisibleChange?: (visible: boolean) => void;
mouseEnterDelay?: number;
mouseLeaveDelay?: number;
transitionName?: string; transitionName?: string;
trigger?: 'hover' | 'focus' | 'click'; trigger?: 'hover' | 'focus' | 'click';
openClassName?: string; openClassName?: string;

2
components/tooltip/index.zh-CN.md

@ -30,6 +30,8 @@ title: Tooltip
| arrowPointAtCenter | 箭头是否指向目标元素中心,`antd@1.11+` 支持 | boolean | `false` | | arrowPointAtCenter | 箭头是否指向目标元素中心,`antd@1.11+` 支持 | boolean | `false` |
| visible | 用于手动控制浮层显隐 | boolean | false | | visible | 用于手动控制浮层显隐 | boolean | false |
| onVisibleChange | 显示隐藏的回调 | (visible) => void | 无 | | onVisibleChange | 显示隐藏的回调 | (visible) => void | 无 |
| mouseEnterDelay | 鼠标移入后延时多少才显示 Tooltip,单位:秒 | number | 0 |
| mouseLeaveDelay | 鼠标移出后延时多少才隐藏 Tooltip,单位:秒 | number | 0.1 |
| trigger | 触发行为,可选 `hover/focus/click` | string | hover | | trigger | 触发行为,可选 `hover/focus/click` | string | hover |
| overlayClassName | 卡片类名 | string | 无 | | overlayClassName | 卡片类名 | string | 无 |
| overlayStyle | 卡片样式 | object | 无 | | overlayStyle | 卡片样式 | object | 无 |

Loading…
Cancel
Save