diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-swiper.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-swiper.md index f0bf6be55f343a0468bdd156de0669730a8e013d..a5f9adb455746165ab1cef419015d96d04fcced4 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-swiper.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-swiper.md @@ -1,11 +1,13 @@ # Swiper -滑动容器,提供切换子组件显示的能力。 - > **说明:** > > 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + +滑动容器,提供切换子组件显示的能力。 + + ## 权限列表 无 @@ -20,71 +22,97 @@ Swiper(value:{controller?: SwiperController}) -**参数:** +**参数:** + + | 参数名 | 参数类型 | 必填 | 参数描述 | + | ---------- | ------------------------------------- | ---- | -------------------- | + | controller | [SwiperController](#swipercontroller) | 否 | 给组件绑定一个控制器,用来控制组件翻页。
默认值:null | -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ---------- | ------------------------------------- | ---- | ---- | -------------------- | -| controller | [SwiperController](#swipercontroller) | 否 | null | 给组件绑定一个控制器,用来控制组件翻页。 | ## 属性 不支持[Menu控制](ts-universal-attributes-menu.md)。 -| 名称 | 参数类型 | 默认值 | 描述 | -| --------------------------- | ---------------------------------------- | ---------- | ---------------------------------------- | -| index | number | 0 | 设置当前在容器中显示的子组件的索引值。 | -| autoPlay | boolean | false | 子组件是否自动播放,自动播放状态下,导航点不可操作。 | -| interval | number | 3000 | 使用自动播放时播放的时间间隔,单位为毫秒。 | -| indicator | boolean | true | 是否启用导航点指示器。 | -| loop | boolean | true | 是否开启循环。
设置为true时表示开启循环,在LazyForEach懒循环加载模式下,加载的组件数量建议大于5个。 | -| duration | number | 400 | 子组件切换的动画时长,单位为毫秒。 | -| vertical | boolean | false | 是否为纵向滑动。 | -| itemSpace | Length | 0 | 设置子组件与子组件之间间隙。 | -| displayMode | SwiperDisplayMode | SwiperDisplayMode.Stretch | 设置子组件显示模式。 | -| cachedCount8+ | number | 1 | 设置预加载子组件个数。 | -| disableSwipe8+ | boolean | false | 禁用组件滑动切换功能。 | -| displayCount8+ | number \| string | 1 | 设置一页中显示子组件的个数,设置为“auto”时等同于SwiperDisplayMode.AutoLinear的显示效果。 | -| effectMode8+ | EdgeEffect | EdgeEffect.Spring | 设置滑动到边缘时的显示效果。 | -| curve8+ | [Curve](ts-appendix-enums.md#curve) \| Curves | Curve.Ease | 设置Swiper的动画曲线,默认为淡入淡出曲线,常用曲线参考[Curve枚举说明](ts-appendix-enums.md#curve),也可以通过插值计算模块提供的接口创建自定义的Curves([插值曲线对象](ts-interpolation-calculation.md))。 | -| indicatorStyle8+ | {
left?: Length,
top?: Length,
right?: Length,
bottom?: Length,
size?: Length,
mask?: boolean,
color?: [ResourceColor](ts-types.md#resourcecolor8),
selectedColor?: [ResourceColor](ts-types.md#resourcecolor8)
} | - | 设置indicator样式:
- left: 设置导航点距离Swiper组件左边的距离。
- top: 设置导航点距离Swiper组件顶部的距离。
- right: 设置导航点距离Swiper组件右边的距离。
- bottom: 设置导航点距离Swiper组件底部的距离。
- size: 设置导航点的直径。
- mask: 设置是否显示导航点蒙层样式。
- color: 设置导航点的颜色。
- selectedColor: 设置选中的导航点的颜色。 | +| 名称 | 参数类型 | 描述 | +| --------------------------- | ---------------------------------------- | ---------------------------------------- | +| index | number | 设置当前在容器中显示的子组件的索引值。
默认值:0 | +| autoPlay | boolean | 子组件是否自动播放,自动播放状态下,导航点不可操作。
默认值:false | +| interval | number | 使用自动播放时播放的时间间隔,单位为毫秒。
默认值:3000 | +| indicator | boolean | 是否启用导航点指示器。
默认值:true | +| loop | boolean | 是否开启循环。
设置为true时表示开启循环,在LazyForEach懒循环加载模式下,加载的组件数量建议大于5个。
默认值:true | +| duration | number | 子组件切换的动画时长,单位为毫秒。
默认值:400 | +| vertical | boolean | 是否为纵向滑动。
默认值:false | +| itemSpace | Length | 设置子组件与子组件之间间隙。
默认值:0 | +| displayMode | SwiperDisplayMode | 主轴方向上元素排列的模式,优先以displayCount设置的个数显示,displayCount未设置时本属性生效。
默认值:SwiperDisplayMode.Stretch | +| cachedCount8+ | number | 设置预加载子组件个数。
默认值:1 | +| disableSwipe8+ | boolean | 禁用组件滑动切换功能。
默认值:false | +| curve8+ | [Curve](ts-animatorproperty.md#Curve枚举说明) \| string | 设置Swiper的动画曲线,默认为淡入淡出曲线,常用曲线参考[Curve枚举说明](ts-animatorproperty.md#Curve枚举说明),也可以通过插值计算模块提供的接口创建自定义的Curves([插值曲线对象](ts-interpolation-calculation.md))。
默认值:Curve.Ease | +| indicatorStyle8+ | {
left?: Length,
top?: Length,
right?: Length,
bottom?: Length,
size?: Length,
color?: Color,
selectedColor?: Color
} | 设置indicator样式:
- left: 设置导航点距离Swiper组件左边的距离。
- top: 设置导航点距离Swiper组件顶部的距离。
- right: 设置导航点距离Swiper组件右边的距离。
- bottom: 设置导航点距离Swiper组件底部的距离。
- size: 设置导航点的直径。
- color: 设置导航点的颜色。
- selectedColor: 设置选中的导航点的颜色。 | +| displayCount8+ | number\|string | 设置元素显示个数。
默认值:1 | +| effectMode8+ | EdgeEffect | 滑动效果,目前支持的滑动效果参见EdgeEffect的枚举说明。
默认值:EdgeEffect.Spring | + +## SwiperDisplayMode枚举说明 + + | 名称 | 描述 | + | ----------- | ------------------------------------------ | + | Stretch | Swiper滑动一页的宽度为Swiper组件自身的宽度。| + | AutoLinear | Swiper滑动一页的宽度为子组件宽度中的最大值。| +## EdgeEffect枚举说明 + + | 名称 | 描述 | + | ------ | ------------------------------------------------------------------------- | + | Spring | 弹性物理动效,滑动到边缘后可以通过触摸事件继续滑动一段距离,松手后回弹。 | + | Fade | 滑动到边缘后,可以通过触摸事件继续滑动一段阴影,松手后阴影回弹。 | + | None | 滑动到边缘后无效果。 | ## SwiperController Swiper容器组件的控制器,可以将此对象绑定至Swiper组件,然后通过它控制翻页。 -| 接口名称 | 功能描述 | -| ------------------- | ------ | -| showNext() | 翻至下一页。 | -| showPrevious() | 翻至上一页。 | -| finishAnimation(callback?: () => void) | 停止Swiper动画。 | +### showNext -## SwiperDisplayMode枚举说明 +showNext(): void -| 名称 | 描述 | -| ------ | ---------------------------------------- | -| Stretch | Swiper滑动一页的宽度为Swiper组件自身的宽度。 | -| AutoLinear | Swiper滑动一页的宽度为子组件宽度中的最大值。 | +翻至下一页。 -## EdgeEffect枚举说明 +### showPrevious -| 名称 | 描述 | -| ------ | ---------------------------------------- | -| Spring | 弹性物理动效,滑动到边缘后可以根据初始速度或通过触摸事件继续滑动一段距离,松手后回弹。 | -| Fade | 阴影效果,滑动到边缘后会有圆弧状的阴影。 | -| None | 滑动到边缘后无效果。 | +showPrevious(): void +翻至上一页。 + +### finishAnimation + +finishAnimation(callback?: () => void): void + +停止播放动画。 + +**参数:** + +| 参数名 | 参数类型 | 必填项 | 参数描述 | +| --------- | ---------- | ------ | -------- | +| callback | () => void | 是 | 动画结束的回调。 | ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ------------------ | -| onChange(event: (index: number) => void) | 当前显示的子组件索引变化时触发该事件,返回值为当前显示的子组件的索引值。 | +### onChange + +onChange( index: number) => void + +当前显示的组件索引变化时触发该事件。 + +**参数:** + +| 参数名 | 参数类型 | 必填项 | 参数描述 | +| --------- | ---------- | ------ | -------- | +| index | number | 是 | 当前显示元素的索引。 | ## 示例 -``` +```ts +// xxx.ets class MyDataSource implements IDataSource { private list: number[] = [] private listener: DataChangeListener