diff --git a/components/affix/demo/basic.md b/components/affix/demo/basic.md index 6f976556be..4dadf3e9ef 100644 --- a/components/affix/demo/basic.md +++ b/components/affix/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 { Affix, Button } from 'antd'; ReactDOM.render( - + , mountNode); ```` diff --git a/components/affix/demo/bottom.md b/components/affix/demo/bottom.md index 7ad5d019a9..f8faf64264 100644 --- a/components/affix/demo/bottom.md +++ b/components/affix/demo/bottom.md @@ -1,16 +1,24 @@ --- order: 2 -title: 下方固定 +title: + zh-CN: 下方固定 + en-US: Bottom --- -固定在屏幕下方 +## zh-CN + +固定在屏幕下方。 + +## en-US + +Affix to bottom. ````jsx import { Affix, Button } from 'antd'; ReactDOM.render( - + , mountNode); ```` diff --git a/components/affix/demo/offset.md b/components/affix/demo/offset.md index ad9b26c5a2..878bbf110a 100644 --- a/components/affix/demo/offset.md +++ b/components/affix/demo/offset.md @@ -1,16 +1,24 @@ --- order: 1 -title: 偏移 +title: + zh-CN: 偏移 + en-US: Offset --- +## zh-CN + 达到一定的偏移量才触发。 +## en-US + +Affix element according to offset value. + ````jsx import { Affix, Button } from 'antd'; ReactDOM.render( - + , mountNode); ```` diff --git a/components/affix/demo/on-change.md b/components/affix/demo/on-change.md index 674ebb4b9f..9b4d005021 100644 --- a/components/affix/demo/on-change.md +++ b/components/affix/demo/on-change.md @@ -1,16 +1,24 @@ --- order: 3 -title: 固定状态改变的回调 +title: + zh-CN: 固定状态改变的回调 + en-US: Callback --- +## zh-CN + 可以获得是否固定的状态。 +## en-US + +Callback with affixed state. + ````jsx import { Affix, Button } from 'antd'; ReactDOM.render( console.log(affixed)}> - + , mountNode); ```` diff --git a/components/affix/index.en-US.md b/components/affix/index.en-US.md new file mode 100644 index 0000000000..8cd7887a92 --- /dev/null +++ b/components/affix/index.en-US.md @@ -0,0 +1,21 @@ +--- +category: Components +type: Other +english: Affix +--- + +Make an element sticky to viewport. + +## When to use + +When user browses a long web page, some content need to sticky to viewport. It is common for menus and actions. + +Please note that Affix should not cover other content in page, especially when the size of viewport is small. + +## API + +| Property | Description | Type | Default | +|--------------|-----------------------|----------|--------------| +| offsetTop | Pixels to offset from top when calculating position of scroll | Number | 0 | +| offsetBottom | Pixels to offset from bottom when calculating position of scroll | Number | - | +| onChange | Callback when affix state is changed | Function(affixed) | - | diff --git a/components/affix/index.md b/components/affix/index.zh-CN.md similarity index 96% rename from components/affix/index.md rename to components/affix/index.zh-CN.md index c8293cbab9..1ac87fcf2e 100644 --- a/components/affix/index.md +++ b/components/affix/index.zh-CN.md @@ -20,4 +20,4 @@ english: Affix |-------------|----------------|--------------------|--------------| | offsetTop | 距离窗口顶部达到指定偏移量后触发 | Number | | | offsetBottom | 距离窗口底部达到指定偏移量后触发 | Number | | -| onChange | 固定状态改变时触发的回调函数 | Function | 无 | +| onChange | 固定状态改变时触发的回调函数 | Function(affixed) | 无 |