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

26 lines
795 B
Markdown
Raw Normal View History

2016-06-23 23:12:18 +08:00
---
category: Components
type: Navigation
2016-09-21 11:28:38 +08:00
subtitle: 回到顶部
title: BackTop
2016-06-23 23:12:18 +08:00
---
2016-07-25 19:37:23 +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-07-11 11:40:20 +08:00
2016-06-24 13:53:19 +08:00
> 自定义样式宽高不大于 40px * 40px。
2016-06-23 23:12:18 +08:00
| 参数 | 说明 | 类型 | 默认值 |
|-------------|----------------|--------------------|--------------|
| visibilityHeight | 滚动高度达到此参数值才出现 `BackTop` | number | 400 |
2016-06-23 23:12:18 +08:00
| onClick | 点击按钮的回调函数 | Function | - |
| target | 设置需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数 | Function | () => window |