2016-07-11 11:40:20 +08:00
|
|
|
|
---
|
|
|
|
|
|
category: Components
|
2017-06-19 11:01:29 +08:00
|
|
|
|
type: Other
|
2016-07-11 11:40:20 +08:00
|
|
|
|
title: BackTop
|
2020-06-05 13:50:09 +08:00
|
|
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/tJZ5jbTwX/BackTop.svg
|
2016-07-11 11:40:20 +08:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
`BackTop` makes it easy to go back to the top of the page.
|
|
|
|
|
|
|
|
|
|
|
|
## When To Use
|
|
|
|
|
|
|
|
|
|
|
|
- When the page content is very long.
|
|
|
|
|
|
- When you need to go back to the top very frequently in order to view the contents.
|
|
|
|
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
|
|
|
|
|
|
|
> The distance to the bottom is set to `50px` by default, which is overridable.
|
2017-10-25 10:25:44 +08:00
|
|
|
|
>
|
2016-07-11 11:40:20 +08:00
|
|
|
|
> If you decide to use custom styles, please note the size limit: no more than `40px * 40px`.
|
|
|
|
|
|
|
2019-07-11 14:14:33 +08:00
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
|
|
|
|
| --- | --- | --- | --- | --- |
|
2020-10-21 10:33:43 +08:00
|
|
|
|
| duration | Time to return to top（ms） | number | 450 | 4.4.0 |
|
2020-07-02 17:26:33 +08:00
|
|
|
|
| target | Specifies the scrollable area dom node | () => HTMLElement | () => window | |
|
|
|
|
|
|
| visibilityHeight | The BackTop button will not show until the scroll height reaches this value | number | 400 | |
|
|
|
|
|
|
| onClick | A callback function, which can be executed when you click the button | function | - | |
|
