|
|
|
|
---
|
|
|
|
|
category: Components
|
|
|
|
|
subtitle: 回到顶部
|
|
|
|
|
title: BackTop
|
|
|
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/tJZ5jbTwX/BackTop.svg
|
|
|
|
|
demo:
|
|
|
|
|
cols: 2
|
|
|
|
|
group: 其他
|
|
|
|
|
demo:
|
|
|
|
|
cols: 2
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
返回页面顶部的操作按钮。
|
|
|
|
|
|
|
|
|
|
## 何时使用
|
|
|
|
|
|
|
|
|
|
- 当页面内容区域比较长时；
|
|
|
|
|
- 当用户需要频繁返回顶部查看相关内容时。
|
|
|
|
|
|
|
|
|
|
## 代码演示
|
|
|
|
|
|
|
|
|
|
<code src="./demo/basic.tsx">基本</code>
|
|
|
|
|
<code src="./demo/custom.tsx">自定义样式</code>
|
|
|
|
|
|
|
|
|
|
## 代码演示
|
|
|
|
|
|
|
|
|
|
<code src="./demo/basic.tsx">基本</code>
|
|
|
|
|
<code src="./demo/custom.tsx">自定义样式</code>
|
|
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
|
|
|
|
|
> 有默认样式，距离底部 `50px`，可覆盖。
|
|
|
|
|
>
|
|
|
|
|
> 自定义样式宽高不大于 40px \* 40px。
|
|
|
|
|
|
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|
|
|
| ---------------- | ------------------------------------------------------------- | ----------------- | ------------ | ----- |
|
|
|
|
|
| duration | 回到顶部所需时间（ms） | number | 450 | 4.4.0 |
|
|
|
|
|
| target | 设置需要监听其滚动事件的元素，值为一个返回对应 DOM 元素的函数 | () => HTMLElement | () => window | |
|
|
|
|
|
| visibilityHeight | 滚动高度达到此参数值才出现 BackTop | number | 400 | |
|
|
|
|
|
| onClick | 点击按钮的回调函数 | function | - | |
|
