Skip to main content
Version: Next

Taro.pageScrollTo(option)

Scrolls the screen to the target location

Reference

Type

(option: Option) => void

Parameters

Option

PropertyTypeRequiredDescription
durationnumberNoThe duration of the scrolling animation (in ms)
scrollTopnumberNoScrolls the screen to the target location (in px)
selectorstringNoselector, css selector (rn not support)
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.pageScrollTo({
scrollTop: 0,
duration: 300
})

API Support

APIWeChat Mini-ProgramH5React Native
Taro.pageScrollTo✔️✔️✔️