diff --git a/api/@internal/component/ets/page_transition.d.ts b/api/@internal/component/ets/page_transition.d.ts index 5188cc192b920abc44e9021cd6de008e8156db0e..c6cda7856a7a0d1f4e6c36bf2688bbecbd337dc1 100644 --- a/api/@internal/component/ets/page_transition.d.ts +++ b/api/@internal/component/ets/page_transition.d.ts @@ -18,11 +18,6 @@ * @kit ArkUI */ -/*** if arkts 1.2 */ -import { ICurve, TranslateOptions, ScaleOptions } from './common'; -import { Curve } from './enums'; -/*** endif */ - /** * Declare the jump method. * @@ -45,8 +40,7 @@ import { Curve } from './enums'; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ declare enum RouteType { /** @@ -68,8 +62,7 @@ declare enum RouteType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ None, @@ -92,8 +85,7 @@ declare enum RouteType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ Push, @@ -116,8 +108,7 @@ declare enum RouteType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ Pop, } @@ -144,8 +135,7 @@ declare enum RouteType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ declare enum SlideEffect { /** @@ -167,8 +157,7 @@ declare enum SlideEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ Left, @@ -191,8 +180,7 @@ declare enum SlideEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ Right, @@ -215,8 +203,7 @@ declare enum SlideEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ Top, @@ -239,8 +226,7 @@ declare enum SlideEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ Bottom, @@ -250,8 +236,7 @@ declare enum SlideEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ START = 5, @@ -261,8 +246,7 @@ declare enum SlideEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ END = 6, } @@ -451,69 +435,6 @@ declare class CommonTransition { opacity(value: number): T; } -/** - * Provides interfaces for common transitions. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ -declare class CommonTransition { - /** - * Called when the slide in effect of the transition is set. - * - * @param { SlideEffect } value - * @returns { this } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - slide(value: SlideEffect): this; - - /** - * Called when the translation effect of page transition is set. - * - * @param { TranslateOptions } value - * @returns { this } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - translate(value: TranslateOptions): this; - - /** - * Called when setting the zoom effect of page transition. - * - * @param { ScaleOptions } value - * @returns { this } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - scale(value: ScaleOptions): this; - - /** - * Called when the transparency value of the starting point of entry or the ending point of exit is set. - * - * @param { number } value - * @returns { this } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - opacity(value: number): this; -} - /** * Defines pageTransition constructor parameters. * @@ -536,8 +457,7 @@ declare class CommonTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ declare interface PageTransitionOptions { /** @@ -559,8 +479,7 @@ declare interface PageTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ type?: RouteType; /** @@ -582,8 +501,7 @@ declare interface PageTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ duration?: number; /** @@ -608,8 +526,7 @@ declare interface PageTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ curve?: Curve | string | ICurve; /** @@ -634,8 +551,7 @@ declare interface PageTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ delay?: number; } @@ -649,8 +565,7 @@ declare interface PageTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 + * @since 18 */ declare type PageTransitionCallback = (type: RouteType, progress: number) => void; @@ -756,47 +671,6 @@ interface PageTransitionEnterInterface extends CommonTransition = [T1, T2]; @@ -44,8 +36,7 @@ declare type ParticleTuple = [T1, T2]; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 + * @since 18 */ declare interface VelocityOptions { /** @@ -71,8 +62,7 @@ declare interface VelocityOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 + * @since 18 */ speed: ParticleTuple; @@ -99,8 +89,7 @@ declare interface VelocityOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts{ '1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 + * @since 18 */ angle: ParticleTuple; } @@ -173,42 +162,6 @@ declare interface AccelerationOptions< angle?: ParticlePropertyOptions; } -/** - * Defines acceleration options. - * - * @interface AccelerationOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ -declare interface AccelerationOptions { - /** - * Speed property options. - * - * @type { ?ParticlePropertyOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - speed?: ParticlePropertyOptions; - - /** - * Angle property options. - * - * @type { ?ParticlePropertyOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - angle?: ParticlePropertyOptions; -} - /** * Defines the ParticleOptions Interface. * @interface ParticleOptions @@ -387,102 +340,6 @@ interface ParticleOptions< spin?: ParticlePropertyOptions; } -/** - * Defines the ParticleOptions Interface. - * @interface ParticleOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ -interface ParticleOptions { - /** - * Particle emitter. - * @type { EmitterOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - emitter: EmitterOptions; - - /** - * Particle color. - * @type { ?ParticleColorPropertyOptions } - * @default {range:['#FFFFFF','#FFFFFF']} - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - color?: ParticleColorPropertyOptions; - - /** - * Particle opacity. - * @type { ?ParticlePropertyOptions } - * @default {range:[1.0,1.0]} - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - opacity?: ParticlePropertyOptions; - - /** - * Particle scale. - * @type { ?ParticlePropertyOptions } - * @default {range:[1.0,1.0]} - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - scale?: ParticlePropertyOptions; - - /** - * Particle velocity. - * - * @type { ?VelocityOptions } - * @default {speed:[0,0];angle:[0,0]} - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - velocity?: VelocityOptions; - - /** - * Particle acceleration. - * - * @type { ?AccelerationOptions } - * @default {speed:{range:[0,0]};angle:{range:[0,0]}} - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - acceleration?: AccelerationOptions; - - /** - * Particle spin. - * @type { ?ParticlePropertyOptions } - * @default {range:[0,0]} - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - spin?: ParticlePropertyOptions; -} - /** * Defines the parameters for a point-like particle. * @interface PointParticleParameters @@ -496,8 +353,7 @@ interface ParticleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ interface PointParticleParameters { /** @@ -513,8 +369,7 @@ interface PointParticleParameters { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ radius: VP; } @@ -532,8 +387,7 @@ interface PointParticleParameters { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ interface ImageParticleParameters { /** @@ -549,8 +403,7 @@ interface ImageParticleParameters { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ src: ResourceStr; @@ -577,8 +430,7 @@ interface ImageParticleParameters { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 + * @since 18 */ size: ParticleTuple; @@ -597,8 +449,7 @@ interface ImageParticleParameters { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ objectFit?: ImageFit; } @@ -654,17 +505,6 @@ interface ParticleConfigs { [ParticleType.IMAGE]: ImageParticleParameters; } -/** - * Defines the particle configs. - * @typedef {PointParticleParameters | ImageParticleParameters} ParticleConfigs - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ -declare type ParticleConfigs = PointParticleParameters | ImageParticleParameters; - /** * Defines the emitter property. * @@ -672,8 +512,7 @@ declare type ParticleConfigs = PointParticleParameters | ImageParticleParameters * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ interface EmitterProperty { @@ -684,8 +523,7 @@ interface EmitterProperty { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ index: number; @@ -696,8 +534,7 @@ interface EmitterProperty { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ emitRate?: number; @@ -708,8 +545,7 @@ interface EmitterProperty { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ position?: PositionT; @@ -720,8 +556,7 @@ interface EmitterProperty { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ size?: SizeT; @@ -733,7 +568,6 @@ interface EmitterProperty { * @crossplatform * @atomicservice * @since 20 - * @arkts 1.1&1.2 */ annulusRegion?: ParticleAnnulusRegion; } @@ -883,81 +717,6 @@ interface EmitterParticleOptions { lifetimeRange?: number; } -/** - * Defines parameters of particles used by emitters. - * - * @interface EmitterParticleOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ -interface EmitterParticleOptions { - /** - * Particle type. - * - * @type { ParticleType } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - type: ParticleType; - - /** - * Particle config. - * - * @type { ParticleConfigs } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - config: ParticleConfigs; - - /** - * Particle count. - * - * @type { number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - count: number; - - /** - * Particle lifetime. - * - * @type { ?number } - * @default 1000 - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - lifetime?: number; - - /** - * Particle lifetimeRange,value range [0, ∞). - * when lifetimeRange>lifetime,minimum lifetime is 0. - * - * @type { ?number } - * @default 0 - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - lifetimeRange?: number; -} - /** * Defines the emitter Options. * @interface EmitterOptions @@ -1124,96 +883,6 @@ interface EmitterOptions { annulusRegion?: ParticleAnnulusRegion; } -/** - * Defines the emitter Options. - * @interface EmitterOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ -interface EmitterOptions { - /** - * Set particle config. - * - * @type { EmitterParticleOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - particle: EmitterParticleOptions; - - /** - * Emitting rate, that is, the number of particles produced per second. - * @type { ?number } - * @default 5 - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - emitRate?: number; - - /** - * Shape of emitter. - * @type { ?ParticleEmitterShape } - * @default ParticleEmitterShape.RECTANGLE - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - shape?: ParticleEmitterShape; - - /** - * Position of emitter. - * The first element means X-axis location. - * The second element means the Y-axis location. - * - * @type { ?ParticleTuple } - * @default [0,0] - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - position?: ParticleTuple; - - /** - * Size of emitter. - * The first element means emitter width. - * The second element means emitter height. - * - * @type { ?ParticleTuple } - * @default ['100%','100%'] - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - size?: ParticleTuple; - - /** - * the description of the annulus region. This parameter is valid only for emitter whose shape is annulus. - * - * @type { ?ParticleAnnulusRegion } - * @default {innerRadius:LengthMetrics.vp(0),outerRadius:LengthMetrics.vp(0)} - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - annulusRegion?: ParticleAnnulusRegion; -} - /** * Defines the particle property updater configs. * @interface ParticlePropertyUpdaterConfigs @@ -1294,17 +963,6 @@ interface ParticlePropertyUpdaterConfigs { [ParticleUpdater.CURVE]: Array>; } -/** - * Defines the particle property updater configs. - * @typedef { undefined | ParticleTuple | Array> } ParticlePropertyUpdaterConfigs - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ -declare type ParticlePropertyUpdaterConfigs = undefined | ParticleTuple | Array>; - /** * Defines the particle updater options. * @@ -1370,42 +1028,6 @@ interface ParticleUpdaterOptions { config: ParticlePropertyUpdaterConfigs[UPDATER]; } -/** - * Defines the particle updater options. - * - * @typedef ParticleUpdaterOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ -interface ParticleUpdaterOptions { - /** - * Particle updater type. - * - * @type { ParticleUpdater } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - type: ParticleUpdater; - - /** - * Particle updater configuration. - * - * @type { ParticlePropertyUpdaterConfigs } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - config: ParticlePropertyUpdaterConfigs; -} - /** * Defines the particle color options. * @@ -1413,8 +1035,7 @@ interface ParticleUpdaterOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 + * @since 18 */ interface ParticleColorOptions { /** @@ -1440,8 +1061,7 @@ interface ParticleColorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts{ '1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 + * @since 18 */ r: ParticleTuple; @@ -1468,8 +1088,7 @@ interface ParticleColorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts{ '1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 + * @since 18 */ g: ParticleTuple; @@ -1496,8 +1115,7 @@ interface ParticleColorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 + * @since 18 */ b: ParticleTuple; @@ -1524,8 +1142,7 @@ interface ParticleColorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 + * @since 18 */ a: ParticleTuple; } @@ -1595,42 +1212,6 @@ interface ParticleColorUpdaterOptions { config: ParticleColorPropertyUpdaterConfigs[UPDATER]; } -/** - * Defines the particle color updater options. - * - * @interface ParticleColorUpdaterOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ -interface ParticleColorUpdaterOptions { - /** - * Color updater. - * - * @type { ParticleUpdater } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - type: ParticleUpdater; - - /** - * Color updater configuration. - * - * @type { ParticleColorPropertyUpdaterConfigs } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - config: ParticleColorPropertyUpdaterConfigs; -} - /** * Defines the particle property Options. * @interface ParticlePropertyOptions @@ -1705,42 +1286,6 @@ interface ParticlePropertyOptions { updater?: ParticleUpdaterOptions; } -/** - * Defines the particle property Options. - * @interface ParticlePropertyOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ -interface ParticlePropertyOptions { - /** - * Initial range, within which the initial value are randomly generated. - * - * @type { ParticleTuple } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - range: ParticleTuple; - - /** - * Particle property updater. - * - * @type { ?ParticleUpdaterOptions } - * @default {type:UPDATER.NONE;config:undefined} - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - updater?: ParticleUpdaterOptions; -} - /** * Defines the particle color property updater configs. * @interface ParticleColorPropertyUpdaterConfigs @@ -1823,17 +1368,6 @@ interface ParticleColorPropertyUpdaterConfigs { [ParticleUpdater.CURVE]: Array>; } -/** - * Defines the particle color property updater configs. - * @typedef {undefined | ParticleColorOptions | Array>} ParticleColorPropertyUpdaterConfigs - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ -declare type ParticleColorPropertyUpdaterConfigs = undefined | ParticleColorOptions | Array>; - /** * Defines the particle color property updater configs which can support generics. * @interface ParticleColorPropertyOptions @@ -1919,54 +1453,6 @@ interface ParticleColorPropertyOptions { updater?: ParticleColorUpdaterOptions; } -/** - * Defines the particle color property updater. - * @interface ParticleColorPropertyOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ -interface ParticleColorPropertyOptions { - /** - * Initial color range, within which the initial color is randomly generated. - * - * @type { ParticleTuple } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - range: ParticleTuple; - - /** - * Distribution type of particle color. - * @type { ?DistributionType } - * @default DistributionType.UNIFORM - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - distributionType?: DistributionType; - - /** - * Particle color property updater. - * - * @type { ?ParticleColorUpdaterOptions } - * @default {type:UPDATER.NONE;config:undefined} - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - updater?: ParticleColorUpdaterOptions; -} - /** * Defines the particle property lifecycle. * @interface ParticlePropertyAnimation @@ -1980,8 +1466,7 @@ interface ParticleColorPropertyOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ interface ParticlePropertyAnimation { /** @@ -1997,8 +1482,7 @@ interface ParticlePropertyAnimation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ from: T; @@ -2015,8 +1499,7 @@ interface ParticlePropertyAnimation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ to: T; @@ -2033,8 +1516,7 @@ interface ParticlePropertyAnimation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ startMillis: number; @@ -2051,8 +1533,7 @@ interface ParticlePropertyAnimation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ endMillis: number; @@ -2071,8 +1552,7 @@ interface ParticlePropertyAnimation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ curve?: Curve | ICurve; } @@ -2133,30 +1613,6 @@ interface Particles< >; } -/** - * Defines the Particles interface. - * - * @interface Particles - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ -interface Particles { - /** - * Array of particles. - * - * @type { Array } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - particles: Array; -} - /** * Defines the particle Interface. * @interface ParticleInterface @@ -2170,8 +1626,7 @@ interface Particles { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 * @noninterop */ interface ParticleInterface { @@ -2223,19 +1678,6 @@ interface ParticleInterface { ACC_ANGLE_UPDATER, SPIN_UPDATER >): ParticleAttribute; - - /** - * create a particle array. - * - * @param { Particles } particles - Array of particles. - * @returns { ParticleAttribute } Returns the particle attribute. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 20 - * @arkts 1.2 - */ - (particles: Particles): ParticleAttribute; } /** @@ -2251,8 +1693,7 @@ interface ParticleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ declare enum ParticleType { /** @@ -2266,8 +1707,7 @@ declare enum ParticleType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ POINT = 'point', @@ -2282,8 +1722,7 @@ declare enum ParticleType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ IMAGE = 'image', } @@ -2301,8 +1740,7 @@ declare enum ParticleType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ declare enum ParticleEmitterShape { /** @@ -2316,8 +1754,7 @@ declare enum ParticleEmitterShape { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ RECTANGLE = 'rectangle', @@ -2332,8 +1769,7 @@ declare enum ParticleEmitterShape { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ CIRCLE = 'circle', @@ -2348,8 +1784,7 @@ declare enum ParticleEmitterShape { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ ELLIPSE = 'ellipse', @@ -2359,7 +1794,6 @@ declare enum ParticleEmitterShape { * @crossplatform * @atomicservice * @since 20 - * @arkts 1.1&1.2 */ ANNULUS = 'annulus', } @@ -2371,8 +1805,7 @@ declare enum ParticleEmitterShape { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ declare enum DistributionType { /** @@ -2381,19 +1814,17 @@ declare enum DistributionType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ UNIFORM = 0, /** * Gaussian distribution. - * + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ GAUSSIAN = 1, } @@ -2411,8 +1842,7 @@ declare enum DistributionType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ declare enum ParticleUpdater { /** @@ -2426,8 +1856,7 @@ declare enum ParticleUpdater { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ NONE = 'none', @@ -2442,8 +1871,7 @@ declare enum ParticleUpdater { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ RANDOM = 'random', @@ -2458,8 +1886,7 @@ declare enum ParticleUpdater { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ CURVE = 'curve', } @@ -2475,7 +1902,7 @@ declare enum ParticleUpdater { */ declare type SizeT = import('../api/arkui/Graphics').SizeT; - /** +/** * Defines the PositionT type. * * @typedef { import('../api/arkui/Graphics').PositionT } @@ -2499,8 +1926,7 @@ declare type PositionT = import('../api/arkui/Graphics').PositionT; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 * @noninterop */ declare class ParticleAttribute extends CommonMethod { @@ -2512,8 +1938,7 @@ declare class ParticleAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ disturbanceFields(fields: Array): ParticleAttribute; @@ -2525,8 +1950,7 @@ declare class ParticleAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ emitter(value : Array) : ParticleAttribute; } @@ -2553,8 +1977,7 @@ declare const Particle: ParticleInterface; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ declare interface DisturbanceFieldOptions { @@ -2568,8 +1991,7 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ strength?: number; @@ -2581,8 +2003,7 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ shape?: DisturbanceFieldShape; @@ -2594,8 +2015,7 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ size?: SizeT; @@ -2607,8 +2027,7 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ position?: PositionT; @@ -2624,8 +2043,7 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ feather?: number; @@ -2637,12 +2055,11 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ noiseScale?: number; - /** + /** * Noise frequency with a value greater or equal 0. * * @type { ?number } @@ -2650,8 +2067,7 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ noiseFrequency?: number; @@ -2663,8 +2079,7 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ noiseAmplitude?: number; } @@ -2676,8 +2091,7 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ declare enum DisturbanceFieldShape { @@ -2687,21 +2101,19 @@ declare enum DisturbanceFieldShape { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ - RECT, + RECT = 0, - /** + /** * Shape circle. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ - CIRCLE, + CIRCLE = 1, /** * Shape eclipse. @@ -2709,11 +2121,9 @@ declare enum DisturbanceFieldShape { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ - ELLIPSE - + ELLIPSE = 2 } /** @@ -2723,7 +2133,6 @@ declare enum DisturbanceFieldShape { * @crossplatform * @atomicservice * @since 20 - * @arkts 1.1&1.2 */ declare interface ParticleAnnulusRegion { /** @@ -2735,7 +2144,6 @@ declare interface ParticleAnnulusRegion { * @crossplatform * @atomicservice * @since 20 - * @arkts 1.1&1.2 */ center?: PositionT, /** @@ -2746,7 +2154,6 @@ declare interface ParticleAnnulusRegion { * @crossplatform * @atomicservice * @since 20 - * @arkts 1.1&1.2 */ outerRadius: LengthMetrics, /** @@ -2757,7 +2164,6 @@ declare interface ParticleAnnulusRegion { * @crossplatform * @atomicservice * @since 20 - * @arkts 1.1&1.2 */ innerRadius: LengthMetrics, /** @@ -2769,7 +2175,6 @@ declare interface ParticleAnnulusRegion { * @crossplatform * @atomicservice * @since 20 - * @arkts 1.1&1.2 */ startAngle?: number, /** @@ -2781,7 +2186,6 @@ declare interface ParticleAnnulusRegion { * @crossplatform * @atomicservice * @since 20 - * @arkts 1.1&1.2 */ endAngle?: number, } diff --git a/api/arkui/component/pageTransition.static.d.ets b/api/arkui/component/pageTransition.static.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..9fa5f7ca553be203440b5bfb92dd1d8e9715ee1b --- /dev/null +++ b/api/arkui/component/pageTransition.static.d.ets @@ -0,0 +1,258 @@ +'use static' +/* + * Copyright (c) 2025 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"), + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file + * @kit ArkUI + * @arkts 1.2 + */ + +import { ICurve, TranslateOptions, ScaleOptions } from './common'; +import { Curve } from "./enums"; +import { memo, ComponentBuilder } from "./../stateManagement/runtime"; +import { AttributeModifier, CommonMethod } from "./common"; +/** + * Declare the jump method. + * + * @enum { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare enum RouteType { + /** + * The page is not redirected. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + None, + /** + * Go to the next page. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + Push, + /** + * Redirect to a specified page. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + Pop +} +/** + * Declare the sliding effect of transition. + * + * @enum { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare enum SlideEffect { + /** + * Swipe left. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + Left, + /** + * Swipe right. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + Right, + /** + * Swipe top. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + Top, + /** + * Swipe bottom. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + Bottom, + /** + * Swipe start. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + START = 5, + /** + * Swipe end. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + END = 6 +} +/** + * Provides interfaces for common transitions. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare class CommonTransition { + /** + * Called when the slide in effect of the transition is set. + * + * @param { SlideEffect } value + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + slide(value: SlideEffect): this; + /** + * Called when the translation effect of page transition is set. + * + * @param { TranslateOptions } value + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + translate(value: TranslateOptions): this; + /** + * Called when setting the zoom effect of page transition. + * + * @param { ScaleOptions } value + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + scale(value: ScaleOptions): this; + /** + * Called when the transparency value of the starting point of entry or the ending point of exit is set. + * + * @param { number } value + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + opacity(value: number): this; +} +/** + * Defines pageTransition constructor parameters. + * + * @interface PageTransitionOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare interface PageTransitionOptions { + /** + * RouteType in which the pageTransition can work. + * @type { ?RouteType } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + type?: RouteType; + /** + * PageTransition animation duration, in ms. + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + duration?: number; + /** + * PageTransition animation curve. + * @type { ?(Curve | string | ICurve) } + * @default Curve.Linear + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + curve?: Curve | string | ICurve; + /** + * PageTransition animation delay time, in ms. + * @type { ?number } + * @default 0 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + delay?: number; +} +/** + * Callback used to report page trasition events. + * + * @typedef { function } PageTransitionCallback + * @param { RouteType } type - transition route type + * @param { number } progress - transition progess + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export type PageTransitionCallback = (type: RouteType, progress: number) => void; +/** + * Provides an interface to set transition style when a page enters. + * + * @extends CommonTransition + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare class PageTransitionEnter extends CommonTransition { + /** + * Called when page Jump animation is used. + * + * @param { PageTransitionOptions } value - pageTransition options + * @returns { PageTransitionEnter } + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + static $_invoke(value: PageTransitionOptions): PageTransitionEnter; + /** + * Called frame by frame to customize pageTransition animation when the page enters. + * The incoming parameter is the normalized progress of the current incoming animation. + * + * @param { PageTransitionCallback } event - animation callback frame by frame + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + onEnter(event: PageTransitionCallback): this; +} +/** + * Provide an interface to set transition style when a page exits. + * + * @extends CommonTransition + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare class PageTransitionExit extends CommonTransition { + /** + * Called when page Jump animation is used. + * + * @param { PageTransitionOptions } value - pageTransition options + * @returns { PageTransitionExit } + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + static $_invoke(value: PageTransitionOptions): PageTransitionExit; + /** + * Called frame by frame to customize pageTransition animation when the page exits. + * The input parameter is the normalized progress of the current exit animation. + * + * @param { PageTransitionCallback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + onExit(event: PageTransitionCallback): this; +} diff --git a/api/arkui/component/particle.static.d.ets b/api/arkui/component/particle.static.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..67008aeef22866a59507945560fe80c4ed98c191 --- /dev/null +++ b/api/arkui/component/particle.static.d.ets @@ -0,0 +1,919 @@ +'use static' +/* + * Copyright (c) 2025 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"), + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file + * @kit ArkUI + * @arkts 1.2 + */ + +import { LengthMetrics, SizeT, PositionT } from '../../arkui/Graphics'; +import { VP, ResourceStr, Dimension, ResourceColor } from "./units"; +import { ImageFit, Curve } from "./enums"; +import { ICurve, CommonMethod } from './common'; +import { memo, ComponentBuilder } from "./../stateManagement/runtime"; +import { AttributeModifier, CommonMethod } from "./common"; +/** + * Defines a pair of given type for particle. + * + * @typedef { [T1, T2] } ParticleTuple + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export type ParticleTuple = [ + T1, + T2 +]; +/** + * Defines velocity options. + * + * @typedef VelocityOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare interface VelocityOptions { + /** + * Particle speed. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + speed: ParticleTuple; + /** + * Angle of particle's direction. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + angle: ParticleTuple; +} +/** + * Defines acceleration options. + * + * @interface AccelerationOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare interface AccelerationOptions { + /** + * Speed property options. + * + * @type { ?ParticlePropertyOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + speed?: ParticlePropertyOptions; + /** + * Angle property options. + * + * @type { ?ParticlePropertyOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + angle?: ParticlePropertyOptions; +} +/** + * Defines the ParticleOptions Interface. + * @interface ParticleOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface ParticleOptions { + /** + * Particle emitter. + * @type { EmitterOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + emitter: EmitterOptions; + /** + * Particle color. + * @type { ?ParticleColorPropertyOptions } + * @default {range:['#FFFFFF','#FFFFFF']} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + color?: ParticleColorPropertyOptions; + /** + * Particle opacity. + * @type { ?ParticlePropertyOptions } + * @default {range:[1.0,1.0]} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + opacity?: ParticlePropertyOptions; + /** + * Particle scale. + * @type { ?ParticlePropertyOptions } + * @default {range:[1.0,1.0]} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + scale?: ParticlePropertyOptions; + /** + * Particle velocity. + * + * @type { ?VelocityOptions } + * @default {speed:[0,0];angle:[0,0]} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + velocity?: VelocityOptions; + /** + * Particle acceleration. + * + * @type { ?AccelerationOptions } + * @default {speed:{range:[0,0]};angle:{range:[0,0]}} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + acceleration?: AccelerationOptions; + /** + * Particle spin. + * @type { ?ParticlePropertyOptions } + * @default {range:[0,0]} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + spin?: ParticlePropertyOptions; +} +/** + * Defines the parameters for a point-like particle. + * @interface PointParticleParameters + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface PointParticleParameters { + /** + * Particle radius. + * @type { VP } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + radius: VP; +} +/** + * Defines the parameters for an image-like particle. + * @interface ImageParticleParameters + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface ImageParticleParameters { + /** + * Particle image pixelMap. + * @type { ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + src: ResourceStr; + /** + * Particle image size. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + size: ParticleTuple; + /** + * Image fit. + * @type { ?ImageFit } + * @default ImageFit.Cover + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + objectFit?: ImageFit; +} +/** + * Defines the particle configs. + * @typedef {PointParticleParameters | ImageParticleParameters} ParticleConfigs + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export type ParticleConfigs = PointParticleParameters | ImageParticleParameters; +/** + * Defines the emitter property. + * + * @interface EmitterProperty + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface EmitterProperty { + /** + * Emitter index. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + index: number; + /** + * Emitter emission rate. + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + emitRate?: number; + /** + * Emitter emission rate. Only support number type. + * + * @type { ?PositionT } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + position?: PositionT; + /** + * Emitter emission window size. Only support number type. + * + * @type { ?SizeT } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + size?: SizeT; + /** + * the description of the annulus region. This parameter is valid only for emitter whose shape is annulus. + * + * @type { ?ParticleAnnulusRegion } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + annulusRegion?: ParticleAnnulusRegion; +} +/** + * Defines parameters of particles used by emitters. + * + * @interface EmitterParticleOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface EmitterParticleOptions { + /** + * Particle type. + * + * @type { ParticleType } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + type: ParticleType; + /** + * Particle config. + * + * @type { ParticleConfigs } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + config: ParticleConfigs; + /** + * Particle count. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + count: number; + /** + * Particle lifetime. + * + * @type { ?number } + * @default 1000 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + lifetime?: number; + /** + * Particle lifetimeRange,value range [0, ∞). + * when lifetimeRange>lifetime,minimum lifetime is 0. + * + * @type { ?number } + * @default 0 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + lifetimeRange?: number; +} +/** + * Defines the emitter Options. + * @interface EmitterOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface EmitterOptions { + /** + * Set particle config. + * + * @type { EmitterParticleOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + particle: EmitterParticleOptions; + /** + * Emitting rate, that is, the number of particles produced per second. + * @type { ?number } + * @default 5 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + emitRate?: number; + /** + * Shape of emitter. + * @type { ?ParticleEmitterShape } + * @default ParticleEmitterShape.RECTANGLE + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + shape?: ParticleEmitterShape; + /** + * Position of emitter. + * The first element means X-axis location. + * The second element means the Y-axis location. + * + * @type { ?ParticleTuple } + * @default [0,0] + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + position?: ParticleTuple; + /** + * Size of emitter. + * The first element means emitter width. + * The second element means emitter height. + * + * @type { ?ParticleTuple } + * @default ['100%','100%'] + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + size?: ParticleTuple; + /** + * the description of the annulus region. This parameter is valid only for emitter whose shape is annulus. + * + * @type { ?ParticleAnnulusRegion } + * @default {innerRadius:LengthMetrics.vp(0),outerRadius:LengthMetrics.vp(0)} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + annulusRegion?: ParticleAnnulusRegion; +} +/** + * Defines the particle property updater configs. + * @typedef { undefined | ParticleTuple | Array> } ParticlePropertyUpdaterConfigs + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export type ParticlePropertyUpdaterConfigs = undefined | ParticleTuple | Array>; +/** + * Defines the particle updater options. + * + * @typedef ParticleUpdaterOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface ParticleUpdaterOptions { + /** + * Particle updater type. + * + * @type { ParticleUpdater } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + type: ParticleUpdater; + /** + * Particle updater configuration. + * + * @type { ParticlePropertyUpdaterConfigs } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + config: ParticlePropertyUpdaterConfigs; +} +/** + * Defines the particle color options. + * + * @typedef ParticleColorOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface ParticleColorOptions { + /** + * Red component of particle color. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + r: ParticleTuple; + /** + * Green component of particle color. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + g: ParticleTuple; + /** + * Blue component of particle color. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + b: ParticleTuple; + /** + * Opacity component of particle color. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + a: ParticleTuple; +} +/** + * Defines the particle color updater options. + * + * @interface ParticleColorUpdaterOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface ParticleColorUpdaterOptions { + /** + * Color updater. + * + * @type { ParticleUpdater } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + type: ParticleUpdater; + /** + * Color updater configuration. + * + * @type { ParticleColorPropertyUpdaterConfigs } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + config: ParticleColorPropertyUpdaterConfigs; +} +/** + * Defines the particle property Options. + * @interface ParticlePropertyOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface ParticlePropertyOptions { + /** + * Initial range, within which the initial value are randomly generated. + * + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + range: ParticleTuple; + /** + * Particle property updater. + * + * @type { ?ParticleUpdaterOptions } + * @default {type:UPDATER.NONE;config:undefined} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + updater?: ParticleUpdaterOptions; +} +/** + * Defines the particle color property updater configs. + * @typedef {undefined | ParticleColorOptions | Array>} ParticleColorPropertyUpdaterConfigs + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export type ParticleColorPropertyUpdaterConfigs = undefined | ParticleColorOptions | Array>; +/** + * Defines the particle color property updater. + * @interface ParticleColorPropertyOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface ParticleColorPropertyOptions { + /** + * Initial color range, within which the initial color is randomly generated. + * + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + range: ParticleTuple; + /** + * Distribution type of particle color. + * @type { ?DistributionType } + * @default DistributionType.UNIFORM + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + distributionType?: DistributionType; + /** + * Particle color property updater. + * + * @type { ?ParticleColorUpdaterOptions } + * @default {type:UPDATER.NONE;config:undefined} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + updater?: ParticleColorUpdaterOptions; +} +/** + * Defines the particle property lifecycle. + * @interface ParticlePropertyAnimation + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface ParticlePropertyAnimation { + /** + * Start position of the particle animation. + * @type { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + from: T; + /** + * End position of the particle animation. + * @type { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + to: T; + /** + * Start millis of the particle animation. + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + startMillis: number; + /** + * End millis of the particle animation. + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + endMillis: number; + /** + * Curve of the particle animation. + * @type { ?(Curve | ICurve) } + * @default Curve.Linear + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + curve?: Curve | ICurve; +} +/** + * Defines the Particles interface. + * + * @interface Particles + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface Particles { + /** + * Array of particles. + * + * @type { Array } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + particles: Array; +} +/** + * Enumerates the particle types. + * @enum { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare enum ParticleType { + /** + * Point-like particle. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + POINT = 'point', + /** + * Image-like particle. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + IMAGE = 'image' +} +/** + * Enumerates the emitter shapes of a particle. + * @enum { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare enum ParticleEmitterShape { + /** + * Rectangle. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + RECTANGLE = 'rectangle', + /** + * Circle. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + CIRCLE = 'circle', + /** + * Ellipse. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + ELLIPSE = 'ellipse', + /** + * Annulus. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + ANNULUS = 'annulus' +} +/** + * Enumerates the color distribution types of a particle. + * + * @enum { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare enum DistributionType { + /** + * Uniform distribution. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + UNIFORM = 0, + /** + * Gaussian distribution. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + GAUSSIAN = 1 +} +/** + * Enumerates the updater types of a particle. + * @enum { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare enum ParticleUpdater { + /** + * No updater is used. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + NONE = 'none', + /** + * Random updater. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + RANDOM = 'random', + /** + * Curve updater. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + CURVE = 'curve' +} +export declare interface ParticleAttribute extends CommonMethod { + /** + * Particle disturbance Field. + * + * @param { Array } fields - particle disturbance Field params. + * @returns { ParticleAttribute } Returns the particle attribute. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + disturbanceFields(fields: Array | undefined): this; + /** + * Add particle animation component properties. + * + * @param { Array } value - The emitter property. + * @returns { ParticleAttribute } Returns the particle attribute. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + emitter(value: Array | undefined): this; + + /** + * Add particle attribute modifier. + * + * @param { AttributeModifier | AttributeModifier | undefined } modifier - + * The AttributeModifier. + * @returns { ParticleAttribute } Returns the particle attribute. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + attributeModifier(modifier: AttributeModifier | AttributeModifier | undefined): this; +} +/** + * Defines particle disturbance Field params. + * @interface DisturbanceFieldOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare interface DisturbanceFieldOptions { + /** + * Strength of the repulsive force from the center outward, + * with positive numbers indicating outward repulsion and negative numbers indicating + * inward attraction. + * + * @type { ?number } + * @default 0 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + strength?: number; + /** + * Disturbance filed shape. + * + * @type { ?DisturbanceFieldShape } + * @default DisturbanceFieldShape.RECT + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + shape?: DisturbanceFieldShape; + /** + * Disturbance filed size width value width, height. + * + * @type { ?SizeT } + * @default {width:0,height:0} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + size?: SizeT; + /** + * Disturbance filed position width value x, y. + * + * @type { ?PositionT } + * @default {x:0,y:0} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + position?: PositionT; + /** + * Attenuation degree of the field from the center point to the field boundary. + * ranging from 0 to 100 integers. If 0, it indicates that the field is a rigid body, + * and all particles within the range will be excluded. + * a larger feather value indicates a greater degree of relaxation in the field, + * and more particles near the center point will appear in the field strength range. The default value is 0. + * + * @type { ?number } + * @default 0 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + feather?: number; + /** + * Scaling parameter is used to control the overall size of noise, with a value greater or equal 0. + * + * @type { ?number } + * @default 1 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + noiseScale?: number; + /** + * Noise frequency with a value greater or equal 0. + * + * @type { ?number } + * @default 1 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + noiseFrequency?: number; + /** + * NoiseAmplitude fluctuation range of noise, value, + * + * @type { ?number } + * @default 1 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + noiseAmplitude?: number; +} +/** + * Defines particle disturbance shape. + * + * @enum { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare enum DisturbanceFieldShape { + /** + * Shape rect. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + RECT, + /** + * Shape circle. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + CIRCLE, + /** + * Shape eclipse. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + ELLIPSE +} +/** + * Defines particle annuslus region params. + * @interface ParticleAnnulusRegion + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare interface ParticleAnnulusRegion { + /** + * The coordinates of the center of the annulus + * + * @type { ?PositionT } + * @default {x:LengthMetrics.percent(0.5),y:LengthMetrics.percent(0.5)} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + center?: PositionT; + /** + * The outer radius of the annulus + * + * @type { LengthMetrics } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + outerRadius: LengthMetrics; + /** + * The inner radius of the annulus + * + * @type { LengthMetrics } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + innerRadius: LengthMetrics; + /** + * The start angle of the annulus, in degree + * + * @type { ?number } + * @default 0 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + startAngle?: number; + /** + * The end angle of the annulus, in degree + * + * @type { ?number } + * @default 360 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + endAngle?: number; +} + + +/** + * Defines Particle Component + * + * @param { Particles } particles - particle constructor options + * @param { function } [content_] - container + * @returns { ParticleAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +@memo +@ComponentBuilder +export declare function Particle( + particles: Particles, + @memo + content_?: () => void, +): ParticleAttribute