diff --git a/components/tooltip/demo/basic.md b/components/tooltip/demo/basic.md index 29eeea7de1..d5cbdc1ed7 100644 --- a/components/tooltip/demo/basic.md +++ b/components/tooltip/demo/basic.md @@ -1,16 +1,24 @@ --- order: 0 -title: 基本 +title: + zh-CN: 基本 + en-US: Basic --- +## zh-CN + 最简单的用法。 +## en-US + +The simplest usage. + ````jsx import { Tooltip } from 'antd'; ReactDOM.render( - - 鼠标移上来就会出现提示 + + Text will show when mouse enter. , mountNode); ```` diff --git a/components/tooltip/demo/placement.md b/components/tooltip/demo/placement.md index b885510f3c..3913789bef 100644 --- a/components/tooltip/demo/placement.md +++ b/components/tooltip/demo/placement.md @@ -1,58 +1,66 @@ --- order: 1 -title: 位置 +title: + zh-CN: 位置 + en-US: Placement --- +## zh-CN + 位置有 12 个方向。 +## en-US + +The ToolTip has 12 placements choice. + ````jsx import { Tooltip } from 'antd'; -const text = 提示文字; +const text = prompt text; ReactDOM.render(
- 上左 + topLeft - 上边 + top - 上右 + topRight
- 左上 + leftTop - 左边 + left - 左下 + leftBottom
- 右上 + rightTop - 右边 + right - 右下 + rightBottom
- 下左 + bottomLeft - 下边 + bottom - 下右 + bottomRight
diff --git a/components/tooltip/index.en-US.md b/components/tooltip/index.en-US.md new file mode 100644 index 0000000000..909e4ee78d --- /dev/null +++ b/components/tooltip/index.en-US.md @@ -0,0 +1,23 @@ +--- +category: Components +type: Views +title: Tooltip +--- + +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 a explain of `button/text/opration`, that can cover the usage of the default system `title`. + +## API + +| 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 | +| title | prompt text | string/React.Element | - | +| getTooltipContainer | to set the container of the tip, while the default is to create a `div` element in `body` | Function(triggerNode) | () => document.body | + +You can visit https://github.com/react-component/tooltip for more API. diff --git a/components/tooltip/index.md b/components/tooltip/index.zh-CN.md similarity index 100% rename from components/tooltip/index.md rename to components/tooltip/index.zh-CN.md