BackTop

nz-back-top 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.
import { NzBackTopModule } from 'ng-zorro-antd/back-top';

Examples

Scroll down to see the bottom-right gray button.
Basic

The most basic usage.

expand codeexpand code
      Loading...
Scroll down to see the bottom-right gray button.
Using nzTarget

specifies the scrollable area dom node.

expand codeexpand code
      Loading...
Scroll down to see the bottom-right blue button.
Custom style

You can customize the style of the button, just note the size limit: no more than 40px * 40px.

expand codeexpand code
      Loading...

API#

nz-back-top#

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.

PropertyDescriptionTypeDefaultGlobal Config
[nzTemplate]custom contentTemplateRef<void>-
[nzVisibilityHeight]the nz-back-top button will not show until the scroll height reaches this valuenumber400✅
[nzTarget]specifies the scrollable area dom nodestring | Elementwindow
[nzDuration]Time to return to top (ms)number450
(nzClick)a callback function, which can be executed when you click the buttonEventEmitter<boolean>-