BackTop 回到顶部

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

何时使用

  • 当页面内容区域比较长时;
  • 当用户需要频繁返回顶部查看相关内容时。

代码演示

基本

最简单的用法。

BackTop回到顶部 - 图1

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { BackTop } from 'choerodon-ui';
  4. ReactDOM.render(
  5. <div>
  6. <BackTop />
  7. Scroll down to see the bottom-right
  8. <strong style={{ color: 'rgba(64, 64, 64, 0.6)' }}> gray </strong>
  9. button.
  10. </div>,
  11. document.getElementById('container'),
  12. );

自定义样式

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

BackTop回到顶部 - 图2

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { BackTop } from 'choerodon-ui';
  4. ReactDOM.render(
  5. <div>
  6. <BackTop>
  7. <div className="c7n-back-top-inner">UP</div>
  8. </BackTop>
  9. Scroll down to see the bottom-right
  10. <strong style={{ color: '#1088e9' }}> blue </strong>
  11. button.
  12. </div>,
  13. document.getElementById('container'),
  14. );

API

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

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

参数说明类型默认值
target设置需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数Function() => window
visibilityHeight滚动高度达到此参数值才出现 BackTopnumber400
onClick点击按钮的回调函数Function-