my.pageScrollTo
该接口用于滚动到页面的目标位置。
说明:
- scrollTop 的优先级比 selector 高。
- 使用
my.pageScrollTo跳转小程序顶部时,必须将 scrollTop 值设为大于 0,方可实现跳转。 - mPaaS 10.1.32 及以上版本支持该接口。
参数说明
| 属性 | 类型 | 默认值 | 必填 | 描述 | 最低版本 |
|---|---|---|---|---|---|
| scrollTop | Number | - | 否 | 滚动到页面的目标位置,单位 px。使用 my.pageScrollTo 跳转小程序顶部时,必须将 scrollTop 值设为大于 0,方可实现跳转。 | - |
| duration | Number | 0 | 否 | 滚动动画的时长,单位 ms。 | 1.20.0 |
| selector | String | - | 否 | 选择器。 | 1.20.0 |
| success | Function | - | 否 | 接口调用成功的回调函数。 | - |
| fail | Function | - | 否 | 接口调用失败的回调函数。 | - |
| complete | Function | - | 否 | 接口调用结束的回调函数(调用成功、失败都会执行)。 | - |
selector 语法
当传入 selector 参数,框架会执行 document.querySelector(selector) 以选取目标节点。
代码示例
<!-- API-DEMO page/API/page-scroll-to/page-scroll-to.axml--><view class="page"><view class="page-description">页面滚动 API</view><view class="page-section"><view class="page-section-title">my.pageScrollTo</view><view class="page-section-demo"><input type="text" placeholder="key" name="key" value="{{scrollTop}}" onInput="scrollTopChange"></input></view><view class="page-section-btns"><view onTap="scrollTo">页面滚动</view></view></view><view style="height:1000px"/></view>
// API-DEMO page/API/page-scroll-to/page-scroll-to.jsPage({data: {scrollTop: 0,},scrollTopChange(e) {this.setData({scrollTop: e.detail.value,});},onPageScroll({ scrollTop }) {console.log('onPageScroll', scrollTop);},scrollTo() {my.pageScrollTo({scrollTop: parseInt(this.data.scrollTop),duration: 300,});},});
该文章对您有帮助吗?