ant-design/components/back-top/index.en-US.md
MuYu fb0b4f0fc9 docs: show version Number features were added (#17373)
* docs: add api first appearance

* docs: fix auto-complete doc

* docs: replace Version Added with Version

* docs: date picker common method

* docs: date picker common method

* docs: tree

* docs: remove meaningless 3.0.0
2019-07-11 14:14:33 +08:00

838 B

category type title
Components Other BackTop

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.

If you decide to use custom styles, please note the size limit: no more than 40px * 40px.

Property Description Type Default Version
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 -