ant-design/components/back-top/index.md

24 lines
673 B
Markdown
Raw Normal View History

2016-06-23 23:12:18 +08:00
---
category: Components
chinese: 置顶
type: Other
english: BackTop
---
2016-06-24 13:53:19 +08:00
使用置顶组件可以方便地回到页面顶部。
2016-06-23 23:12:18 +08:00
## 何时使用
2016-06-24 13:53:19 +08:00
- 当页面内容区域比较长时;
- 当用户需要频繁返回顶部查看相关内容时。
2016-06-23 23:12:18 +08:00
## API
> 有默认样式,距离底部 `50px`,可覆盖。
2016-06-24 13:53:19 +08:00
> 自定义样式宽高不大于 40px * 40px。
2016-06-23 23:12:18 +08:00
| 参数 | 说明 | 类型 | 默认值 |
|-------------|----------------|--------------------|--------------|
| visibilityHeight | 滚动高度达到此参数值才出现 `BackTop` | Number | 400 |
| onClick | 点击按钮的回调函数 | Function | - |