小程序滚动加载优化方案

发布于2023年6月22日 15:32:33 ,最后一次修改于2023年11月17日 12:25:28

微信小程序滚动加载拓展组件,对官方方案进行了以下优化:

  • 减少重复去写分页加载函数和分页逻辑
  • 支持长列表虚拟渲染
  • 优化删除子项无刷新交互

使用

  1. 安装组件
npm i mini-scrolling-loading --save
  1. 在页面的 json 配置文件中添加 mini-scrolling-loading 自定义组件的配置
{
  "usingComponents": {
    "mini-scrolling-loading": "mini-scrolling-loading/index",
    "scrolling-item": "/components/scroll-item/index"
  }
}

scrolling-item(组建名可自定义)组建为开发者自定义的列表单个item样式组建,mini-scrolling-loading采用抽象节点方式进行渲染,例如:

组建.wxml

{{item.title}}

组建.ts

Component({
    properties: {
        item: Object  // 变量名需使用item
    },
    methods: {
        delItem(e: { mark: { id: number}}) {
            const {id} = e.mark
            this.triggerEvent('delItem', {id}) // 如果有使用删除,在删除成功后,需派发delItem事件,传入删除的主键id即可,组建会无刷新更新列表。
        }
    }
})

3.WXML 文件中引用 mini-scrolling-loading


mini-scrolling-loading属性介绍

字段名 类型 必填 默认值 描述
api Function - API接口请求Promise函数
page Number 1 分页
perpage Number 10 页码
perpageKey String perpage 分页参数字段,例如pageSize
idKey String id 能代表唯一标识的字段名
resKey String data 接口返回的data路径
totalKey String total 数据量总数
query Object {} 查询额外字段参数
height String 100vh 可视容器高度
itemHeight number 40 单个Item高度,单位px
enUpper Boolean false 开启下拉刷新
success Function { totalCount: number, data: []} api 请求成功返回
error Function - api请求失败回调
delSuccess Function - 删除成功回调
sprops Object {} 抽象节点的props集合
sEvent Function - 抽象节点派发事件委托

Demo

用微信开发者工具导入以下代码片段:

https://developers.weixin.qq.com/s/r4BBrfmF7NIF

虚拟列表原理图示

虚拟列表

https://i.imgur.com/wbODRGR.png

Demo

demo

https://i.imgur.com/vRi9SfG.gif

分页删除数据无刷新图示

删除元素

https://i.imgur.com/3NfXmrV.png

外部样式

类名 描述
custom-class 根结点样式

slot

name 描述
loading 加载中
loading-finish 加载结束
empty 暂无数据占位

方法

通过 selectComponent 可以获取到 mini-scrolling-loading 实例并调用实例方法。

方法名 参数 返回值 介绍
refreshData - - 刷新列表
getResData - object[] 获取接口返回值
getResTotal - number 获取总数

备注

针对抽象子组件如果设计业务交互逻辑较为复杂,因微信抽象节点功能限制,不建议使用此组件去实现。

Github地址

https://github.com/WGinit/mini-scrolling-loading

本文共 6 个回复

发表评论