From 646e2f77ad83edcfddbad53c2b5344da051f970f Mon Sep 17 00:00:00 2001 From: kukixi Date: Thu, 24 Mar 2022 22:36:13 +0800 Subject: [PATCH] fix docs errors Signed-off-by: kukixi --- .../application-dev/reference/apis/js-apis-router.md | 1 + .../arkui-ts/ts-basic-gestures-longpressgesture.md | 8 ++++---- .../arkui-ts/ts-basic-gestures-pangesture.md | 12 ++++++------ .../arkui-ts/ts-basic-gestures-pinchgesture.md | 12 ++++++------ .../arkui-ts/ts-basic-gestures-rotationgesture.md | 12 ++++++------ .../arkui-ts/ts-basic-gestures-swipegesture.md | 6 +++--- 6 files changed, 26 insertions(+), 25 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-router.md b/zh-cn/application-dev/reference/apis/js-apis-router.md index 8beca7c432..9812a3a0da 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-router.md +++ b/zh-cn/application-dev/reference/apis/js-apis-router.md @@ -310,6 +310,7 @@ getParams(): Object | 类型 | 说明 | | ------ | ---------------------------------- | | Object | 发起跳转的页面往当前页传入的参数。 | + **示例：** - 类Web范示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md index ebe9c8c129..c75ef770d2 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md @@ -25,11 +25,11 @@ LongPressGesture(options?: { fingers?: number, repeat?: boolean, duration?: numb | 名称 | 功能描述 | | -------- | -------- | -| onAction((event?: LongPressGestureEvent) => void) | LongPress手势识别成功回调。 | -| onActionEnd((event?: LongPressGestureEvent) => void) | LongPress手势识别成功，手指抬起后触发回调。 | +| onAction((event?: GestureEvent) => void) | LongPress手势识别成功回调。 | +| onActionEnd((event?: GestureEvent) => void) | LongPress手势识别成功，手指抬起后触发回调。 | | onActionCancel(event: () => void) | LongPress手势识别成功，接收到触摸取消事件触发回调。 | -- LongPressGestureEvent8+对象说明 +- GestureEvent对象中与LongPress手势相关的属性 | 属性名称 | 属性类型 | 描述 | | -------- | -------- | -------- | | repeat | boolean | 事件是否为重复触发事件。 | @@ -51,7 +51,7 @@ struct LongPressGestureExample { .gesture( LongPressGesture({ repeat: true }) //长按动作存在会连续触发 - .onAction((event: LongPressGestureEvent) => { + .onAction((event: GestureEvent) => { if (event.repeat) { this.count++ } }) //长按动作一结束触发 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md index b06b52f666..5475d871b6 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md @@ -54,12 +54,12 @@ PanGestureOptions(options?: { fingers?: number, direction?: PanDirection, distan | 名称 | 功能描述 | | -------- | -------- | -| onActionStart(callback: (event?: PanGestureEvent) => void) | Pan手势识别成功回调。 | -| onActionUpdate(callback: (event?: PanGestureEvent) => void) | Pan手势移动过程中回调。 | -| onActionEnd(callback: (event?: PanGestureEvent) => void) | Pan手势识别成功，手指抬起后触发回调。 | +| onActionStart(callback: (event?: GestureEvent) => void) | Pan手势识别成功回调。 | +| onActionUpdate(callback: (event?: GestureEvent) => void) | Pan手势移动过程中回调。 | +| onActionEnd(callback: (event?: GestureEvent) => void) | Pan手势识别成功，手指抬起后触发回调。 | | onActionCancel(callback: () => void) | Pan手势识别成功，接收到触摸取消事件触发回调。 | -- PanGestureEvent8+对象说明 +- GestureEvent对象中与Pan手势相关的属性 | 属性名称 | 属性类型 | 描述 | | -------- | -------- | -------- | | offsetX | number | 手势事件偏移量，单位为vp。 | @@ -83,10 +83,10 @@ struct PanGestureExample { .translate({ x: this.offsetX, y: this.offsetY, z: 5 }) .gesture( PanGesture({}) - .onActionStart((event: PanGestureEvent) => { + .onActionStart((event: GestureEvent) => { console.info('Pan start') }) - .onActionUpdate((event: PanGestureEvent) => { + .onActionUpdate((event: GestureEvent) => { this.offsetX = event.offsetX this.offsetY = event.offsetY }) diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md index 4d87009b04..d52439174f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md @@ -24,12 +24,12 @@ PinchGesture(options?: { fingers?: number, distance?: number }) | 名称 | 功能描述 | | -------- | -------- | -| onActionStart((event?: PinchGestureEvent) => void) | Pinch手势识别成功回调。 | -| onActionUpdate((event?: PinchGestureEvent) => void) | Pinch手势移动过程中回调。 | -| onActionEnd((event?: PinchGestureEvent) => void) | Pinch手势识别成功，手指抬起后触发回调。 | +| onActionStart((event?: GestureEvent) => void) | Pinch手势识别成功回调。 | +| onActionUpdate((event?: GestureEvent) => void) | Pinch手势移动过程中回调。 | +| onActionEnd((event?: GestureEvent) => void) | Pinch手势识别成功，手指抬起后触发回调。 | | onActionCancel(event: () => void) | Pinch手势识别成功，接收到触摸取消事件触发回调。 | -- PinchGestureEvent8+对象说明 +- GestureEvent对象中与Pinch手势相关的属性 | 属性名称 | 属性类型 | 描述 | | -------- | -------- | -------- | | scale | number | 缩放比例，用于PinchGesture手势触发场景。 | @@ -53,10 +53,10 @@ struct PinchGestureExample { .scale({ x: this.scale, y: this.scale, z: this.scale }) .gesture( PinchGesture() - .onActionStart((event: PinchGestureEvent) => { + .onActionStart((event: GestureEvent) => { console.info('Pinch start') }) - .onActionUpdate((event: PinchGestureEvent) => { + .onActionUpdate((event: GestureEvent) => { this.scale = event.scale }) .onActionEnd(() => { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md index 5c2a2d1d76..32db06fd1d 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md @@ -24,12 +24,12 @@ RotationGesture(options?: { fingers?: number, angle?: number }) | 名称 | 功能描述 | | -------- | -------- | -| onActionStart((event?: RotationGestureEvent) => void) | Rotation手势识别成功回调。 | -| onActionUpdate((event?: RotationGestureEvent) => void) | Rotation手势移动过程中回调。 | -| onActionEnd((event?: RotationGestureEvent) => void) | Rotation手势识别成功，手指抬起后触发回调。 | +| onActionStart((event?: GestureEvent) => void) | Rotation手势识别成功回调。 | +| onActionUpdate((event?: GestureEvent) => void) | Rotation手势移动过程中回调。 | +| onActionEnd((event?: GestureEvent) => void) | Rotation手势识别成功，手指抬起后触发回调。 | | onActionCancel(event: () => void) | Rotation手势识别成功，接收到触摸取消事件触发回调。 | -- RotationGestureEvent8+对象说明 +- GestureEvent对象中与Rotation手势相关的属性 | 属性名称 | 属性类型 | 描述 | | -------- | -------- | -------- | | angle | number | 旋转角度。 | @@ -51,10 +51,10 @@ struct RotationGestureExample { .margin(80).rotate({ x:1, y:2, z:3, angle: this.angle }) .gesture( RotationGesture() - .onActionStart((event: RotationGestureEvent) => { + .onActionStart((event: GestureEvent) => { console.log('Rotation start') }) - .onActionUpdate((event: RotationGestureEvent) => { + .onActionUpdate((event: GestureEvent) => { this.angle = event.angle }) .onActionEnd(() => { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md index ca0c9769e2..89d756487c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md @@ -32,10 +32,10 @@ SwipeGesture(value?: { fingers?: number; direction?: SwipeDirection; speed?: num | 名称 | 功能描述 | | -------- | -------- | -| onAction(callback:(event?: SwipeGestureEvent) => void) | 滑动手势识别成功回调。 | +| onAction(callback:(event?: GestureEvent) => void) | 滑动手势识别成功回调。 | -- SwipeGestureEvent对象说明 +- GestureEvent对象中与Swipe手势相关的属性 | 参数名 | 类型 | 说明 | | -------- | -------- | -------- | | angle | number | 滑动手势的角度。 | @@ -62,7 +62,7 @@ struct SwipeGestureExample { .rotate({x: 0, y: 0, z: 1, angle: this.rotateAngle}) .gesture( SwipeGesture({fingers: 1, direction:SwipeDirection.Vertical}) - .onAction((event: SwipeGestureEvent) => { + .onAction((event: GestureEvent) => { this.speed = event.speed this.rotateAngle = event.angle }) -- GitLab