开启下拉刷新

在uni-app中有两种方式开启下拉刷新
需要在pages.json里,找到的当前页面的pages节点,并在style选项中开启enablePullDownRefresh
通过调用**uni.startPullDownRefresh**方法来开启下拉刷新

通过配置文件开启

在 js 中定义 onPullDownRefresh 处理函数(和onLoad等生命周期函数同级),监听该页面用户下拉刷新事件。

  • 需要在 pages.json 里,找到的当前页面的pages节点,并在 style 选项中开启 enablePullDownRefresh。
  • 当处理完数据刷新后,uni.stopPullDownRefresh 可以停止当前页面的下拉刷新。

image.png

通过API开启

uni.startPullDownRefresh(OBJECT)

开始下拉刷新,调用后触发下拉刷新动画,效果与用户手动下拉刷新一致。
OBJECT 参数说明

参数名 类型 必填 说明
success Function 否 接口调用成功的回调
fail Function 否 接口调用失败的回调函数
complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行)

success 返回参数说明

参数 类型 说明
errMsg String 接口调用结果

监听下拉刷新

onPullDownRefresh

image.png

关闭下拉刷新

uni.stopPullDownRefresh()

停止当前页面下拉刷新。
示例
pages.json

  1. {
  2. "pages": [
  3. {
  4. "path": "pages/index/index",
  5. "style": {
  6. "navigationBarTitleText": "uni-app",
  7. "enablePullDownRefresh": true
  8. }
  9. }
  10. ],
  11. "globalStyle": {
  12. "navigationBarTextStyle": "white",
  13. "navigationBarBackgroundColor": "#0faeff",
  14. "backgroundColor": "#fbf9fe"
  15. }
  16. }

index.vue

  1. // 仅做示例,实际开发中延时根据需求来使用。
  2. export default {
  3. data() {
  4. return {
  5. text: 'uni-app'
  6. }
  7. },
  8. onLoad: function (options) {
  9. setTimeout(function () {
  10. console.log('start pulldown');
  11. }, 1000);
  12. uni.startPullDownRefresh();
  13. },
  14. onPullDownRefresh() {
  15. console.log('refresh');
  16. setTimeout(function () {
  17. uni.stopPullDownRefresh();
  18. }, 1000);
  19. }
  20. }

注意

  • 支付宝小程序startPullDownRefresh在开发者工具里会提示暂未开放,请勿使用
  • 支付宝小程序startPullDownRefresh请使用真机调试(非真机预览)
  • 后续支付宝小程序开发工具更新可能会有所修改

案例

  1. <template>
  2. <view>
  3. <view class="box">
  4. 这是列表页
  5. </view>
  6. <view class="box" v-for="item in list">
  7. {{item}}
  8. </view>
  9. <button type="default" @click="pullDown">下拉刷新</button>
  10. </view>
  11. </template>
  12. <script>
  13. export default {
  14. data() {
  15. return {
  16. list:['前端','java','vue','php','python']
  17. }
  18. },
  19. methods: {
  20. pullDown(){
  21. uni.startPullDownRefresh()
  22. }
  23. },
  24. onPullDownRefresh() {
  25. console.log('触发页面刷新')
  26. setTimeout(()=>{
  27. this.list = ['java','ui','web','php']
  28. uni.stopPullDownRefresh()
  29. },2000)
  30. }
  31. }
  32. </script>
  33. <style>
  34. </style>

FAQ

Q:如何暂时禁用掉下拉刷新,待需要的时候再重新开启?
A:App 平台下可以处理此类场景,详细参考:uni-app 中实现动态禁用/开启下拉刷新

Q:自定义title如何让下拉刷新在title之下
A:App和H5端使用circle方式的下拉刷新,设offset在title高度之下。hello uni-app的模板-导航栏中有示例。小程序端无法实现,除非放弃原生下拉刷新,自己模拟下拉刷新,插件市场有类似插件,但性能不如原生下拉刷新。

Q:如何自定义下拉刷新样式
A:小程序端的原生下拉刷新样式是固定的;App端原生的下拉刷新有2种样式可选择,下拉漏出雪花和下拉circle圈。如果使用nvue,可以使用refresh组件自定义下拉刷新,都是原生渲染。如果想使用scroll-view在前端实现自定义下拉刷新,需要注意列表不可太长和太复杂,否则会有性能问题。插件市场搜索下拉刷新有示例。