Skip to main content
Version: Next

Taro.startPullDownRefresh(option)

Starts swipe-down-to-refresh. The swipe-down-to-refresh animation is triggered after the call, which performs consistently with swipe-down-to-refresh by users.

Reference

Type

(option?: Option) => Promise<CallbackResult>

Parameters

Option

PropertyTypeRequiredDescription
complete(res: CallbackResult) => voidNoThe callback function used when the API call completed (always executed whether the call succeeds or fails)
fail(res: CallbackResult) => voidNoThe callback function for a failed API call
success(res: CallbackResult) => voidNoThe callback function for a successful API call

Sample Code

Taro.startPullDownRefresh()

API Support

APIWeChat Mini-ProgramH5React Native
Taro.startPullDownRefresh✔️✔️✔️(No animation effects)