Skip to content

Backtop 回到顶部

查看 sn-backtop 的 2.0 版本差异

基础用法

  • 用于长页面或长列表:滚动超过阈值(top,单位 px)后,右下角浮现回到顶部按钮,点击后平滑滚动回顶部。
  • 自动绑定滚动容器:直接放在 sn-pagesn-scroll-viewsn-list-viewsn-waterflow 的同级或父级下即可,无需额外配置;也可通过 target 显式指定绑定目标。
  • 绑定 sn-page(页面级滚动)时按钮采用 fixed 定位,绑定容器内滚动时采用 absolute 定位。
vue
<template>
	<sn-page>
		<sn-backtop></sn-backtop>
	</sn-page>
</template>

更多演示请下载 demo 查看

绑定指定容器

target 可传滚动容器组件的 ref 名,或滚动容器元素的 id(Web 端也可传选择器)。为空时自动查找:先同级后父级。

vue
<template>
	<sn-scroll-view ref="scrollRef" class="scroll-box">
		<sn-backtop target="scrollRef"></sn-backtop>
	</sn-scroll-view>
</template>

自定义样式

图标、形状、主题类型与等级、背景色、尺寸、位置、动画时长均可自定义;设置 bg-color 后覆盖 typelevel 推导出的主题色。

vue
<template>
	<sn-backtop type="warning" level="second" icon="arrow-up-line" size="60px" :right="90" :bottom="110"></sn-backtop>
	<sn-backtop type="info" shape="square" :right="160" :bottom="110"></sn-backtop>
</template>

属性

参数说明类型默认值可选值
icon按钮内部图标Stringskip-up-line-
shape按钮形状Stringcirclecircle | square
type主题样式类型Stringprimaryinfo | primary | success | error | warning
level等级,与 type 共同推导背景色和图标色Stringfirstfirst | second | third | least
bgColor自定义背景颜色,设置后覆盖 typelevel 的主题色String''-
iconColor图标颜色,为空时按 type / level 配色矩阵推导String''-
iconSize图标大小(支持 $ 简写),为空时为 20px × 字体乘数String | Number''-
size按钮尺寸(支持 $ 简写),圆形按钮圆角为尺寸的一半String | Number50px-
zIndex按钮 z-index 层级Number991-
aniTime显示/隐藏过渡动画时长(支持 $ 简写),为空时使用框架标准动画时长String | Number''-
top滚动距离超过该值(单位 px)时显示按钮Number400-
right按钮距右边界距离(单位 px)Number30-
bottom按钮距下边界距离(单位 px)Number100-
disabled是否禁用,禁用时按钮变灰且不可点击Booleanfalsetrue | false
target绑定目标:父作用域中滚动容器组件的 ref 名,或滚动容器元素 id/选择器;为空自动查找String''-
customStyle自定义按钮样式UTSJSONObject | String''-
customClass自定义按钮外部样式类String''-
externalStyle额外内联样式UTSJSONObject | String''-
externalClass额外外部样式类String''-

事件

名称类型说明
click(e: UniPointerEvent) => Void点击按钮时触发(先执行回到顶部滚动,禁用时不触发)

使用 MIT 协议