ant-design/components/back-top/index.en-US.md
偏右 882cec62d6
docs: 🌈 Add Components overview page (#24491)
* docs: Add components overview page

* fix detail

* remove ContributorsList form overview page

* fix components url

* improve code style

* remove extra file

* fix detail

* fix lint

* fix lint

* docs: Finish components overview page

* fix lint

* docs: Update cover

* fix lint

* update cover

* update menu

* improve overview page

* refactor code

* fix order

* update title

* add components count

* fix overview page ssr bug

* move less file

* update title margin

Co-authored-by: arvinxx <arvinx@foxmail.com>
2020-05-31 11:48:34 +08:00

907 B

category type title cover
Components Other BackTop https://gw.alipayobjects.com/zos/alicdn/Ji3PnAAMT/BackTop.svg

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 -