swipeToIndex
Start from API_LEVEL
2.0
. Please refer to API_LEVEL.
Scrolls the page to the Swiper's target item, only if the current page scroll mode is SCROLL_MODE_SWIPER
.
Type
function swipeToIndex(option: Option): void
Parameters
Option
Property | Type | Required | DefaultValue | Description | API_LEVEL |
---|---|---|---|---|---|
index | number | Y | - | Index of the target project, starting from 0 | 2.0 |
animation | string | N |
| Scrolling animation, value reference page scrolling animation constants | 2.0 |
Constants
Page scroll mode constants
Constant | Description | API_LEVEL |
---|---|---|
SCROLL_ANIMATION_SMOOTH | Scroll smoothly to the corresponding position | 2.0 |
SCROLL_ANIMATION_NONE | No animation, scroll directly to the corresponding position | 2.0 |
Example
import { setScrollMode, swipeToIndex, SCROLL_MODE_SWIPER } from '@zos/page'
setScrollMode({
mode: SCROLL_MODE_SWIPER,
options: {
height: 480,
count: 10,
},
})
swipeToIndex({
index: 5,
})