tt.pageScrollTo
收藏我的收藏
基础库 1.0.0 开始支持本方法,这是一个异步方法。
滚动当前展示页面(页面栈处于最上层)到目标位置,支持滚动距离和选择器两种方式定位,滚动距离优先级高于选择器。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 如果页面元素没有超过一屏,无法实现页面滚动。 |
| 注意事项 | 如果在 A 页面通过定时器延迟调用, 那么当定时器触发时当前栈顶页面是 B 则滚动的是 B 页面。 |
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
tt.pageScrollTo(options)
参数说明
options 为 object 类型,属性如下:
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| selector | string | 否 | 选择器,用于定位要滚动到的目标元素,支持标准 css 选择器语法 | 2.62.0 | |
| offsetTop | number | 0 | 否 | 偏移距离,需要和 selector 参数搭配使用,可以滚动到 selector 加偏移距离的位置,单位 px | 2.62.0 |
| duration | number | 200 | 否 | 动画的执行时长,单位 ms | 1.0.0 |
| scrollTop | number | 否 | 滚动到页面的目标位置,单位 px | 1.0.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 1.0.0 |
回调成功
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "pageScrollTo:ok" | 1.0.0 |
回调失败
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "pageScrollTo:fail" + 详细错误信息 | 1.0.0 |
扫码体验
请使用字节宿主APP扫码
