未验证 提交 b10a85ea 编写于 作者: O openharmony_ci 提交者: Gitee

!17936 新增transitionEffect的文档

Merge pull request !17936 from hehongyang9/dev
...@@ -528,3 +528,11 @@ ...@@ -528,3 +528,11 @@
| MAX_LINES_FIRST | 设置文本高度自适应方式为以MaxLines优先。 | | MAX_LINES_FIRST | 设置文本高度自适应方式为以MaxLines优先。 |
| MIN_FONT_SIZE_FIRST | 设置文本高度自适应方式为以缩小字体优先。 | | MIN_FONT_SIZE_FIRST | 设置文本高度自适应方式为以缩小字体优先。 |
| LAYOUT_CONSTRAINT_FIRST | 设置文本高度自适应方式为以布局约束(高度)优先。 | | LAYOUT_CONSTRAINT_FIRST | 设置文本高度自适应方式为以布局约束(高度)优先。 |
## TransitionEdge<sup>10+<sup>
| 名称 | 描述 |
| -------- | -------- |
| TOP | 窗口的上边缘 |
| BOTTOM | 窗口的下边缘 |
| START | 窗口的左边缘 |
| END | 窗口的右边缘 |
# 页面间转场 # 页面间转场
当路由进行切换时,可以通过 在pageTransition中自定义页面入场和页面退场的转场动效。 当路由进行切换时,可以通过 在pageTransition函数中自定义页面入场和页面退场的转场动效。
> **说明:** > **说明:**
> >
...@@ -10,8 +10,8 @@ ...@@ -10,8 +10,8 @@
| 名称 | 参数 | 必填 | 参数描述 | | 名称 | 参数 | 必填 | 参数描述 |
| ------------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ------------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| PageTransitionEnter | {<br/>type?: RouteType,<br/>duration?: number,<br/>curve?: [Curve](ts-appendix-enums.md#curve)&nbsp;\|&nbsp;string,<br>delay?: number<br/>} | 否 | 设置当前页面的自定义入场动效。<br/>-&nbsp;type:页面转场效果生效的路由类型。<br/>默认值:RouteType.None。<br/>**说明:** <br/>没有匹配时使用系统默认的页面转场效果(根据设备可能会有差异),如需禁用系统默认页面转场效果,可以指定duration为0。<br/>-&nbsp;duration:动画的时长<br/>单位:毫秒<br/>-&nbsp;curve:动画曲线。string类型的取值支持"ease"、"ease-in"、"ease-out"、"ease-in-out"、"extreme-deceleration"、"fast-out-linear-in"、"fast-out-slow-in"、"friction"、"linear"、"linear-out-slow-in"、"rhythm"、"sharp"、"smooth"。<br/>默认值:Curve.Linear<br/>-&nbsp;delay:动画延迟时长。<br/>默认值:0<br/>单位:毫秒 | | PageTransitionEnter | {<br/>type?: RouteType,<br/>duration?: number,<br/>curve?: [Curve](ts-appendix-enums.md#curve)&nbsp;\|&nbsp;string,<br>delay?: number<br/>} | 否 | 设置当前页面的自定义入场动效。<br/>-&nbsp;type:页面转场效果生效的路由类型。<br/>默认值:RouteType.None。<br/>-&nbsp;duration:动画的时长。<br/>单位:毫秒<br/>默认值:1000<br/>-&nbsp;curve:动画曲线。string类型的取值支持"ease"、"ease-in"、"ease-out"、"ease-in-out"、"extreme-deceleration"、"fast-out-linear-in"、"fast-out-slow-in"、"friction"、"linear"、"linear-out-slow-in"、"rhythm"、"sharp"、"smooth"。<br/>默认值:Curve.Linear<br/>-&nbsp;delay:动画延迟时长。<br/>单位:毫秒<br/>默认值:0<br/>**说明:** <br/>没有匹配时使用系统默认的页面转场效果(根据设备可能会有差异),如需禁用系统默认页面转场效果,可以指定duration为0。 |
| PageTransitionExit | {<br/>type?: RouteType,<br/>duration?: number,<br/>curve?: [Curve](ts-appendix-enums.md#curve)&nbsp;\|&nbsp;string,<br/>delay?: number<br/>} | 否 | 设置当前页面的自定义退场动效。<br/>-&nbsp;type:页面转场效果生效的路由类型。<br/>默认值:RouteType.None。<br/>**说明:** <br/>没有匹配时使用系统默认的页面转场效果(根据设备可能会有差异),如需禁用系统默认页面转场效果,可以指定duration为0。<br/>-&nbsp;duration:动画的时长,单位为毫秒。<br/>-&nbsp;curve:动画曲线,string类型取值与PageTransitionEnter相同。<br/>&nbsp;默认值:Curve.Linear<br/>-&nbsp;delay:动画延迟时长。<br/>默认值:0<br/>单位:毫秒 | | PageTransitionExit | {<br/>type?: RouteType,<br/>duration?: number,<br/>curve?: [Curve](ts-appendix-enums.md#curve)&nbsp;\|&nbsp;string,<br/>delay?: number<br/>} | 否 | 设置当前页面的自定义退场动效。<br/>-&nbsp;type:页面转场效果生效的路由类型。<br/>默认值:RouteType.None。<br/>-&nbsp;duration:动画的时长。<br/>单位:毫秒<br/>默认值:1000<br/>-&nbsp;curve:动画曲线,string类型取值与PageTransitionEnter相同。<br/>&nbsp;默认值:Curve.Linear<br/>-&nbsp;delay:动画延迟时长。<br/>单位:毫秒<br/>默认值:0<br/>**说明:** <br/>没有匹配时使用系统默认的页面转场效果(根据设备可能会有差异),如需禁用系统默认页面转场效果,可以指定duration为0。 |
## RouteType枚举说明 ## RouteType枚举说明
...@@ -26,10 +26,10 @@ ...@@ -26,10 +26,10 @@
| 参数名称 | 参数类型 | 必填 | 参数描述 | | 参数名称 | 参数类型 | 必填 | 参数描述 |
| --------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | --------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| slide | [SlideEffect](#slideeffect枚举说明) | 否 | 设置页面转场时的滑入滑出效果。<br/>默认值:SlideEffect.Right | | slide | [SlideEffect](#slideeffect枚举说明) | 否 | 设置页面转场时的滑入滑出效果。 |
| translate | {<br/>x?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string,<br/>y?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string,<br/>z?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string<br/>} | 否 | 设置页面转场时的平移效果,为入场时起点和退场时终点的值,和slide同时设置时默认生效slide。<br/>-&nbsp;x:横向的平移距离。<br/>-&nbsp;y:纵向的平移距离。<br/>-&nbsp;z:竖向的平移距离。 | | translate | {<br/>x?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string,<br/>y?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string,<br/>z?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string<br/>} | 否 | 设置页面转场时的平移效果,为入场时起点和退场时终点的值,和slide同时设置时默认生效slide。<br/>-&nbsp;x:横向的平移距离。<br/>-&nbsp;y:纵向的平移距离。<br/>-&nbsp;z:竖向的平移距离。 |
| scale | {<br/>x?&nbsp;:&nbsp;number,<br/>y?&nbsp;:&nbsp;number,<br/>z?&nbsp;:&nbsp;number,<br/>centerX?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string,<br/>centerY?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string<br/>} | 否 | 设置页面转场时的缩放效果,为入场时起点和退场时终点的值。<br/>-&nbsp;x:横向放大倍数(或缩小比例)。<br/>-&nbsp;y:纵向放大倍数(或缩小比例)。<br/>-&nbsp;z:竖向放大倍数(或缩小比例)。<br/>-&nbsp;centerX、centerY缩放中心点。<br/>-&nbsp;中心点为0时,默认的是组件的左上角。<br/> | | scale | {<br/>x?&nbsp;:&nbsp;number,<br/>y?&nbsp;:&nbsp;number,<br/>z?&nbsp;:&nbsp;number,<br/>centerX?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string,<br/>centerY?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string<br/>} | 否 | 设置页面转场时的缩放效果,为入场时起点和退场时终点的值。<br/>-&nbsp;x:横向放大倍数(或缩小比例)。<br/>-&nbsp;y:纵向放大倍数(或缩小比例)。<br/>-&nbsp;z:竖向放大倍数(或缩小比例)。<br/>-&nbsp;centerX、centerY缩放中心点。centerX和centerY默认值是"50%",即默认以页面的中心点为旋转中心点。<br/>-&nbsp;中心点为(0, 0)代表页面的左上角。<br/> |
| opacity | number | 否 | 设置入场的起点透明度值或者退场的终点透明度值。<br/>默认值:1 | | opacity | number | 否 | 设置入场的起点透明度值或者退场的终点透明度值。 |
## SlideEffect枚举说明 ## SlideEffect枚举说明
...@@ -75,7 +75,7 @@ struct PageTransitionExample1 { ...@@ -75,7 +75,7 @@ struct PageTransitionExample1 {
this.scale1 = 1 this.scale1 = 1
this.opacity1 = progress this.opacity1 = progress
}) // 进场过程中会逐帧触发onEnter回调,入参为动效的归一化进度(0% -- 100%) }) // 进场过程中会逐帧触发onEnter回调,入参为动效的归一化进度(0% -- 100%)
PageTransitionExit({ duration: 1500, curve: Curve.Ease }) PageTransitionExit({ duration: 1200, curve: Curve.Ease })
.onExit((type: RouteType, progress: number) => { .onExit((type: RouteType, progress: number) => {
this.scale1 = 1 - progress this.scale1 = 1 - progress
this.opacity1 = 1 this.opacity1 = 1
...@@ -106,7 +106,7 @@ struct AExample { ...@@ -106,7 +106,7 @@ struct AExample {
this.scale2 = 1 this.scale2 = 1
this.opacity2 = progress this.opacity2 = progress
}) // 进场过程中会逐帧触发onEnter回调,入参为动效的归一化进度(0% -- 100%) }) // 进场过程中会逐帧触发onEnter回调,入参为动效的归一化进度(0% -- 100%)
PageTransitionExit({ duration: 1500, curve: Curve.Ease }) PageTransitionExit({ duration: 1200, curve: Curve.Ease })
.onExit((type: RouteType, progress: number) => { .onExit((type: RouteType, progress: number) => {
this.scale2 = 1 - progress this.scale2 = 1 - progress
this.opacity2 = 1 this.opacity2 = 1
...@@ -115,31 +115,30 @@ struct AExample { ...@@ -115,31 +115,30 @@ struct AExample {
} }
``` ```
![zh-cn_image_0000001174422902](figures/zh-cn_image_0000001174422902.gif) ![pageTransition1](figures/pageTransition1.gif)
自定义方式2:配置了当前页面的入场动画为从左侧滑入,退场为缩小加透明度变化。 自定义方式2:配置了当前页面的入场动画为从左侧滑入,退场为平移加透明度变化。
```ts ```ts
// index.ets // index.ets
@Entry @Entry
@Component @Component
struct PageTransitionExample { struct PageTransitionExample {
@State scale1: number = 1
@State opacity1: number = 1
build() { build() {
Column() { Column() {
Navigator({ target: 'pages/page1', type: NavigationType.Push }) { Navigator({ target: 'pages/page1', type: NavigationType.Push }) {
Image($r('app.media.bg1')).width('100%').height('100%') // 图片存放在media文件夹下 Image($r('app.media.bg1')).width('100%').height('100%') // 图片存放在media文件夹下
} }
}.scale({ x: this.scale1 }).opacity(this.opacity1) }
} }
// 自定义方式2:使用系统提供的多种默认效果(平移、缩放、透明度等) // 自定义方式2:使用系统提供的多种默认效果(平移、缩放、透明度等)
pageTransition() { pageTransition() {
// 该页面进入动画时长为1200ms,尽量与另一页面的退出动画时长匹配
PageTransitionEnter({ duration: 1200 }) PageTransitionEnter({ duration: 1200 })
.slide(SlideEffect.Left) .slide(SlideEffect.Left)
PageTransitionExit({ delay: 100 }) // 该页面退出动画时长为1000ms,尽量与另一页面的进入动画时长匹配
PageTransitionExit({ duration: 1000 })
.translate({ x: 100.0, y: 100.0 }) .translate({ x: 100.0, y: 100.0 })
.opacity(0) .opacity(0)
} }
...@@ -151,26 +150,25 @@ struct PageTransitionExample { ...@@ -151,26 +150,25 @@ struct PageTransitionExample {
@Entry @Entry
@Component @Component
struct PageTransitionExample1 { struct PageTransitionExample1 {
@State scale2: number = 1
@State opacity2: number = 1
build() { build() {
Column() { Column() {
Navigator({ target: 'pages/index', type: NavigationType.Push }) { Navigator({ target: 'pages/index', type: NavigationType.Push }) {
Image($r('app.media.bg2')).width('100%').height('100%') // 图片存放在media文件夹下 Image($r('app.media.bg2')).width('100%').height('100%') // 图片存放在media文件夹下
} }
}.scale({ x: this.scale2 }).opacity(this.opacity2) }
} }
// 自定义方式2:使用系统提供的多种默认效果(平移、缩放、透明度等) // 自定义方式2:使用系统提供的多种默认效果(平移、缩放、透明度等)
pageTransition() { pageTransition() {
PageTransitionEnter({ duration: 1200 }) // 该页面进入动画时长为1000ms,尽量与另一页面的退出动画时长匹配
PageTransitionEnter({ duration: 1000 })
.slide(SlideEffect.Left) .slide(SlideEffect.Left)
PageTransitionExit({ delay: 100 }) // 该页面退出动画时长为1200ms,尽量与另一页面的进入动画时长匹配
PageTransitionExit({ duration: 1200 })
.translate({ x: 100.0, y: 100.0 }) .translate({ x: 100.0, y: 100.0 })
.opacity(0) .opacity(0)
} }
} }
``` ```
![zh-cn_image_0000001219864139](figures/zh-cn_image_0000001219864139.gif) ![pageTransition2](figures/pageTransition2.gif)
# 组件内转场 # 组件内转场
组件内转场主要通过transition属性配置转场参数,在组件插入和删除时显示过渡动效,主要用于容器组件中的子组件插入和删除时,提升用户体验(需要配合[animateTo](ts-explicit-animation.md)才能生效,动效时长、曲线、延时跟随animateTo中的配置) 组件内转场主要通过transition属性配置转场参数,在组件插入和删除时显示过渡动效,主要用于容器组件中的子组件插入和删除时,提升用户体验。
> **说明:** > **说明:**
> >
...@@ -12,21 +12,54 @@ ...@@ -12,21 +12,54 @@
| 名称 | 参数类型 | 参数描述 | | 名称 | 参数类型 | 参数描述 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| transition | TransitionOptions | 设置组件插入显示和删除隐藏的过渡效果。<br/>默认值:不设置任何过渡效果时,默认有透明度从0到1的过渡效果。若设置了其他过渡效果,以设置的过渡效果为准。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:** <br/>所有参数均为可选参数,详细描述见TransitionOptions参数说明。 | | transition | TransitionOptions \| TransitionEffect<sup>10+</sup> | 设置组件插入显示和删除隐藏的过渡效果。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:** <br/>详细描述见TransitionOptions和TransitionEffect参数说明。 |
## TransitionOptions参数说明 ## TransitionOptions参数说明
TransitionOptions通过指定结构体内的参数来指定转场效果。
| 参数名称 | 参数类型 | 必填 | 参数描述 | | 参数名称 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | [TransitionType](ts-appendix-enums.md#transitiontype) | 否 | 默认包括组件新增和删除。<br/>默认值:TransitionType.All<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>不指定Type时说明插入删除使用同一种效果。 | | type | [TransitionType](ts-appendix-enums.md#transitiontype) | 否 | 指定该转场样式生效的场景。<br/>默认值:TransitionType.All<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>不指定type时默认为TransitionType.All,即插入删除都生效。 |
| opacity | number | 否 | 设置组件转场时的透明度效果,为插入时起点和删除时终点的值。<br/>默认值:1<br/>取值范围: [0, 1]<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:** <br/>设置小于0的值时,按值为0处理;设置大于1的值时,按值为1处理。 | | opacity | number | 否 | 设置组件转场时的透明度效果,为插入时起点和删除时终点的值。<br/>取值范围: [0, 1]<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:** <br/>设置小于0或大于1的非法值时,按1处理。 |
| translate | {<br/>x?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string,<br/>y?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string,<br/>z?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string<br/>} | 否 | 设置组件转场时的平移效果,为插入时起点和删除时终点的值。<br/>-x:横向的平移距离。<br/>-y:纵向的平移距离。<br/>-z:竖向的平移距离。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 | | translate | {<br/>x?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string,<br/>y?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string,<br/>z?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string<br/>} | 否 | 设置组件转场时的平移效果,为插入时起点和删除时终点的值。<br/>-x:横向的平移距离。<br/>-y:纵向的平移距离。<br/>-z:竖向的平移距离。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| scale | {<br/>x?&nbsp;:&nbsp;number,<br/>y?&nbsp;:&nbsp;number,<br/>z?&nbsp;:&nbsp;number,<br/>centerX?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string,<br/>centerY?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string<br/>} | 否 | 设置组件转场时的缩放效果,为插入时起点和删除时终点的值。<br/>-x:横向放大倍数(或缩小比例)。<br/>-y:纵向放大倍数(或缩小比例)。<br/>-z:竖向放大倍数(或缩小比例)。<br/>-&nbsp;centerX、centerY指缩放中心点,centerX和centerY默认值是"50%"<br/>-&nbsp;中心点为0时,默认的是组件的左上角。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 | | scale | {<br/>x?&nbsp;:&nbsp;number,<br/>y?&nbsp;:&nbsp;number,<br/>z?&nbsp;:&nbsp;number,<br/>centerX?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string,<br/>centerY?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string<br/>} | 否 | 设置组件转场时的缩放效果,为插入时起点和删除时终点的值。<br/>-x:横向放大倍数(或缩小比例)。<br/>-y:纵向放大倍数(或缩小比例)。<br/>-z:竖向放大倍数(或缩小比例)。<br/>-&nbsp;centerX、centerY指缩放中心点,centerX和centerY默认值是"50%",即默认以组件的中心点为缩放中心点。<br/>-&nbsp;中心点为(0, 0)代表组件的左上角。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| rotate | {<br/>x?:&nbsp;number,<br/>y?:&nbsp;number,<br/>z?:&nbsp;number,<br/>angle?:&nbsp;number&nbsp;\|&nbsp;string,<br/>centerX?:&nbsp;number&nbsp;\|&nbsp;string,<br/>centerY?:&nbsp;number&nbsp;\|&nbsp;string<br/>} | 否 | 设置组件转场时的旋转效果,为插入时起点和删除时终点的值。<br/>-x:横向的旋转向量。<br/>-y:纵向的旋转向量。<br/>-z:竖向的旋转向量。<br/>-&nbsp;centerX,centerY指旋转中心点,centerX和centerY默认值是"50%"。<br/>-&nbsp;中心点为(0,0)时,默认的是组件的左上角。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 | | rotate | {<br/>x?:&nbsp;number,<br/>y?:&nbsp;number,<br/>z?:&nbsp;number,<br/>angle:&nbsp;number&nbsp;\|&nbsp;string,<br/>centerX?:&nbsp;number&nbsp;\|&nbsp;string,<br/>centerY?:&nbsp;number&nbsp;\|&nbsp;string<br/>} | 否 | 设置组件转场时的旋转效果,为插入时起点和删除时终点的值。<br/>-x:横向的旋转向量分量。<br/>-y:纵向的旋转向量分量。<br/>-z:竖向的旋转向量分量。<br/>-&nbsp;centerX、centerY指旋转中心点,centerX和centerY默认值是"50%",即默认以组件的中心点为旋转中心点。<br/>-&nbsp;中心点为(0, 0)代表组件的左上角。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
> **说明:**
>
> 1. 当使用TransitionOptions类型的入参指定转场效果时,**必须**配合[animateTo](ts-explicit-animation.md)使用才有动画效果,动效时长、曲线、延时跟随animateTo中的配置。
> 2. 当使用TransitionOptions作为入参,且不指定除type外的任何参数时,此时相当于指定了透明度的转场效果。例如,指定{type: TransitionType.Insert}相当于指定了{type: TransitionType.Insert, opacity: 0}的转场效果。而指定了具体效果时,则不会添加默认的透明度转场效果。
> 3. 更详细的关于scale、rotate效果的介绍可参考[图形变换](ts-universal-attributes-transformation.md)。
## TransitionEffect<sup>10+</sup>参数说明
TransitionEffect以函数的形式指定转场效果。提供了以下接口:
| 接口名称 | 参数类型 | 是否静态函数 | 参数描述 |
| -------- | ---------- | -------- | -------- |
| opacity | number | 是 | 设置组件转场时的透明度效果,为插入时起点和删除时终点的值。<br/>取值范围: [0, 1]<br/>**说明:** <br/>设置小于0或大于1的非法值时,按1处理。 |
| translate | {<br/>x?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string,<br/>y?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string,<br/>z?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string<br/>} | 是 | 设置组件转场时的平移效果,为插入时起点和删除时终点的值。<br/>-x:横向的平移距离。<br/>-y:纵向的平移距离。<br/>-z:竖向的平移距离。 |
| scale | {<br/>x?&nbsp;:&nbsp;number,<br/>y?&nbsp;:&nbsp;number,<br/>z?&nbsp;:&nbsp;number,<br/>centerX?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string,<br/>centerY?&nbsp;:&nbsp;number&nbsp;\|&nbsp;string<br/>} | 是 | 设置组件转场时的缩放效果,为插入时起点和删除时终点的值。<br/>-x:横向放大倍数(或缩小比例)。<br/>-y:纵向放大倍数(或缩小比例)。<br/>-z:竖向放大倍数(或缩小比例)。<br/>-&nbsp;centerX、centerY指缩放中心点,centerX和centerY默认值是"50%",即默认以组件的中心点为缩放中心点。<br/>-&nbsp;中心点为(0, 0)代表组件的左上角。 |
| rotate | {<br/>x?:&nbsp;number,<br/>y?:&nbsp;number,<br/>z?:&nbsp;number,<br/>angle:&nbsp;number&nbsp;\|&nbsp;string,<br/>centerX?:&nbsp;number&nbsp;\|&nbsp;string,<br/>centerY?:&nbsp;number&nbsp;\|&nbsp;string<br/>} | 是 | 设置组件转场时的旋转效果,为插入时起点和删除时终点的值。<br/>-x:横向的旋转向量分量。<br/>-y:纵向的旋转向量分量。<br/>-z:竖向的旋转向量分量。<br/>-&nbsp;centerX、centerY指旋转中心点,centerX和centerY默认值是"50%",即默认以组件的中心点为旋转中心点。<br/>-&nbsp;中心点为(0, 0)代表组件的左上角。 |
| move | [TransitionEdge](ts-appendix-enums.md#transitionedge10) | 是 | 指定组件转场时从屏幕边缘滑入和滑出的效果,本质为平移效果,为插入时起点和删除时终点的值。 |
| asymmetric | appear: TransitionEffect,<br/>disappear: TransitionEffect<br/> | 是 | 指定非对称的转场效果。<br/>第一个参数指定出现的转场效果,第二个参数指定消失的转场效果。<br/>如不通过asymmetric函数构造TransitionEffect,则表明该效果在组件出现和消失时均生效。 |
| combine | TransitionEffect | 否 | 对TransitionEffect进行链式组合,以形成包含多种转场效果的TransitionEffect。 |
| animation | [AnimateParam](ts-explicit-animation.md#animateparam对象说明) | 否 | 指定该TransitionEffect的动画参数。</br>该参数只用来指定动画参数,其入参AnimateParam的onFinish回调不生效。</br>如果通过combine进行TransitionEffect的组合,前一TransitionEffect的动画参数也可用于后一TransitionEffect。 |
上表提供的静态函数用于构造TransitionEffect对象,而非静态函数作用于构造好的TransitionEffect对象,以指定多种转场效果的组合效果和动画参数。
此外TransitionEffect提供了一些转场效果的静态成员变量:
| 静态成员名称 | 参数描述 |
| -------- | -------- |
| IDENTITY | 禁用转场效果。 |
| OPACITY | 指定透明度为0的转场效果。即相当于TransitionEffect.opacity(0) |
| SLIDE | 指定出现时从左侧滑入、消失时从右侧滑出的转场效果。即相当于TransitionEffect.asymmetric(TransitionEffect.START, TrasitionEffect.END) |
## 示例 > **说明:**
>
> 1. TransitionEffect可通过combine函数实现多个转场效果的组合,可以为每个效果分别指定animation参数,且前一效果的animation的参数也可适用于后一效果。例如,TransitionEffect.OPACITY.animation({duration: 1000}).combine(TransitionEffect.translate({x: 100})),则时长为1000ms的动画参数对OPACITY和translate均生效。
> 2. 动画参数的生效顺序为:本TransitionEffect指定的animation参数 > 前面的TransitionEffect指定的animation参数 > 触发该组件出现消失的animateTo中的动画参数。
> 3. 如果未使用animateTo触发转场动画且TransitionEffect中也无animation参数,则该组件直接出现或者消失。
> 4. TransitionEffect中指定的属性值如与默认值相同,则该属性不会产生转场动画。如TransitionEffect.opacity(1).animation({duration:1000}),由于opacity默认值也为1,未产生透明度动画,该组件直接出现或者消失。
## 示例
下面是一个出现消失使用TransitionOptions的示例。
```ts ```ts
// xxx.ets // xxx.ets
@Entry @Entry
...@@ -40,40 +73,121 @@ struct TransitionExample { ...@@ -40,40 +73,121 @@ struct TransitionExample {
Button(this.show).width(80).height(30).margin(30) Button(this.show).width(80).height(30).margin(30)
.onClick(() => { .onClick(() => {
// 点击Button控制Image的显示和消失 // 点击Button控制Image的显示和消失
if (this.flag) {
this.show = 'hide';
} else {
this.show = 'show';
}
// 使用TransitionOptions指定transition时,必须配合animateTo才能产生动画
animateTo({ duration: 1000 }, () => { animateTo({ duration: 1000 }, () => {
if (this.flag) {
this.show = 'hide'
} else {
this.show = 'show'
}
this.flag = !this.flag this.flag = !this.flag
}) })
}) })
if (this.flag) { if (this.flag) {
// Image的显示和消失配置为不同的过渡效果 // Image的显示和消失配置为不同的过渡效果
Image($r('app.media.testImg')).width(300).height(300) // 出现时从指定的x方向scale为0、y方向scale为1的状态变为默认的x、y方向scale都为1的状态
// 消失时从默认的旋转角为0变为绕z轴顺时针旋转180°的状态
Image($r('app.media.testImg')).width(200).height(200)
.transition({ type: TransitionType.Insert, scale: { x: 0, y: 1.0 } }) .transition({ type: TransitionType.Insert, scale: { x: 0, y: 1.0 } })
.transition({ type: TransitionType.Delete, rotate: { angle: 180 } }) .transition({ type: TransitionType.Delete, rotate: { z: 1, angle: 180 } })
} }
}.width('100%') }.width('100%')
} }
} }
``` ```
示意图: 示意图:<br/>
![transitionComponent1](figures/transitionComponent1.gif)
图片完全显示时:
![animationComponent1](figures/animationComponent1.png)
图片消失时配置顺时针旋转180°的过渡效果:
![animationComponent3](figures/animationComponent3.png)
图片完全消失时: 下面是一个出现消失使用同一TransitionEffect(出现和消失互为逆过程)的示例。
```ts
// xxx.ets
@Entry
@Component
struct TransitionEffectExample1 {
@State flag: boolean = true;
@State show: string = 'show';
![animationComponent2](figures/animationComponent2.png) build() {
Column() {
Button(this.show).width(80).height(30).margin(30)
.onClick(() => {
// 点击Button控制Image的显示和消失
if (this.flag) {
this.show = 'hide';
} else {
this.show = 'show';
}
this.flag = !this.flag;
})
if (this.flag) {
// Image的显示和消失配置为相同的过渡效果(出现和消失互为逆过程)
// 出现时从指定的透明度为0、绕z轴旋转180°的状态,变为默认的透明度为1、旋转角为0的状态,透明度与旋转动画时长都为2000ms
// 消失时从默认的透明度为1、旋转角为0的状态,变为指定的透明度为0、绕z轴旋转180°的状态,透明度与旋转动画时长都为2000ms
Image($r('app.media.testImg')).width(200).height(200)
.transition(TransitionEffect.OPACITY.animation({ duration: 2000, curve: Curve.Ease }).combine(
TransitionEffect.rotate({ z: 1, angle: 180 })
))
}
}.width('100%')
}
}
```
示意图:<br/>
![transitionComponent2](figures/transitionComponent2.gif)
图片显示时配置横向放大一倍的过渡效果: 下面是一个出现和消失使用不同TransitionEffect的示例。
```ts
// xxx.ets
@Entry
@Component
struct TransitionEffectExample2 {
@State flag: boolean = true;
@State show: string = 'show';
![animationComponent4](figures/animationComponent4.png) build() {
\ No newline at end of file Column() {
Button(this.show).width(80).height(30).margin(30)
.onClick(() => {
// 点击Button控制Image的显示和消失
if (this.flag) {
this.show = 'hide';
} else {
this.show = 'show';
}
animateTo({ duration: 2000 }, () => {
// 第一张图的TransitionEffect包含了animation,transition的动画参数由TransitionEffect指定
// 第二张图的TransitionEffect不包含animation,transition的动画参数由animateTo指定
this.flag = !this.flag;
});
})
if (this.flag) {
// Image的显示和消失配置为不同的过渡效果
// 出现时做从指定的透明度为0变为默认的透明度1的动画,该动画时长为1000ms,以及做从指定的绕z轴旋转180°变为默认的旋转角为0的动画,该动画1000ms后播放,时长为1000ms
// 消失时做从默认的透明度为1变为指定的透明度0的动画,该动画1000ms后播放,时长为1000ms,以及做从默认的旋转角0变为指定的绕z轴旋转180°的动画,该动画时长为1000ms
Image($r('app.media.testImg')).width(200).height(200)
.transition(
TransitionEffect.asymmetric(
TransitionEffect.OPACITY.animation({ duration: 1000 }).combine(
TransitionEffect.rotate({ z: 1, angle: 180 }).animation({ delay: 1000, duration: 1000 }))
,
TransitionEffect.OPACITY.animation({ delay: 1000, duration: 1000 }).combine(
TransitionEffect.rotate({ z: 1, angle: 180 }).animation({ duration: 1000 }))
)
)
// 出现时做从x方向和y方向scale都为0变为默认的x方向和y方向scale都为1的动画,该动画时长为animateTo中指定的2000ms
// 消失时无转场效果
Image($r('app.media.testImg')).width(200).height(200).margin({ top: 100 })
.transition(
TransitionEffect.asymmetric(
TransitionEffect.scale({ x: 0, y: 0 }),
TransitionEffect.IDENTITY
)
)
}
}.width('100%')
}
}
```
示意图:<br/>
![transitionComponent3](figures/transitionComponent3.gif)
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册