BackTop回到顶部
返回页面顶部的操作按钮。
何时使用
当页面内容区域比较长时;
当用户需要频繁返回顶部查看相关内容时。
代码演示
最简单的用法。
import { BackTop } from 'antd';
ReactDOM.render(
<>
<BackTop />
Scroll down to see the bottom-right
<strong className="site-back-top-basic"> gray </strong>
button.
</>,
mountNode,
);
.site-back-top-basic {
color: rgba(64, 64, 64, 0.6);
}
可以自定义回到顶部按钮的样式,限制宽高:40px * 40px
。
import { BackTop } from 'antd';
const style = {
height: 40,
width: 40,
lineHeight: '40px',
borderRadius: 4,
backgroundColor: '#1088e9',
color: '#fff',
textAlign: 'center',
fontSize: 14,
};
ReactDOM.render(
<div style={{ height: '600vh', padding: 8 }}>
<div>Scroll to bottom</div>
<div>Scroll to bottom</div>
<div>Scroll to bottom</div>
<div>Scroll to bottom</div>
<div>Scroll to bottom</div>
<div>Scroll to bottom</div>
<div>Scroll to bottom</div>
<BackTop>
<div style={style}>UP</div>
</BackTop>
</div>,
mountNode,
);
API
有默认样式,距离底部
50px
,可覆盖。自定义样式宽高不大于 40px * 40px。
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
target | 设置需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数 | Function | () => window | |
visibilityHeight | 滚动高度达到此参数值才出现 BackTop | number | 400 | |
onClick | 点击按钮的回调函数 | Function | - |