diff --git a/components/tooltip/index.en-US.md b/components/tooltip/index.en-US.md index 1448af6846..47f233ae61 100644 --- a/components/tooltip/index.en-US.md +++ b/components/tooltip/index.en-US.md @@ -8,14 +8,14 @@ A simple text popup tip. ## When To Use -- The tip shows while mouse enter, and hides while mouse leave. The Tooltip doesn't support complex text and operation. -- It can provide an explanation of `button/text/operation` that can cover the usage of the default system `title`. +- 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 | prompt text | string/React.Element | - | +| title | The text shown in the tooltip | string\|React.Element | - | ### Common API @@ -23,19 +23,19 @@ The following APIs are shared by Tooltip, Popconfirm, Popover. | Property | Description | Type | Default | |-----------|------------------------------------------|------------|--------| -| placement | to set the position, which can be one of `top` `left` `right` `bottom` `topLeft` `topRight` `bottomLeft` `bottomRight` `leftTop` `leftBottom` `rightTop` `rightBottom` | string | top | -| getPopupContainer | to set the container of the tip, while the default is to create a `div` element in `body`. Use `getTooltipContainer` if you are using `antd@<2.5.2` | Function(triggerNode) | () => document.body | -| arrowPointAtCenter | whether arrow pointed at the center of target, supported after `antd@1.11+` | boolean | `false` | -| autoAdjustOverflow | whether adjust popup placement automatically when popup is invisible | boolean | `true` | -| visible | make the float card visible or not | boolean | false | -| 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 | -| overlayClassName | class name of the card | string | none | -| overlayStyle | style of the card | object | none | +| 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` | +| getPopupContainer | The DOM container of the tip, the default behavior is to create a `div` element in `body`. Use `getTooltipContainer` if you are using `antd@<2.5.2` | Function(triggerNode) | () => document.body | +| 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` | +| 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 | - | +| mouseEnterDelay | Delay in seconds, before tooltip is shown on mouse enter | number | 0 | +| mouseLeaveDelay | Delay in seconds, before tooltip is hidden on mouse leave | number | 0.1 | +| trigger | Tooltip trigger mode | `hover` \| `focus` \| `click` | `hover` | +| overlayClassName | Class name of the tooltip card | string | - | +| overlayStyle | Style of the tooltip card | object | - | ## Note -Please ensure that the child node of `Tooltip` accepts `onMouseEnter`, `onMouseLeave`, `onFocus`, `onClick` event. +Please ensure that the child node of `Tooltip` accepts `onMouseEnter`, `onMouseLeave`, `onFocus`, `onClick` events.