如何下载demo
- 以下基本使用均为选项式api写法,若需要查询组合式api(setup)写法,请查阅demo
- 👉🏻(demo)示例项目下载
# 基本使用
- ①在
<template>
中使用@query绑定js中分页请求的方法(z-paging
会将计算好的pageNo和pageSize两个参数传递到此方法中),然后通过v-model
绑定列表for循环的list。 - ②在请求结果回调中,通过调用
z-paging
的complete()
方法,将请求返回的数组传递给z-paging
处理,如:this.$refs.paging.complete(服务器返回的数组);
;若请求失败,调用:this.$refs.paging.complete(false);
即可。 - 当tab切换或搜索时,可以通过
this.$refs.paging.reload()
刷新整个列表。 - 在nvue中,z-paging中插入的列表item(z-paging的直接子view)必须是cell,必须使用cell包住,因为在nvue中,z-paging使用的是nvue的list组件,具体请查阅demo中的
common-demo-n.vue
示例。
<template>
<z-paging ref="paging" v-model="dataList" @query="queryList">
<view class="item" v-for="(item,index) in dataList" :key="index">
<view class="item-title">{{item.title}}</view>
</view>
</z-paging>
</template>
<script>
export default {
data() {
return {
dataList: []
};
},
methods: {
queryList(pageNo, pageSize) {
// 这里的pageNo和pageSize会自动计算好,直接传给服务器即可
// 这里的请求只是演示,请替换成自己的项目的网络请求,并在网络请求回调中通过this.$refs.paging.complete(请求回来的数组)将请求结果传给z-paging
this.$request.queryList({ pageNo,pageSize }).then(res => {
// 请勿在网络请求回调中给dataList赋值!!只需要调用complete就可以了
this.$refs.paging.complete(res.data.list);
}).catch(res => {
// 如果请求失败写this.$refs.paging.complete(false),会自动展示错误页面
// 注意,每次都需要在catch中写这句话很麻烦,z-paging提供了方案可以全局统一处理
// 在底层的网络请求抛出异常时,写uni.$emit('z-paging-error-emit');即可
this.$refs.paging.complete(false);
})
}
},
};
</script>
<style scoped>
</style>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# 仅使用下拉刷新示例
<template>
<z-paging ref="paging" refresher-only @onRefresh="onRefresh">
<!-- 页面内容 -->
</z-paging>
</template>
<script>
export default {
methods: {
// 下拉刷新被触发
onRefresh() {
// 告知z-paging下拉刷新结束,这样才可以开始下一次的下拉刷新
setTimeout(() => {
// 1.5秒之后停止刷新动画
this.$refs.paging.complete();
}, 1500)
},
},
};
</script>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# 设置自定义emptyView组件示例
# 设置自定义emptyView组件,非必须。空数据时会自动展示空数据组件,不需要自己处理
# 自定义加载更多各个状态的描述文字示例
# 以修改【没有更多了】状态描述文字为例(将默认的"没有更多了"修改为"我也是有底线的!")
<z-paging ref="paging" v-model="dataList" loading-more-no-more-text="我也是有底线的!" @query="queryList">
<!-- 设置自己的emptyView组件,非必须。空数据时会自动展示空数据组件,不需要自己处理 -->
<view class="item" v-for="(item,index) in dataList" :key="index">
<view class="item-title">{{item.title}}</view>
</view>
</z-paging>
1
2
3
4
5
6
2
3
4
5
6
# 自定义下拉刷新view示例
# use-custom-refresher
需要设置为true(默认为true),此时将不会使用uni自带的下拉刷新,转为使用z-paging自定义的下拉刷新,通过slot可以插入开发者自定义的下拉刷新view。
# 自定义加载更多各个状态的描述view示例
# 以修改【没有更多了】状态描述view为例
# 使用页面滚动示例
# 虚拟列表示例
# i18n示例
- 请参照demo:
i18n-demo.vue
# 本地分页示例
<!-- 本地分页示例 -->
<template>
<z-paging ref="paging" v-model="dataList" @query="queryList">
<view class="item" v-for="(item,index) in dataList">
<view class="item-title">{{item.title}}</view>
</view>
</z-paging>
</template>
<script>
export default {
data() {
return {
dataList: []
};
},
methods: {
queryList() {
// 这里的请求只是演示,请替换成自己的项目的网络请求
this.$request.queryList({ pageNo,pageSize }).then(res => {
// 设置本地分页并将数据传给z-paging
this.$refs.paging.setLocalPaging(res.data.list);
})
}
},
};
</script>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# 数据缓存示例
<!-- 设置数据缓存示例 -->
<template>
<z-paging ref="paging" v-model="dataList" use-cache cache-key="goodsList" @query="queryList">
<view class="item" v-for="(item,index) in dataList">
<view class="item-title">{{item.title}}</view>
</view>
</z-paging>
</template>
<script>
// 与普通模式一致,略
</script>
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12