mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-02 20:19:44 +08:00
e027cbec1c
* chore: add prettier-ignore in markdown demo * docs: format markdown api table * docs: format markdown api table
1.1 KiB
1.1 KiB
category | title | cover | demo | group | ||
---|---|---|---|---|---|---|
Components | BackTop | https://gw.alipayobjects.com/zos/alicdn/tJZ5jbTwX/BackTop.svg |
|
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
Basic
Custom style
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 | - |