mirror of
https://github.com/ant-design/ant-design.git
synced 2025-01-22 17:13:27 +08:00
415cc833cf
* docs: correct code iframe values * chore: remove useless migrate script Co-authored-by: lijianan <574980606@qq.com>
34 lines
1.5 KiB
Markdown
34 lines
1.5 KiB
Markdown
---
|
||
category: Components
|
||
title: BackTop
|
||
cover: https://gw.alipayobjects.com/zos/alicdn/tJZ5jbTwX/BackTop.svg
|
||
demo:
|
||
cols: 2
|
||
group: Other
|
||
---
|
||
|
||
`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.
|
||
|
||
## Examples
|
||
|
||
<code src="./demo/basic.tsx">Basic</code>
|
||
<code src="./demo/custom.tsx" iframe="400">Custom style</code>
|
||
|
||
## API
|
||
|
||
> The distance to the bottom is set to `50px` by default, which is overridable.
|
||
>
|
||
> If you decide to use custom styles, please note the size limit: no more than `40px * 40px`.
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| ---------------- | --------------------------------------------------------------------------- | ----------------- | ------------ | ------- |
|
||
| duration | Time to return to top（ms） | number | 450 | 4.4.0 |
|
||
| 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 | - | |
|