Skip to content

LimeBackTop

  • 用于当页面过长往下滑动时,帮助用户快速回到页面顶部,兼容uniapp/uniappx。
  • 插件依赖lime-shared,lime-style,lime-icon不喜勿下

安装

在市场导入插件即可在任意页面使用

注意

  • 🔔 本插件依赖的lime-svg在 uniapp x app中是原生插件,如果购买(收费为5元)则需要自定义基座,才能使用!uniapp可忽略。
  • 🔔 不需要lime-svg在lime-icon代码中注释掉即可
html
// lime-icon/components/l-icon.uvue 第4行 注释掉即可。
<!-- <l-svg class="l-icon" :class="classes" :style="styles" :color="color" :src="iconUrl" v-else :web="web" @error="imageError" @load="imageload" @click="$emit('click')"></l-svg> -->

使用

  • 提供简单的使用示例,更多请查看下方的demo
html

<l-back-top text="顶部" />

<!-- uvue 如果父级是scroll-view 直接使用 -->
<l-back-top text="顶部"></l-back-top>

<!-- uvue 如果父级是list-view 须放在sticky-header节点里 -->
<sticky-header>
	<l-back-top text="顶部"></l-back-top>
</sticky-header>

小程序

注意 由于uniappx对所有的元素都是默认是相对定位position: relative;必须保证插件是在页面的根节点。或者监听页面的滚动事件把scrollTop传给插件

html
<!-- 方式1:根节点 必须为页面 -->
<l-back-top text="顶部" />


<!-- 方式2:监听页面的滚动事件 把scrollTop传给插件 -->
<l-back-top text="顶部" :scrollTop="scrollTop"/>

形状

  • shape: 有circle,square
html
<l-back-top shape="circle"></l-back-top>

距离显示

  • 当页面滚动到指定offset高度后显示,默认200
html
<l-back-top shape="circle" :offset="300"></l-back-top>

查看示例

  • 导入后直接使用这个标签查看演示效果
html
 // 代码位于 uni_modules/lime-back-top/compoents/lime-back-top 
<lime-back-top />

插件标签

  • 默认 l-back-top 为 component
  • 默认 lime-back-top 为 demo

关于vue2的使用方式

  • 插件使用了composition-api, 如果你希望在vue2中使用请按官方的教程vue-composition-api配置
  • 关键代码是: 在main.js中 在vue2部分加上这一段即可.
js
// vue2
import Vue from 'vue'
import VueCompositionAPI from '@vue/composition-api'
Vue.use(VueCompositionAPI)

API

Props

参数说明类型默认值
icon图标。值为 false 表示不显示图标。不传表示使用默认图标 'bx:arrow-to-top'string``
text方案string``
fixed是否绝对定位固定到屏幕右下方boolean true
duration回到顶部所需时间(ms), nvue无效number100
offset页面垂直滚动多高后出现, nvue无效number200
targetnvue需要定位滚动到指定对象,uvue需要指定容器的IDstring``
shape形状: circlesquarestringcircle

Events

参数说明参数
click点击触发-

CSS 变量

组件提供了下列 CSS 变量,可用于自定义样式。

名称默认值描述
--l-back-top-font-size24rpx-
--l-back-top-icon-size40rpx-
--l-back-top-text-colorrgba(0,0,0,0.65)-
--l-back-top-bg-color#fff-
--l-back-top-border-color#d9d9d9-

打赏

如果你觉得本插件,解决了你的问题,赠人玫瑰,手留余香。

源代码

组件源码