Backtop 回到顶部
uni-appH5微信小程序App
回到顶部。页面滚动超过 visibilityHeight 后,右下角显示圆形悬浮按钮,点击平滑滚动回顶部。跨端限制:组件无法监听页面滚动,需由页面在 onPageScroll 中把 scrollTop 传入;回顶通过 uni.pageScrollTo 实现。
何时使用
长列表、长文档页面,方便用户快速回到顶部。
何时不使用
短页面无需使用;有底部 TabBar/固定操作栏时注意 bottom 避让;scroll-view 内部滚动场景请自行监听其 @scroll 并传 scrollTop。
本文档为 uni-app 端组件契约;Web 端同名组件 API 可能略有差异,请以对应包文档为准。下方手机预览实时运行 uni-app H5 演示。
Props
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
scrollTop | number | 0 | 页面当前滚动位置(px),由页面的 onPageScroll 传入(跨端替代 Web 版的 target/window 监听) |
visibilityHeight | number | 200 | 滚动超过该高度(px)后显示按钮 |
right | number | 24 | 距视口右边缘距离(px) |
bottom | number | 48 | 距视口下边缘距离(px) |
duration | number | 300 | 回顶滚动动画时长(ms),0 为立即 |
target | string | "" | 滚动容器选择器(Web 端有效);uni 端等价为 scrollTop prop,滚动目标为页面自身 |
Events
| 名称 | 载荷 | 说明 |
|---|---|---|
click | Event | 点击按钮时触发(随后自动平滑滚动回顶) |
示例
基础用法
vue
<Backtop :scroll-top="300" :visibility-height="100" />自定义位置
vue
<Backtop :scroll-top="300" :visibility-height="100" :right="16" :bottom="96" />结合长列表
vue
<CellGroup>
<Cell title="第 1 条记录" />
<Cell title="第 2 条记录" />
<Cell title="第 3 条记录" />
</CellGroup>
<Backtop :scroll-top="300" :visibility-height="100" />