uni-app x

展示全部

# uni.startPullDownRefresh(options?)

开始下拉刷新

# startPullDownRefresh 兼容性

Web	微信小程序	Android	iOS	HarmonyOS	HarmonyOS(Vapor)
4.0	4.41	3.91	4.11	4.61	x

# 参数

名称

类型

必填

默认值

兼容性

描述

options

StartPullDownRefreshOptions

否

名称

类型

必备

默认值

兼容性

描述

success

(result: StartPullDownRefreshSuccess) => void

否

接口调用成功的回调函数

fail

(result: StartPullDownRefreshFail) => void

否

接口调用失败的回调函数

complete

(result: StartPullDownRefreshComplete) => void

否

接口调用结束的回调函数（调用成功、失败都会执行）

# StartPullDownRefreshSuccess 的属性值

名称

类型

必备

默认值

兼容性

描述

errMsg

string

是

# StartPullDownRefreshFail 的属性值

名称

类型

必备

默认值

兼容性

描述

errCode

number

是

下拉刷新错误码
- 4: 框架内部异常

errSubject

string

是

统一错误主题（模块）名称

data

any

否

错误信息中包含的数据

cause

Error

否

源错误信息，可以包含多个错误，详见SourceError

errMsg

string

是

# StartPullDownRefreshComplete 的属性值

名称

类型

必备

默认值

兼容性

描述

errMsg

string

是

# 返回值

类型

必备

Promise<StartPullDownRefreshSuccess>

否

名称

类型

必备

默认值

兼容性

描述

errMsg

string

是

# 参见

# uni.stopPullDownRefresh()

停止当前页面下拉刷新

# stopPullDownRefresh 兼容性

Web	微信小程序	Android	iOS	HarmonyOS	HarmonyOS(Vapor)
4.0	4.41	3.91	4.11	4.61	x

使用：

首先pages.json里配置了页面可下拉刷新"enablePullDownRefresh": true
当用户下拉页面时触发页面生命周期onPullDownRefresh，iOS平台触发时机：当下拉到一定阀值就会触发onPullDownRefresh，并不是当手势拖拽结束时触发
在合适的时机（如联网刷新数据结束），调用本APIuni.stopPullDownRefresh()，结束下拉刷新状态

本API仅负责页面下拉刷新。如使用组件下拉刷新，另见scroll-view、list-view等组件的文档。