setScrollMode
API_LEVEL
2.0开始支持，API 兼容性请参考 API_LEVEL。
设置页面的滚动模式。
类型
function setScrollMode(option: Option): Result
参数
Option
| 属性 | 类型 | 必填 | 默认值 | 说明 | API_LEVEL |
|---|---|---|---|---|---|
| mode | string | 是 | - | 页面滚动模式，值参考页面滚动模式常量 | 2.0 |
| options | Options | 否 | - | 其他选项 | 2.0 |
Options
| 属性 | 类型 | 必填 | 默认值 | 说明 | API_LEVEL |
|---|---|---|---|---|---|
| height | number | 否 | - | 指定 Swiper 中单个项目的高度，仅当页面滚动模式为 SCROLL_MODE_SWIPER 生效 | 2.0 |
| count | number | 否 | - | 指定 Swiper 中项目的数量，仅当页面滚动模式为 SCROLL_MODE_SWIPER 和 SCROLL_MODE_SWIPER_HORIZONTAL 生效 | 2.0 |
| width | number | 否 | - | 指定 Swiper 中单个项目的宽度，仅当页面滚动模式为 SCROLL_MODE_SWIPER_HORIZONTAL 生效 | 2.1 |
| modeParams | FreeModeParams|SwipeModeParams | 否 | - | 模式的控制参数 | 3.0 |
FreeModeParams
| 属性 | 类型 | 说明 | API_LEVEL |
|---|---|---|---|
| scroll_frame_func | (params: ScrollObj) => void | 滚动过程中每帧的回调函数 | 3.0 |
| scroll_complete_func | (params: ScrollObj) => void | 滚动结束的回调函数 | 3.0 |
| bounce | boolean | 页面回弹效果是否开启，当页面内容超过一屏，默认开启，页面内容不足一屏，默认关闭，此参数需要在 build 生命周期传入才能生效 | 3.6 |
ScrollObj
| 属性 | 类型 | 说明 | API_LEVEL |
|---|---|---|---|
| type | number | 待补充 | 3.0 |
| yoffset | number | y 轴偏移的像素 | 3.0 |
SwipeModeParams
| 属性 | 类型 | 说明 | API_LEVEL |
|---|---|---|---|
| on_page | (pageIndex: number) => void | 翻页完成后的回调函数，pageIndex 为翻页完成后的页面索引，索引从 0 开始 | 3.0 |
| crown_enable | boolean | 是否响应表冠事件，默认响应，可以通过表冠来控制翻页 | 3.0 |
Result
| 类型 | 说明 |
|---|---|
number | 如果返回 true 则表明成功 |
常量
页面滚动模式常量
| 常量 | 说明 | API_LEVEL |
|---|---|---|
SCROLL_MODE_FREE | 自由滚动，系统默认滚动模式 | 2.0 |
SCROLL_MODE_SWIPER | Swiper 模式，竖向轮播图、走马灯，通过配置单个页面高度和数量可以做到整屏滚动效果 | 2.0 |
SCROLL_MODE_SWIPER_HORIZONTAL | Swiper 模式，横向轮播图、走马灯，通过配置单个页面宽度和数量可以做到整屏滚动效果 | 2.1 |
代码示例
import { setScrollMode, SCROLL_MODE_SWIPER } from '@zos/page'
setScrollMode({
mode: SCROLL_MODE_SWIPER,
options: {
height: 480,
count: 10,
},
})