ant-design/components/back-top/index.en-US.md
Wei Zhu 77b78a9389 docs: Unify type naming (#4636)
* Unify name of ReactNode type in document

* Lowser all string type name

* Lowercase all number type name

* Lowercase all boolean type name

* Unify array type

* Lowercase all object type name

* Unify mutilple types
2017-01-20 20:10:50 +08:00

719 B

category type title
Components Navigation 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
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 -