#swiper
轮播容器组件,支持自动播放、循环、自定义动画等功能。子节点须为 SwiperItem 组件。
#扫码预览
#Props
| 属性名 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| autoPlay | boolean | false | 否 | 是否启用自动播放 |
| autoPlayInterval | number | 2000 | 否 | 自动播放间隔 |
| blockNativeEvent | boolean | false | 否 | 是否阻止原生事件 |
| bounceConfig | BounceConfig | - | 否 | 回弹参数配置 |
| children | (prop: RenderFunctionProps<T>) => ReactElement | - | 是 | 子元素,应该是一个函数,返回 SwiperItem |
| className | string | - | 否 | 组件类名 |
| consumeSlideEvent | [number, number][] | [[-180, -135], [-45, 45], [135, 180]] | 否 | 决定 Swiper 如何响应不同角度的触摸 |
| containerWidth | number | screenWidth | 否 | 容器宽度 |
| data | T[] | - | 是 | 轮播图数据集合 |
| duration | number | 500 | 否 | 翻页或滑动动画的持续时间 |
| initialIndex | number | 0 | 否 | 初始索引,仅在首屏时使用,后续更新将被忽略 |
| itemHeight | number | "auto" | - | 否 | 轮播项高度 |
| itemWidth | number | - | 是 | 轮播项宽度 |
| loop | boolean | false | 否 | 是否开启循环轮播 |
| loopDuplicateCount | number | 2 | 否 | 当 loop 为 true 时,Swiper 会复制前 2 个和后 2 个项目来创建循环效果。 此属性可用于自定义复制第一个和最后一个项目的数量 |
| main-thread:customAnimation | (value: number, index: number) => CSSProperties | - | 否 | 自定义动画效果,应该是一个主线程函数 |
| main-thread:easing | (progress: number) => number | - | 否 | 自定义翻页效果的缓动函数 |
| main-thread:onOffsetChange | (offset: number) => void | - | 否 | Swiper 偏移量改变时的回调函数,应该是一个主线程函数 |
| mode | "normal" | "custom" | normal | 否 | Swiper 的模式。普通模式会使 SwiperItem 依次排列。 自定义模式会使 SwiperItem 以绝对定位方式放置在最左侧 |
| modeConfig | { align?: "center" | "end" | "start"; spaceBetween?: number } | Record<string, unknown> | - | 否 | 模式的额外配置 |
| offsetLimit | [number, number] | - | 否 | 用于限制或扩展 Swiper 的偏移量范围,可用于限制偏移量以避免过度滚动 |
| onChange | (current: number) => void | - | 否 | 当前索引改变时的回调函数 |
| onSwipeStart | (current: number) => void | - | 否 | 开始滑动时的回调函数,可与 onSwipeStop 配合使用,用于在滑动时禁用点击事件 |
| onSwipeStop | (current: number) => void | - | 否 | 停止滑动时的回调函数,可与 onSwipeStart 配合使用 |
| RTL | boolean | "lynx-rtl" | false | 否 | 是否启用 RTL 模式 |
| style | CSSProperties | - | 否 | 根元素样式,控制包含轮播图的可见视口/框架 |
#Ref 方法
| 方法名 | 类型 | 说明 |
|---|---|---|
| cancelAnimation | () => void | 取消当前正在运行的动画。谨慎使用,可能会破坏内部状态 |
| swipeNext | () => void | 滑动到下一个项目 |
| swipePrev | () => void | 滑动到上一个项目 |
| swipeTo | (index: number, options?: SwipeToOptions) => void | 滑动到指定索引的项目 |