BackTop回到顶部

返回页面顶部的操作按钮。

何时使用

  • 当页面内容区域比较长时;

  • 当用户需要频繁返回顶部查看相关内容时。

代码演示

BackTop回到顶部 - 图1

基本

最简单的用法。

  1. import { BackTop } from 'antd';
  2. ReactDOM.render(
  3. <>
  4. <BackTop />
  5. Scroll down to see the bottom-right
  6. <strong className="site-back-top-basic"> gray </strong>
  7. button.
  8. </>,
  9. mountNode,
  10. );
  1. .site-back-top-basic {
  2. color: rgba(64, 64, 64, 0.6);
  3. }

BackTop回到顶部 - 图2

自定义样式

可以自定义回到顶部按钮的样式,限制宽高:40px * 40px

  1. import { BackTop } from 'antd';
  2. const style = {
  3. height: 40,
  4. width: 40,
  5. lineHeight: '40px',
  6. borderRadius: 4,
  7. backgroundColor: '#1088e9',
  8. color: '#fff',
  9. textAlign: 'center',
  10. fontSize: 14,
  11. };
  12. ReactDOM.render(
  13. <div style={{ height: '600vh', padding: 8 }}>
  14. <div>Scroll to bottom</div>
  15. <div>Scroll to bottom</div>
  16. <div>Scroll to bottom</div>
  17. <div>Scroll to bottom</div>
  18. <div>Scroll to bottom</div>
  19. <div>Scroll to bottom</div>
  20. <div>Scroll to bottom</div>
  21. <BackTop>
  22. <div style={style}>UP</div>
  23. </BackTop>
  24. </div>,
  25. mountNode,
  26. );

API

有默认样式,距离底部 50px,可覆盖。

自定义样式宽高不大于 40px * 40px。

参数说明类型默认值版本
duration回到顶部所需时间(ms)number4504.4.0
target设置需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数() => HTMLElement() => window
visibilityHeight滚动高度达到此参数值才出现 BackTopnumber400
onClick点击按钮的回调函数function-