From e6708fe09b7151575dde29680a95d5be797eb71f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=80=95=E9=BA=BB=E7=83=A6?= <354431057@qq.com>
Date: Sun, 25 May 2025 11:38:15 +0800
Subject: [PATCH 01/12] add live form docs
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: 怕麻烦 <354431057@qq.com>
---
.../form/arkts-ui-widget-configuration.md | 102 ++++++++++-
.../reference/apis-form-kit/errorcode-form.md | 20 ++-
.../js-apis-app-form-formHost-sys.md | 168 ++++++++++++++++++
.../js-apis-app-form-formInfo-sys.md | 65 ++++++-
.../js-apis-app-form-formInfo.md | 29 +++
.../js-apis-app-form-formProvider-sys.md | 102 +++++++++++
.../js-apis-app-form-formProvider.md | 161 +++++++++++++++++
7 files changed, 644 insertions(+), 3 deletions(-)
diff --git a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
index ae3fa170dae..f8382e2787c 100644
--- a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
+++ b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
@@ -65,6 +65,8 @@
|renderingMode|表示卡片的渲染模式，取值范围如下：
- autoColor：自动模式，锁屏卡片中心与桌面卡片中心/卡片管理内都可以显示的卡片。
- fullColor：全色模式，桌面卡片中心/卡片管理内可以显示的卡片。
- singleColor：单色模式，锁屏卡片中心内可以显示的卡片。 |字符串|可缺省，缺省值为“fullColor”。|
|multiScheduledUpdateTime|表示卡片的多定点刷新的时刻，作为单点刷新的一个附加参数，采用24小时制，精确到分钟，多个时间用英文逗号分隔，最多写24个时间。
**说明：**
multiScheduledUpdateTime需要配合scheduledUpdateTime使用。|字符串|可缺省，缺省时不进行多定点刷新。|
|conditionUpdate|表示卡片的支持的条件刷新（仅对系统应用的ArkTS卡片生效）。取值范围如下：
- network：表示支持网络刷新。|字符串|可缺省，缺省值为空字符串。|
+ |[funInteractionParams](#funinteractionparams标签)| 趣味交互类型互动卡片扩展字段 | 对象 | 可缺省，缺省为空。funInteractionParams 和 sceneAnimationParams 同时配置时识别为趣味交互类型互动卡片。|
+ |[sceneAnimationParams](#sceneanimationparams标签)| 场景动效类型互动卡片扩展字段 | 对象 | 可缺省，缺省为空。funInteractionParams 和 sceneAnimationParams 同时配置时识别为趣味交互类型互动卡片。|
## isDynamic标签
@@ -119,4 +121,102 @@
]
}
```
-
\ No newline at end of file
+
+
+## funInteractionParams标签
+
+此标签标识趣味交互类型互动卡片配置。
+
+| 名称 | 类型 | 必填 | 说明 |
+|--------|--------|----|------------------------------------------------------------|
+| abilityName | string | 否 | 趣味交互场景 extensionAbility 名称，默认为鸿蒙小游戏引擎对应 extensionAbility。|
+| targetBundleName | string | 是 | 趣味交互场景 RPK 资源 bundle 名称。|
+| subBundleName | string | 否 | 趣味交互场景 RPK 资源子 bundle 名称。 |
+| keepStateDuration | number | 否 | 趣味交互场景无交互时，激活态保持时长（单位 ms）保持时长限制不超过 10000ms，配置超过 10000ms 按照 10000ms 计。可缺省，缺省按 10000ms 计。 |
+
+配置示例如下：
+
+
+ ```json
+ {
+ "forms": [
+ {
+ "name": "widget",
+ "displayName": "$string:widget_display_name",
+ "description": "$string:widget_desc",
+ "src": "./ets/widget/pages/WidgetCard.ets",
+ "uiSyntax": "arkts",
+ "window": {
+ "designWidth": 720,
+ "autoDesignWidth": true
+ },
+ "colorMode": "auto",
+ "renderingMode": "fullColor",
+ "isDefault": true,
+ "updateEnabled": true,
+ "scheduledUpdateTime": "10:30",
+ "updateDuration": 1,
+ "defaultDimension": "2*2",
+ "supportDimensions": [
+ "2*2"
+ ],
+ "formConfigAbility": "ability://EntryAbility",
+ "dataProxyEnabled": false,
+ "isDynamic": true,
+ "transparencyEnabled": false,
+ "metadata": [],
+ "funInteractionParams": {
+ "targetBundleName": "com.example.funInteraction"
+ }
+ }
+ ]
+ }
+ ```
+
+
+## sceneAnimationParams标签
+
+此标签标识场景动效类型互动卡片配置。
+
+| 名称 | 类型 | 必填 | 说明 |
+|--------|--------|----|----------------------------|
+| abilityName | string | 是 | 场景动效 extensionAbility 名称，如卡片提供方 liveFormExtensionAbility 名称，相应业务逻辑需卡片提供方进一步开发。|
+| disabledDesktopBehaviors | string | 否 | 只针对系统应用生效，缺省为不禁用。支持禁用的用户操作有：滑动桌面（SWIPE_DESKTOP），下拉全搜（PULL_DOWN_SEARCH），长按（LONG_CLICK），拖动（DRAG）。配置时候通过 \| 的形式追加。例如 SWIPE_DESKTOP\|PULL_DOWN_SEARCH\|LONG_CLICK\|DRAG。 |
+
+
+ ```json
+ {
+ "forms": [
+ {
+ "name": "widget",
+ "displayName": "$string:widget_display_name",
+ "description": "$string:widget_desc",
+ "src": "./ets/widget/pages/WidgetCard.ets",
+ "uiSyntax": "arkts",
+ "window": {
+ "designWidth": 720,
+ "autoDesignWidth": true
+ },
+ "colorMode": "auto",
+ "renderingMode": "fullColor",
+ "isDefault": true,
+ "updateEnabled": true,
+ "scheduledUpdateTime": "10:30",
+ "updateDuration": 1,
+ "defaultDimension": "2*2",
+ "supportDimensions": [
+ "2*2"
+ ],
+ "formConfigAbility": "ability://EntryAbility",
+ "dataProxyEnabled": false,
+ "isDynamic": true,
+ "transparencyEnabled": false,
+ "metadata": [],
+ "sceneAnimationParams": {
+ "abilityName": "MyLiveFormExtensionAbility"
+ }
+ }
+ ]
+ }
+ ```
+
diff --git a/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md b/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md
index 0f0d2785993..cfd40e45c23 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md
@@ -185,6 +185,24 @@ Waiting for the form addition to the desktop timed out.
服务繁忙，请稍后重试。
+## 16501011 当前卡片不支持互动卡片能力
+
+**错误信息**
+
+The form can not support this operation, please check your fom_config's sceneAnimationParams configuration infomation is correct or not.
+
+**错误描述**
+
+当前卡片不支持互动卡片能力时，系统会报此错误码。
+
+**可能原因**
+
+普通卡片发起互动卡片动效请求，或者当前互动卡片配置错误。
+
+**处理步骤**
+
+检查当前卡片对应互动卡片配置是否正确。
+
## 2293761 内部服务错误
**错误信息**
@@ -301,4 +319,4 @@ Get system manager service failed.
**处理步骤**
1. 重启系统后重试。
-2. 重启后仍旧失败，请提[在线工单](http://developer.huawei.com/consumer/cn/support/feedback/#)获取帮助。
\ No newline at end of file
+2. 重启后仍旧失败，请提[在线工单](http://developer.huawei.com/consumer/cn/support/feedback/#)获取帮助。
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md
index 618501e5bd0..5ee64d8ca7b 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md
@@ -2885,4 +2885,172 @@ try {
console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}`);
}
+```
+
+## on('formOverflow')
+
+on(type: 'formOverflow', callback: Callback<formInfo.OverflowRequest>): void;
+
+订阅互动卡片动效请求事件。使用callback异步回调。互动卡片动效支持动效渲染范围超过卡片自身边界。
+
+**系统能力：** SystemCapability.Ability.Form
+
+**系统接口：** 此接口为系统接口。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+|----------|--------|---|-----------------------------------------|
+| type | string | 是 | 事件回调类型，支持的事件为'formOverflow'，表示互动卡片动效请求。|
+| callback | Callback<[formInfo.OverflowRequest](js-apis-app-form-formInfo-sys.md#OverflowRequest)> | 是 | 回调函数，返回动效处理函数。|
+
+**错误码：**
+
+以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
+
+| 错误码ID | 错误信息 |
+|-------|-----------------------------------------------------------------------------------------------------------|
+| 202 | The application is not a system application. |
+| 801 | Capability not supported.function formOverflow can not work correctly due to limited device capabilities. |
+
+**示例：**
+
+```ts
+import { formHost } from '@kit.FormKit';
+import { formInfo } from '@kit.FormKit';
+import { BusinessError } from '@kit.BasicServicesKit';
+
+try {
+ formHost.on('formOverflow', (request: formInfo.OverflowRequest) => {
+ console.log(`formHost on formOverflow, formId is ${request.formId}`);
+ });
+} catch (error) {
+ console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}`);
+}
+```
+
+## off('formOverflow')
+
+off(type: 'formOverflow', callback?: Callback<formInfo.OverflowRequest>): void;
+
+取消订阅互动卡片动效请求事件。使用callback异步回调。互动卡片动效支持动效渲染范围超过卡片自身边界。
+
+**系统能力：** SystemCapability.Ability.Form
+
+**系统接口：** 此接口为系统接口。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ |----|----------------------------------------|
+| type | string | 是 | 事件回调类型，支持的事件为'formOverflow'，表示互动卡片动效请求。|
+| callback |Callback<[formInfo.OverflowRequest](js-apis-app-form-formInfo-sys.md#OverflowRequest)> | 否 | 回调函数，返回动效处理函数。|
+
+**错误码：**
+
+以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
+
+| 错误码ID | 错误信息 |
+| --- |-----------------------------------------------------------------------------------------------------------|
+| 202 | The application is not a system application. |
+| 801 | Capability not supported.function formOverflow can not work correctly due to limited device capabilities. |
+
+**示例：**
+
+```ts
+import { formHost } from '@kit.FormKit';
+import { formInfo } from '@kit.FormKit';
+import { BusinessError } from '@kit.BasicServicesKit';
+
+try {
+ formHost.off('formOverflow', (request: formInfo.OverflowRequest) => {
+ console.log(`formHost off formOverflow, formId is ${request.formId}`);
+ });
+} catch (error) {
+ console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}`);
+}
+```
+
+## on('changeSceneAnimationState')
+
+on(type: 'changeSceneAnimationState', callback: Callback<formInfo.ChangeSceneAnimationStateRequest>): void;
+
+订阅互动卡片状态切换事件。使用callback异步回调。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 LiveFormExtensionAbility 进程，加载应用自定义页面。
+
+**系统能力：** SystemCapability.Ability.Form
+
+**系统接口：** 此接口为系统接口。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- |------------------------------------------------------|
+| type | string | 是 | 事件回调类型，支持的事件为'changeSceneAnimationState'，表示互动卡片状态切换。|
+| callback |Callback<[formInfo.ChangeSceneAnimationStateRequest](js-apis-app-form-formInfo-sys.md#ChangeSceneAnimationStateRequest)> | 是 | 回调函数，返回状态切换处理函数。|
+
+**错误码：**
+
+以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
+
+| 错误码ID | 错误信息 |
+|-------|-----------------------------------------------------------------------------------------------------------|
+| 202 | The application is not a system application. |
+| 801 | Capability not supported.function formOverflow can not work correctly due to limited device capabilities. |
+
+**示例：**
+
+```ts
+import { formHost } from '@kit.FormKit';
+import { formInfo } from '@kit.FormKit';
+import { BusinessError } from '@kit.BasicServicesKit';
+
+try {
+ formHost.on('changeSceneAnimationState', (request: formInfo.ChangeSceneAnimationStateRequest): void => {
+ console.log(`formHost on changeSceneAnimationState, formId is ${request.formId}`);
+ });
+} catch (error) {
+ console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}`);
+}
+```
+
+## off('changeSceneAnimationState')
+
+off(type: 'changeSceneAnimationState', callback: Callback<formInfo.changeSceneAnimationState>): void;
+
+取消订阅互动卡片状态切换事件。使用callback异步回调。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 LiveFormExtensionAbility 进程，加载应用自定义页面。
+
+**系统能力：** SystemCapability.Ability.Form
+
+**系统接口：** 此接口为系统接口。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ |----| ------- |
+| type | string | 是 | 事件回调类型，支持的事件为'changeSceneAnimationState'，表示互动卡片状态切换。|
+| callback |Callback<[formInfo.ChangeSceneAnimationStateRequest](js-apis-app-form-formInfo-sys.md#ChangeSceneAnimationStateRequest)> | 否 | 回调函数，返回状态切换处理函数。|
+
+**错误码：**
+
+以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
+
+| 错误码ID | 错误信息 |
+| -------- | -------- |
+| 202 | The application is not a system application. |
+| 801 | Capability not supported.function formOverflow can not work correctly due to limited device capabilities. |
+
+**示例：**
+
+```ts
+import { formHost } from '@kit.FormKit';
+import { formInfo } from '@kit.FormKit';
+import { BusinessError } from '@kit.BasicServicesKit';
+
+try {
+ formHost.off('changeSceneAnimationState', (request: formInfo.ChangeSceneAnimationStateRequest): void => {
+ console.log(`formHost off changeSceneAnimationState, formId is ${request.formId}`);
+ });
+} catch (error) {
+ console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}`);
+}
```
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
index 11c0d796fe6..69d4025e217 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
@@ -146,4 +146,67 @@ import { formInfo } from '@kit.FormKit';
| ----------- | ---- | ------------ |
| AUTO_COLOR | 0 | 表示自动模式。 |
| FULL_COLOR | 1 | 表示全色模式。 |
-| SINGLE_COLOR | 2 | 表示单色模式。 |
\ No newline at end of file
+| SINGLE_COLOR | 2 | 表示单色模式。 |
+
+## OverflowRequest20+
+
+互动卡片动效请求信息。
+
+**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。
+
+**系统能力：** SystemCapability.Ability.Form
+
+**系统接口：** 此接口为系统接口。
+
+| 名称 | 类型 | 必填 | 说明 |
+|--------------|---------|----|---------------------------------------------------------------|
+| formId | string | 是 | 卡片id。 |
+| isOverflow | boolean | 是 | true 表示互动卡片请求触发动效，false 表示互动卡片请求取消动效。|
+| overflowInfo | [formInfo.OverflowInfo](js-apis-app-form-formInfo.md#overflowinfo) | 否 | 动效请求参数信息，包括溢出动效时长（单位：ms）和溢出动效区域（溢出动效区域范围以卡片左上角为原点，单位为vp）默认为空。|
+
+## ChangeSceneAnimationStateRequest20+
+
+互动卡片状态切换请求信息。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 LiveFormExtensionAbility 进程，加载应用自定义页面。
+
+**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。
+
+**系统能力：** SystemCapability.Ability.Form
+
+**系统接口：** 此接口为系统接口。
+
+| 名称 | 类型 | 必填 | 说明 |
+|--------|--------|----|-----------------------------|
+| formId | string | 是 | 卡片id。|
+| state | number | 是 | 1 表示请求切换为激活态，0 表示请求切换为非激活态。|
+
+## FunInteractionParams20+
+
+趣味交互类型互动卡片配置参数。
+
+**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。
+
+**系统能力：** SystemCapability.Ability.Form
+
+**系统接口：** 此接口为系统接口。
+
+| 名称 | 类型 | 必填 | 说明 |
+|--------|--------|----|------------------------------------------------------------|
+| abilityName | string | 否 | 趣味交互场景 extensionAbility 名称，默认为鸿蒙小游戏引擎对应 extensionAbility。|
+| targetBundleName | string | 是 | 趣味交互场景 RPK 资源 bundle 名称。|
+| subBundleName | string | 否 | 趣味交互场景 RPK 资源子 bundle 名称。 |
+| keepStateDuration | number | 否 | 趣味交互场景无交互时，激活态保持时长（单位 ms）保持时长限制不超过 10000ms，配置超过 10000ms 按照 10000ms 计。可缺省，缺省按 10000ms 计。 |
+
+## SceneAnimationParams20+
+
+场景动效类型互动卡片配置参数。
+
+**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。
+
+**系统能力：** SystemCapability.Ability.Form
+
+**系统接口：** 此接口为系统接口。
+
+| 名称 | 类型 | 必填 | 说明 |
+|--------|--------|----|----------------------------|
+| abilityName | string | 是 | 场景动效 extensionAbility 名称，如卡片提供方 liveFormExtensionAbility名称。|
+| disabledDesktopBehaviors | string | 否 | 缺省为不禁用。支持禁用的用户操作有：滑动桌面（SWIPE_DESKTOP），下拉全搜（PULL_DOWN_SEARCH），长按（LONG_CLICK），拖动（DRAG）。配置时候通过 \| 的形式追加。例如 SWIPE_DESKTOP\|PULL_DOWN_SEARCH\|LONG_CLICK\|DRAG。 |
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md
index d174f5cd17f..bc70bc29724 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md
@@ -46,6 +46,8 @@ import { formInfo } from '@kit.FormKit';
| previewImages18+ | Array<number> | 是 | 否 | 卡片预览图资源ID。
**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。|
| enableBlurBackground18+ | boolean | 是 | 否 | 卡片是否使用模糊背板。
**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。|
| renderingMode18+|[RenderingMode](./js-apis-app-form-formInfo-sys.md#renderingmode18)|是|否|卡片渲染模式。
**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。|
+| funInteractionParams20+ | [FunInteractionParams](./js-apis-app-form-formInfo-sys.md#funinteractionparamssup20sup) | 是 | 否 | 趣味交互类型互动卡片配置参数。
**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。|
+| sceneAnimationParams20+ | [SceneAnimationParams](./js-apis-app-form-formInfo-sys.md#sceneanimationparamssup20sup) | 是 | 否 | 场景动效类型互动卡片配置参数。
**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。|
## FormType
@@ -197,3 +199,30 @@ import { formInfo } from '@kit.FormKit';
| FORM_DEFAULT | 1 | 表示卡片创建原因为默认创建。 |
| FORM_SHARE | 2 | 表示卡片创建原因为共享创建。 |
+## OverflowInfo20+
+
+互动卡片动效信息。
+
+**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。
+
+**系统能力：** SystemCapability.Ability.Form
+
+| 名称 | 类型 | 必填 | 说明 |
+|----------|--------|----|---------------------------------|
+| area | Rect | 是 | 描述溢出动效区域范围, 以卡片左上角为原点, 单位为vp。|
+| duration | number | 是 | 描述溢出动效区域持续时长。限制动效时长不超过 3500 ms。|
+
+## Rect20+
+
+互动卡片动效渲染区域参数。
+
+**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。
+
+**系统能力：** SystemCapability.Ability.Form
+
+| 字段名 | 类型 | 必填 | 说明 |
+|--------|--------|----|--------------------------|
+| left | number | 是 | 描述动效区域矩形的左上角顶点的 x 坐标，单位：vp。|
+| top | number | 是 | 描述动效区域矩形的左上角顶点的 y 坐标，单位：vp。|
+| width | number | 是 | 描述动效区域矩形的宽度，单位：vp。|
+| height | number | 是 | 描述动效区域矩形的高度，单位：vp。|
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
index 916f6c32694..f9cdcf561ad 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
@@ -322,4 +322,106 @@ try {
} catch (error) {
console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message})`);
}
+```
+
+## activateSceneAnimation20+
+
+activateSceneAnimation(formId: string): Promise<void>
+
+卡片提供方发起互动卡片状态切换到激活态请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneAnimationParams标签)生效。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 LiveFormExtensionAbility 进程，加载应用自定义页面。
+
+**系统能力：** SystemCapability.Ability.Form
+
+**系统接口：** 此接口为系统接口。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- |-------|
+| formId | string | 是 | 卡片id。 |
+
+**错误码：**
+
+以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[卡片错误码](errorcode-form.md)。
+
+| 错误码ID | 错误信息 |
+| -------- | -------- |
+| 202 | The application is not a system application. |
+| 801 | Capability not supported.function activateSceneAnimation can not work correctly due to limited device capabilities. |
+| 16500050 | IPC connection error. |
+| 16500060 | Service connection error. |
+| 16500100 | Failed to obtain the configuration information. |
+| 16501000 | An internal functional error occurred. |
+| 16501001 | The ID of the form to be operated does not exist. |
+| 16501003 | The form cannot be operated by the current application. |
+| 16501011 | The form can not support this operation, please check your fom_config's sceneAnimationParams configuration infomation is correct or not. |
+
+**示例：**
+
+```ts
+import { formProvider } from '@kit.FormKit';
+import { BusinessError } from '@kit.BasicServicesKit';
+
+let formId: string = '12400633174999288';
+
+try {
+ formProvider.activateSceneAnimation(formId).then(() => {
+ console.info('activateSceneAnimation succeed.');
+ }).catch((error: BusinessError) => {
+ console.error(`promise error, code: ${error.code}, message: ${error.message})`);
+ });
+} catch (error) {
+ console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message})`);
+}
+```
+
+## deactivateSceneAnimation20+
+
+deactivateSceneAnimation(formId: string): Promise<void>
+
+卡片提供方发起互动卡片状态切换到非激活态请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneAnimationParams标签)生效。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 LiveFormExtensionAbility 进程，加载应用自定义页面。
+
+**系统能力：** SystemCapability.Ability.Form
+
+**系统接口：** 此接口为系统接口。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- |-------|
+| formId | string | 是 | 卡片id。|
+
+**错误码：**
+
+以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[卡片错误码](errorcode-form.md)。
+
+| 错误码ID | 错误信息 |
+| -------- | -------- |
+| 202 | The application is not a system application. |
+| 801 | Capability not supported.function deactivateSceneAnimation can not work correctly due to limited device capabilities. |
+| 16500050 | IPC connection error. |
+| 16500060 | Service connection error. |
+| 16500100 | Failed to obtain the configuration information. |
+| 16501000 | An internal functional error occurred. |
+| 16501001 | The ID of the form to be operated does not exist. |
+| 16501003 | The form cannot be operated by the current application. |
+| 16501011 | The form can not support this operation, please check your fom_config's sceneAnimationParams configuration infomation is correct or not. |
+
+**示例：**
+
+```ts
+import { formProvider } from '@kit.FormKit';
+import { BusinessError } from '@kit.BasicServicesKit';
+
+let formId: string = '12400633174999288';
+
+try {
+ formProvider.deactivateSceneAnimation(formId).then(() => {
+ console.info('deactivateSceneAnimation succeed.');
+ }).catch((error: BusinessError) => {
+ console.error(`promise error, code: ${error.code}, message: ${error.message})`);
+ });
+} catch (error) {
+ console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message})`);
+}
```
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider.md
index 72d13dd8c50..cc33b5c6061 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider.md
@@ -594,4 +594,165 @@ try {
} catch (error) {
console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message})`);
}
+```
+
+## formProvider.requestOverflow20+
+
+requestOverflow(formId: string, overflowInfo: formInfo.OverflowInfo): Promise<void>
+
+卡片提供方发起互动卡片动效请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneAnimationParams标签)生效。
+
+**系统能力：** SystemCapability.Ability.Form
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ |--------------------------------------------------------------------| ---- |-----------|
+| formId | string | 是 | 卡片id标识。|
+| overflowInfo | [formInfo.OverflowInfo](js-apis-app-form-formInfo.md#overflowinfo) | 是 | 动效请求参数信息。|
+
+**错误码：**
+
+以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[卡片错误码](errorcode-form.md)。
+
+| 错误码ID | 错误信息 |
+| -------- | -------- |
+| 801 | Capability not supported.function cancelOverflow can not work correctly due to limited device capabilities. |
+| 16500050 | IPC connection error. |
+| 16500060 | Service connection error. |
+| 16500100 | Failed to obtain the configuration information. |
+| 16501000 | An internal functional error occurred. |
+| 16501001 | The ID of the form to be operated does not exist. |
+| 16501003 | The form cannot be operated by the current application. |
+| 16501011 | The form can not support this operation, please check your fom_config's sceneAnimationParams configuration infomation is correct or not. |
+
+**示例：**
+
+```ts
+import { formInfo } from '@kit.FormKit';
+import { formProvider } from '@kit.FormKit';
+import { BusinessError } from '@kit.BasicServicesKit';
+
+let formId: string = '12400633174999288';
+let overflowInfo: formInfo.OverflowInfo = {
+ area: {
+ left: -10,
+ top: -10,
+ width: 180,
+ height: 180
+ },
+ duration: 1000,
+};
+
+try {
+ formProvider.requestOverflow(formId, overflowInfo).then(() => {
+ console.info('requestOverflow succeed.');
+ }).catch((error: BusinessError) => {
+ console.error(`promise error, code: ${error.code}, message: ${error.message})`);
+ });
+} catch (error) {
+ console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message})`);
+}
+```
+
+## formProvider.cancelOverflow20+
+
+cancelOverflow(formId: string): Promise<void>;
+
+卡片提供方发起取消互动卡片动效请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneAnimationParams标签)生效。
+
+**系统能力：** SystemCapability.Ability.Form
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- |-------|
+| formId | string | 是 | 卡片id。|
+
+**错误码：**
+
+以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[卡片错误码](errorcode-form.md)。
+
+| 错误码ID | 错误信息 |
+| -------- | -------- |
+| 801 | Capability not supported.function cancelOverflow can not work correctly due to limited device capabilities. |
+| 16500050 | IPC connection error. |
+| 16500060 | Service connection error. |
+| 16500100 | Failed to obtain the configuration information. |
+| 16501000 | An internal functional error occurred. |
+| 16501001 | The ID of the form to be operated does not exist. |
+| 16501003 | The form cannot be operated by the current application. |
+| 16501011 | The form can not support this operation, please check your fom_config's sceneAnimationParams configuration infomation is correct or not. |
+
+**示例：**
+
+```ts
+import { formProvider } from '@kit.FormKit';
+import { BusinessError } from '@kit.BasicServicesKit';
+
+let formId: string = '12400633174999288';
+
+try {
+ formProvider.cancelOverflow(formId).then(() => {
+ console.info('cancelOverflow succeed.');
+ }).catch((error: BusinessError) => {
+ console.error(`promise error, code: ${error.code}, message: ${error.message})`);
+ });
+} catch (error) {
+ console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message})`);
+}
+```
+
+## formProvider.getFormRect20+
+
+getFormRect(formId: string): Promise<formInfo.Rect>
+
+获取卡片区域尺寸信息，使用Promise异步回调。
+
+**系统能力：** SystemCapability.Ability.Form
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- |-------|
+| formId | string | 是 | 卡片id。|
+
+**返回值：**
+
+| 类型 | 说明 |
+|-------------------------------------------------------------------|--------------------------|
+| Promise<[formInfo.Rect](js-apis-app-form-formInfo.md#Rect)> | Promise对象。返回查询到卡片区域尺寸信息。 |
+
+**错误码：**
+
+以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[卡片错误码](errorcode-form.md)。
+
+| 错误码ID | 错误信息 |
+| -------- | -------- |
+| 801 | Capability not supported.function cancelOverflow can not work correctly due to limited device capabilities. |
+| 16500050 | IPC connection error. |
+| 16500060 | Service connection error. |
+| 16500100 | Failed to obtain the configuration information. |
+| 16501000 | An internal functional error occurred. |
+| 16501001 | The ID of the form to be operated does not exist. |
+| 16501003 | The form cannot be operated by the current application. |
+
+**示例：**
+
+```ts
+import { formInfo } from '@kit.FormKit';
+import { formProvider } from '@kit.FormKit';
+import { BusinessError } from '@kit.BasicServicesKit';
+
+let formId: string = '12400633174999288';
+
+try {
+ formProvider.getFormRect(formId).then((data: formInfo.Rect) => {
+ console.info(`getFormRect succeed, rect data: ${JSON.stringify(data)}`);
+ }).catch((error: BusinessError) => {
+ console.error(`promise error, code: ${error.code}, message: ${error.message})`);
+ });
+} catch (error) {
+ console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message})`);
+}
```
\ No newline at end of file
--
Gitee
From e238913c5622364a5da6054f53f9dadd01db1506 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=80=95=E9=BA=BB=E7=83=A6?= <354431057@qq.com>
Date: Mon, 26 May 2025 23:51:46 +0800
Subject: [PATCH 02/12] add dv docs 5
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: 怕麻烦 <354431057@qq.com>
---
.../reference/apis-form-kit/js-apis-app-form-formInfo.md | 4 ++--
.../apis-form-kit/js-apis-app-form-formProvider-sys.md | 4 ++--
.../reference/apis-form-kit/js-apis-app-form-formProvider.md | 4 ++--
3 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md
index bc70bc29724..a887bff0230 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md
@@ -46,8 +46,8 @@ import { formInfo } from '@kit.FormKit';
| previewImages18+ | Array<number> | 是 | 否 | 卡片预览图资源ID。
**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。|
| enableBlurBackground18+ | boolean | 是 | 否 | 卡片是否使用模糊背板。
**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。|
| renderingMode18+|[RenderingMode](./js-apis-app-form-formInfo-sys.md#renderingmode18)|是|否|卡片渲染模式。
**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。|
-| funInteractionParams20+ | [FunInteractionParams](./js-apis-app-form-formInfo-sys.md#funinteractionparamssup20sup) | 是 | 否 | 趣味交互类型互动卡片配置参数。
**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。|
-| sceneAnimationParams20+ | [SceneAnimationParams](./js-apis-app-form-formInfo-sys.md#sceneanimationparamssup20sup) | 是 | 否 | 场景动效类型互动卡片配置参数。
**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。|
+| funInteractionParams20+ | [FunInteractionParams](./js-apis-app-form-formInfo-sys.md#funinteractionparams20) | 是 | 否 | 趣味交互类型互动卡片配置参数。
**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。|
+| sceneAnimationParams20+ | [SceneAnimationParams](./js-apis-app-form-formInfo-sys.md#sceneanimationparams20) | 是 | 否 | 场景动效类型互动卡片配置参数。
**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。|
## FormType
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
index f9cdcf561ad..a9cab43e894 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
@@ -328,7 +328,7 @@ try {
activateSceneAnimation(formId: string): Promise<void>
-卡片提供方发起互动卡片状态切换到激活态请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneAnimationParams标签)生效。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 LiveFormExtensionAbility 进程，加载应用自定义页面。
+卡片提供方发起互动卡片状态切换到激活态请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 LiveFormExtensionAbility 进程，加载应用自定义页面。
**系统能力：** SystemCapability.Ability.Form
@@ -379,7 +379,7 @@ try {
deactivateSceneAnimation(formId: string): Promise<void>
-卡片提供方发起互动卡片状态切换到非激活态请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneAnimationParams标签)生效。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 LiveFormExtensionAbility 进程，加载应用自定义页面。
+卡片提供方发起互动卡片状态切换到非激活态请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 LiveFormExtensionAbility 进程，加载应用自定义页面。
**系统能力：** SystemCapability.Ability.Form
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider.md
index cc33b5c6061..4df4584c34e 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider.md
@@ -600,7 +600,7 @@ try {
requestOverflow(formId: string, overflowInfo: formInfo.OverflowInfo): Promise<void>
-卡片提供方发起互动卡片动效请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneAnimationParams标签)生效。
+卡片提供方发起互动卡片动效请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效。
**系统能力：** SystemCapability.Ability.Form
@@ -659,7 +659,7 @@ try {
cancelOverflow(formId: string): Promise<void>;
-卡片提供方发起取消互动卡片动效请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneAnimationParams标签)生效。
+卡片提供方发起取消互动卡片动效请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效。
**系统能力：** SystemCapability.Ability.Form
--
Gitee
From 91874cc5d0b35ffcc51aaaec15842bbd9f343342 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=80=95=E9=BA=BB=E7=83=A6?= <354431057@qq.com>
Date: Mon, 26 May 2025 23:56:00 +0800
Subject: [PATCH 03/12] add dev doc
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: 怕麻烦 <354431057@qq.com>
---
zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md b/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md
index cfd40e45c23..d69ddb15334 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md
@@ -319,4 +319,4 @@ Get system manager service failed.
**处理步骤**
1. 重启系统后重试。
-2. 重启后仍旧失败，请提[在线工单](http://developer.huawei.com/consumer/cn/support/feedback/#)获取帮助。
+2. 重启后仍旧失败，请提[在线工单](http://developer.huawei.com/consumer/cn/support/feedback/#)获取帮助。
\ No newline at end of file
--
Gitee
From 89f65a6bdc58e519bfd215b37fd82b813d5cb3eb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=80=95=E9=BA=BB=E7=83=A6?= <354431057@qq.com>
Date: Tue, 27 May 2025 23:56:53 +0800
Subject: [PATCH 04/12] add devlop doc
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: 怕麻烦 <354431057@qq.com>
---
.../form/arkts-ui-widget-configuration.md | 67 ++++++++++++++++---
.../js-apis-app-form-formInfo-sys.md | 2 +-
2 files changed, 58 insertions(+), 11 deletions(-)
diff --git a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
index f8382e2787c..7b4c0c426d6 100644
--- a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
+++ b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
@@ -127,12 +127,12 @@
此标签标识趣味交互类型互动卡片配置。
-| 名称 | 类型 | 必填 | 说明 |
-|--------|--------|----|------------------------------------------------------------|
-| abilityName | string | 否 | 趣味交互场景 extensionAbility 名称，默认为鸿蒙小游戏引擎对应 extensionAbility。|
-| targetBundleName | string | 是 | 趣味交互场景 RPK 资源 bundle 名称。|
-| subBundleName | string | 否 | 趣味交互场景 RPK 资源子 bundle 名称。 |
-| keepStateDuration | number | 否 | 趣味交互场景无交互时，激活态保持时长（单位 ms）保持时长限制不超过 10000ms，配置超过 10000ms 按照 10000ms 计。可缺省，缺省按 10000ms 计。 |
+| 名称 | 类型 | 必填 | 说明 |
+|--------|-----|----|------------------------------------------------------------|
+| abilityName | 字符串 | 否 | 趣味交互场景 extensionAbility 名称，默认为鸿蒙小游戏引擎对应 extensionAbility。|
+| targetBundleName | 字符串 | 是 | 趣味交互场景 RPK 资源 bundle 名称。|
+| subBundleName | 字符串 | 否 | 趣味交互场景 RPK 资源子 bundle 名称。 |
+| keepStateDuration | 数值 | 否 | 趣味交互场景无交互时，激活态保持时长（单位 ms）保持时长限制不超过 10000ms，配置超过 10000ms 按照 10000ms 计。可缺省，缺省按 10000ms 计。 |
配置示例如下：
@@ -178,10 +178,10 @@
此标签标识场景动效类型互动卡片配置。
-| 名称 | 类型 | 必填 | 说明 |
-|--------|--------|----|----------------------------|
-| abilityName | string | 是 | 场景动效 extensionAbility 名称，如卡片提供方 liveFormExtensionAbility 名称，相应业务逻辑需卡片提供方进一步开发。|
-| disabledDesktopBehaviors | string | 否 | 只针对系统应用生效，缺省为不禁用。支持禁用的用户操作有：滑动桌面（SWIPE_DESKTOP），下拉全搜（PULL_DOWN_SEARCH），长按（LONG_CLICK），拖动（DRAG）。配置时候通过 \| 的形式追加。例如 SWIPE_DESKTOP\|PULL_DOWN_SEARCH\|LONG_CLICK\|DRAG。 |
+| 名称 | 类型 | 必填 | 说明 |
+|----------------------------------------|--------|----|----------------------------|
+| abilityName | 字符串 | 是 | 场景动效 extensionAbility 名称，如卡片提供方 liveFormExtensionAbility 名称，相应业务逻辑需卡片提供方进一步开发。|
+| disabledDesktopBehaviors | 字符串数组 | 否 | 只针对系统应用生效，缺省为不禁用。支持禁用的用户操作有：滑动桌面（SWIPE_DESKTOP），下拉全搜（PULL_DOWN_SEARCH），长按（LONG_CLICK），拖动（DRAG）。配置时候通过 \| 的形式追加。例如 SWIPE_DESKTOP\|PULL_DOWN_SEARCH\|LONG_CLICK\|DRAG。 |
```json
@@ -220,3 +220,50 @@
}
```
+
+
+
+系统应用配置样例
+
+
+ ```json
+ {
+ "forms": [
+ {
+ "name": "widget",
+ "displayName": "$string:widget_display_name",
+ "description": "$string:widget_desc",
+ "src": "./ets/widget/pages/WidgetCard.ets",
+ "uiSyntax": "arkts",
+ "window": {
+ "designWidth": 720,
+ "autoDesignWidth": true
+ },
+ "colorMode": "auto",
+ "renderingMode": "fullColor",
+ "isDefault": true,
+ "updateEnabled": true,
+ "scheduledUpdateTime": "10:30",
+ "updateDuration": 1,
+ "defaultDimension": "2*2",
+ "supportDimensions": [
+ "2*2"
+ ],
+ "formConfigAbility": "ability://EntryAbility",
+ "dataProxyEnabled": false,
+ "isDynamic": true,
+ "transparencyEnabled": false,
+ "metadata": [],
+ "sceneAnimationParams": {
+ "abilityName": "MyLiveFormExtensionAbility",
+ "disabledDesktopBehaviors": [
+ "LONG_CLICK", "DRAG", "SWIPE_DESKTOP", "PULL_DOWN_SEARCH"
+ ]
+ }
+ }
+ ]
+ }
+ ```
+
+
+
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
index 69d4025e217..63587135bff 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
@@ -209,4 +209,4 @@ import { formInfo } from '@kit.FormKit';
| 名称 | 类型 | 必填 | 说明 |
|--------|--------|----|----------------------------|
| abilityName | string | 是 | 场景动效 extensionAbility 名称，如卡片提供方 liveFormExtensionAbility名称。|
-| disabledDesktopBehaviors | string | 否 | 缺省为不禁用。支持禁用的用户操作有：滑动桌面（SWIPE_DESKTOP），下拉全搜（PULL_DOWN_SEARCH），长按（LONG_CLICK），拖动（DRAG）。配置时候通过 \| 的形式追加。例如 SWIPE_DESKTOP\|PULL_DOWN_SEARCH\|LONG_CLICK\|DRAG。 |
\ No newline at end of file
+| disabledDesktopBehaviors | string | 否 | 缺省为不禁用。支持禁用的用户操作有：滑动桌面（SWIPE_DESKTOP），下拉全搜（PULL_DOWN_SEARCH），长按（LONG_CLICK），拖动（DRAG）。通过 \| 的形式追加。例如 SWIPE_DESKTOP\|PULL_DOWN_SEARCH\|LONG_CLICK\|DRAG。 |
\ No newline at end of file
--
Gitee
From 1f18c60e50e83faed11a0e825a554d32b7a613c9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=80=95=E9=BA=BB=E7=83=A6?= <354431057@qq.com>
Date: Wed, 28 May 2025 00:09:29 +0800
Subject: [PATCH 05/12] add develop doc 2
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: 怕麻烦 <354431057@qq.com>
---
zh-cn/application-dev/form/arkts-ui-widget-configuration.md | 2 +-
.../reference/apis-form-kit/js-apis-app-form-formInfo-sys.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
index 7b4c0c426d6..681ebdb7781 100644
--- a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
+++ b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
@@ -181,7 +181,7 @@
| 名称 | 类型 | 必填 | 说明 |
|----------------------------------------|--------|----|----------------------------|
| abilityName | 字符串 | 是 | 场景动效 extensionAbility 名称，如卡片提供方 liveFormExtensionAbility 名称，相应业务逻辑需卡片提供方进一步开发。|
-| disabledDesktopBehaviors | 字符串数组 | 否 | 只针对系统应用生效，缺省为不禁用。支持禁用的用户操作有：滑动桌面（SWIPE_DESKTOP），下拉全搜（PULL_DOWN_SEARCH），长按（LONG_CLICK），拖动（DRAG）。配置时候通过 \| 的形式追加。例如 SWIPE_DESKTOP\|PULL_DOWN_SEARCH\|LONG_CLICK\|DRAG。 |
+| disabledDesktopBehaviors | 字符串数组 | 否 | 只针对系统应用生效，缺省为不禁用。支持禁用的用户操作有：滑动桌面（SWIPE_DESKTOP），下拉全搜（PULL_DOWN_SEARCH），长按（LONG_CLICK），拖动（DRAG）。 |
```json
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
index 63587135bff..fc0e675132f 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
@@ -209,4 +209,4 @@ import { formInfo } from '@kit.FormKit';
| 名称 | 类型 | 必填 | 说明 |
|--------|--------|----|----------------------------|
| abilityName | string | 是 | 场景动效 extensionAbility 名称，如卡片提供方 liveFormExtensionAbility名称。|
-| disabledDesktopBehaviors | string | 否 | 缺省为不禁用。支持禁用的用户操作有：滑动桌面（SWIPE_DESKTOP），下拉全搜（PULL_DOWN_SEARCH），长按（LONG_CLICK），拖动（DRAG）。通过 \| 的形式追加。例如 SWIPE_DESKTOP\|PULL_DOWN_SEARCH\|LONG_CLICK\|DRAG。 |
\ No newline at end of file
+| disabledDesktopBehaviors | string | 否 | 缺省为不禁用。支持禁用的用户操作有：滑动桌面（SWIPE_DESKTOP），下拉全搜（PULL_DOWN_SEARCH），长按（LONG_CLICK），拖动（DRAG）。通过 \| 的形式拼接。例如 SWIPE_DESKTOP\|PULL_DOWN_SEARCH\|LONG_CLICK\|DRAG。 |
\ No newline at end of file
--
Gitee
From fc1fb55c668be5f149b9570ff63fca34920196fd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=80=95=E9=BA=BB=E7=83=A6?= <354431057@qq.com>
Date: Fri, 30 May 2025 01:08:53 +0800
Subject: [PATCH 06/12] add develop doc 9
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: 怕麻烦 <354431057@qq.com>
---
.../form/arkts-ui-widget-configuration.md | 20 +++--
.../reference/apis-form-kit/errorcode-form.md | 2 +-
.../js-apis-app-form-formHost-sys.md | 50 ++++++------
.../js-apis-app-form-formInfo-sys.md | 50 +++++-------
.../js-apis-app-form-formInfo.md | 28 +++----
.../js-apis-app-form-formProvider-sys.md | 16 +++-
.../js-apis-app-form-formProvider.md | 77 ++++---------------
7 files changed, 96 insertions(+), 147 deletions(-)
diff --git a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
index 681ebdb7781..ae58003f636 100644
--- a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
+++ b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
@@ -65,8 +65,8 @@
|renderingMode|表示卡片的渲染模式，取值范围如下：
- autoColor：自动模式，锁屏卡片中心与桌面卡片中心/卡片管理内都可以显示的卡片。
- fullColor：全色模式，桌面卡片中心/卡片管理内可以显示的卡片。
- singleColor：单色模式，锁屏卡片中心内可以显示的卡片。 |字符串|可缺省，缺省值为“fullColor”。|
|multiScheduledUpdateTime|表示卡片的多定点刷新的时刻，作为单点刷新的一个附加参数，采用24小时制，精确到分钟，多个时间用英文逗号分隔，最多写24个时间。
**说明：**
multiScheduledUpdateTime需要配合scheduledUpdateTime使用。|字符串|可缺省，缺省时不进行多定点刷新。|
|conditionUpdate|表示卡片的支持的条件刷新（仅对系统应用的ArkTS卡片生效）。取值范围如下：
- network：表示支持网络刷新。|字符串|可缺省，缺省值为空字符串。|
- |[funInteractionParams](#funinteractionparams标签)| 趣味交互类型互动卡片扩展字段 | 对象 | 可缺省，缺省为空。funInteractionParams 和 sceneAnimationParams 同时配置时识别为趣味交互类型互动卡片。|
- |[sceneAnimationParams](#sceneanimationparams标签)| 场景动效类型互动卡片扩展字段 | 对象 | 可缺省，缺省为空。funInteractionParams 和 sceneAnimationParams 同时配置时识别为趣味交互类型互动卡片。|
+ |[funInteractionParams](#funinteractionparams标签)| 趣味交互类型互动卡片扩展字段。| 对象 | 可缺省，缺省为空。funInteractionParams 和 sceneAnimationParams 同时配置时识别为趣味交互类型互动卡片。|
+ |[sceneAnimationParams](#sceneanimationparams标签)| 场景动效类型互动卡片扩展字段。| 对象 | 可缺省，缺省为空。funInteractionParams 和 sceneAnimationParams 同时配置时识别为趣味交互类型互动卡片。|
## isDynamic标签
@@ -127,12 +127,12 @@
此标签标识趣味交互类型互动卡片配置。
-| 名称 | 类型 | 必填 | 说明 |
-|--------|-----|----|------------------------------------------------------------|
+| 名称 | 类型 | 必填 | 说明 |
+|--------|-----|----|------------------------------------------------------|
| abilityName | 字符串 | 否 | 趣味交互场景 extensionAbility 名称，默认为鸿蒙小游戏引擎对应 extensionAbility。|
-| targetBundleName | 字符串 | 是 | 趣味交互场景 RPK 资源 bundle 名称。|
-| subBundleName | 字符串 | 否 | 趣味交互场景 RPK 资源子 bundle 名称。 |
-| keepStateDuration | 数值 | 否 | 趣味交互场景无交互时，激活态保持时长（单位 ms）保持时长限制不超过 10000ms，配置超过 10000ms 按照 10000ms 计。可缺省，缺省按 10000ms 计。 |
+| targetBundleName | 字符串 | 是 | 趣味交互场景资源 bundle 名称。|
+| subBundleName | 字符串 | 否 | 趣味交互场景资源子 bundle 名称。 |
+| keepStateDuration | 数值 | 否 | 趣味交互场景无交互时，激活态保持时长。默认值为10000，单位ms。取值为[0,10000]的整数，超过取值范围则取默认值10000。 |
配置示例如下：
@@ -181,7 +181,7 @@
| 名称 | 类型 | 必填 | 说明 |
|----------------------------------------|--------|----|----------------------------|
| abilityName | 字符串 | 是 | 场景动效 extensionAbility 名称，如卡片提供方 liveFormExtensionAbility 名称，相应业务逻辑需卡片提供方进一步开发。|
-| disabledDesktopBehaviors | 字符串数组 | 否 | 只针对系统应用生效，缺省为不禁用。支持禁用的用户操作有：滑动桌面（SWIPE_DESKTOP），下拉全搜（PULL_DOWN_SEARCH），长按（LONG_CLICK），拖动（DRAG）。 |
+| disabledDesktopBehaviors | 字符串数组 | 否 | 缺省为不禁用。支持禁用的用户操作有：滑动桌面（SWIPE_DESKTOP），下拉全搜（PULL_DOWN_SEARCH），长按（LONG_CLICK），拖动（DRAG）。通过 \| 的形式拼接。例如 SWIPE_DESKTOP\|PULL_DOWN_SEARCH\|LONG_CLICK\|DRAG。 |
```json
@@ -256,9 +256,7 @@
"metadata": [],
"sceneAnimationParams": {
"abilityName": "MyLiveFormExtensionAbility",
- "disabledDesktopBehaviors": [
- "LONG_CLICK", "DRAG", "SWIPE_DESKTOP", "PULL_DOWN_SEARCH"
- ]
+ "disabledDesktopBehaviors": "LONG_CLICK|DRAG|SWIPE_DESKTOP|PULL_DOWN_SEARCH"
}
}
]
diff --git a/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md b/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md
index d69ddb15334..ba5f02b63fd 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md
@@ -201,7 +201,7 @@ The form can not support this operation, please check your fom_config's sceneAni
**处理步骤**
-检查当前卡片对应互动卡片配置是否正确。
+检查当前卡片对应[互动卡片配置](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)是否正确。
## 2293761 内部服务错误
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md
index 5ee64d8ca7b..6a06851c0fe 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md
@@ -2887,11 +2887,11 @@ try {
```
-## on('formOverflow')
+## formHost.on('formOverflow')20+
-on(type: 'formOverflow', callback: Callback<formInfo.OverflowRequest>): void;
+on(type: 'formOverflow', callback: Callback<formInfo.OverflowRequest>): void
-订阅互动卡片动效请求事件。使用callback异步回调。互动卡片动效支持动效渲染范围超过卡片自身边界。
+订阅互动卡片动效请求事件。
**系统能力：** SystemCapability.Ability.Form
@@ -2900,9 +2900,9 @@ on(type: 'formOverflow', callback: Callback<formInfo.OverflowRequest>): vo
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
-|----------|--------|---|-----------------------------------------|
-| type | string | 是 | 事件回调类型，支持的事件为'formOverflow'，表示互动卡片动效请求。|
-| callback | Callback<[formInfo.OverflowRequest](js-apis-app-form-formInfo-sys.md#OverflowRequest)> | 是 | 回调函数，返回动效处理函数。|
+|----------|--------|---|---------------------------------------|
+| type | string | 是 | 事件回调类型，仅支持事件'formOverflow'，表示互动卡片动效请求。|
+| callback | Callback<[formInfo.OverflowRequest](js-apis-app-form-formInfo-sys.md#overflowrequest20)> | 是 | 回调函数，用于卡片使用方对动效请求进行处理|
**错误码：**
@@ -2916,8 +2916,7 @@ on(type: 'formOverflow', callback: Callback<formInfo.OverflowRequest>): vo
**示例：**
```ts
-import { formHost } from '@kit.FormKit';
-import { formInfo } from '@kit.FormKit';
+import { formHost, formInfo } from '@kit.FormKit';
import { BusinessError } from '@kit.BasicServicesKit';
try {
@@ -2929,11 +2928,11 @@ try {
}
```
-## off('formOverflow')
+## formHost.off('formOverflow')20+
-off(type: 'formOverflow', callback?: Callback<formInfo.OverflowRequest>): void;
+off(type: 'formOverflow', callback?: Callback<formInfo.OverflowRequest>): void
-取消订阅互动卡片动效请求事件。使用callback异步回调。互动卡片动效支持动效渲染范围超过卡片自身边界。
+取消订阅互动卡片动效请求事件。
**系统能力：** SystemCapability.Ability.Form
@@ -2943,8 +2942,8 @@ off(type: 'formOverflow', callback?: Callback<formInfo.OverflowRequest>):
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ |----|----------------------------------------|
-| type | string | 是 | 事件回调类型，支持的事件为'formOverflow'，表示互动卡片动效请求。|
-| callback |Callback<[formInfo.OverflowRequest](js-apis-app-form-formInfo-sys.md#OverflowRequest)> | 否 | 回调函数，返回动效处理函数。|
+| type | string | 是 | 事件回调类型，仅支持事件'formOverflow'，表示互动卡片动效请求。 |
+| callback |Callback<[formInfo.OverflowRequest](js-apis-app-form-formInfo-sys.md#overflowrequest20)> | 否 | 回调函数，对应已订阅互动卡片动效请求。缺省时，表示注销所有已注册事件回调。 |
**错误码：**
@@ -2958,8 +2957,7 @@ off(type: 'formOverflow', callback?: Callback<formInfo.OverflowRequest>):
**示例：**
```ts
-import { formHost } from '@kit.FormKit';
-import { formInfo } from '@kit.FormKit';
+import { formHost, formInfo } from '@kit.FormKit';
import { BusinessError } from '@kit.BasicServicesKit';
try {
@@ -2971,11 +2969,11 @@ try {
}
```
-## on('changeSceneAnimationState')
+## formHost.on('changeSceneAnimationState')20+
-on(type: 'changeSceneAnimationState', callback: Callback<formInfo.ChangeSceneAnimationStateRequest>): void;
+on(type: 'changeSceneAnimationState', callback: Callback<formInfo.ChangeSceneAnimationStateRequest>): void
-订阅互动卡片状态切换事件。使用callback异步回调。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 LiveFormExtensionAbility 进程，加载应用自定义页面。
+订阅互动卡片状态切换请求事件。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 [LiveFormExtensionAbility](js-apis-app-form-LiveFormExtensionAbility.md) 进程，加载应用自定义页面。
**系统能力：** SystemCapability.Ability.Form
@@ -2986,7 +2984,7 @@ on(type: 'changeSceneAnimationState', callback: Callback<formInfo.ChangeScene
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- |------------------------------------------------------|
| type | string | 是 | 事件回调类型，支持的事件为'changeSceneAnimationState'，表示互动卡片状态切换。|
-| callback |Callback<[formInfo.ChangeSceneAnimationStateRequest](js-apis-app-form-formInfo-sys.md#ChangeSceneAnimationStateRequest)> | 是 | 回调函数，返回状态切换处理函数。|
+| callback |Callback<[formInfo.ChangeSceneAnimationStateRequest](js-apis-app-form-formInfo-sys.md#changesceneanimationstaterequest20)> | 是 | 回调函数，用于卡片使用方处理状态切换请求。|
**错误码：**
@@ -3000,8 +2998,7 @@ on(type: 'changeSceneAnimationState', callback: Callback<formInfo.ChangeScene
**示例：**
```ts
-import { formHost } from '@kit.FormKit';
-import { formInfo } from '@kit.FormKit';
+import { formHost, formInfo } from '@kit.FormKit';
import { BusinessError } from '@kit.BasicServicesKit';
try {
@@ -3013,11 +3010,11 @@ try {
}
```
-## off('changeSceneAnimationState')
+## formHost.off('changeSceneAnimationState')20+
-off(type: 'changeSceneAnimationState', callback: Callback<formInfo.changeSceneAnimationState>): void;
+off(type: 'changeSceneAnimationState', callback: Callback<formInfo.changeSceneAnimationState>): void
-取消订阅互动卡片状态切换事件。使用callback异步回调。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 LiveFormExtensionAbility 进程，加载应用自定义页面。
+取消订阅互动卡片状态切换请求事件。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 [LiveFormExtensionAbility](js-apis-app-form-LiveFormExtensionAbility.md) 进程，加载应用自定义页面。
**系统能力：** SystemCapability.Ability.Form
@@ -3028,7 +3025,7 @@ off(type: 'changeSceneAnimationState', callback: Callback<formInfo.changeScen
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ |----| ------- |
| type | string | 是 | 事件回调类型，支持的事件为'changeSceneAnimationState'，表示互动卡片状态切换。|
-| callback |Callback<[formInfo.ChangeSceneAnimationStateRequest](js-apis-app-form-formInfo-sys.md#ChangeSceneAnimationStateRequest)> | 否 | 回调函数，返回状态切换处理函数。|
+| callback |Callback<[formInfo.ChangeSceneAnimationStateRequest](js-apis-app-form-formInfo-sys.md#changesceneanimationstaterequest20)> | 否 | 回调函数，对应已订阅互动卡片状态切换请求。缺省时，表示注销所有已注册事件回调。|
**错误码：**
@@ -3042,8 +3039,7 @@ off(type: 'changeSceneAnimationState', callback: Callback<formInfo.changeScen
**示例：**
```ts
-import { formHost } from '@kit.FormKit';
-import { formInfo } from '@kit.FormKit';
+import { formHost, formInfo } from '@kit.FormKit';
import { BusinessError } from '@kit.BasicServicesKit';
try {
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
index fc0e675132f..9fc7025f8a3 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
@@ -152,61 +152,53 @@ import { formInfo } from '@kit.FormKit';
互动卡片动效请求信息。
-**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。
-
**系统能力：** SystemCapability.Ability.Form
**系统接口：** 此接口为系统接口。
-| 名称 | 类型 | 必填 | 说明 |
-|--------------|---------|----|---------------------------------------------------------------|
-| formId | string | 是 | 卡片id。 |
-| isOverflow | boolean | 是 | true 表示互动卡片请求触发动效，false 表示互动卡片请求取消动效。|
-| overflowInfo | [formInfo.OverflowInfo](js-apis-app-form-formInfo.md#overflowinfo) | 否 | 动效请求参数信息，包括溢出动效时长（单位：ms）和溢出动效区域（溢出动效区域范围以卡片左上角为原点，单位为vp）默认为空。|
+| 名称 | 类型 | 只读 | 可选 | 说明 |
+|-----|-----|----|----|-----|
+| formId | string | 是 | 否 | 卡片id。|
+| isOverflow | boolean | 是 | 否 | 动效请求类型标记，true 表示互动卡片请求触发动效，false 表示互动卡片请求取消动效。|
+| overflowInfo | [formInfo.OverflowInfo](js-apis-app-form-formInfo.md#overflowinfo20) | 是 | 是 | 动效请求参数信息，包括溢出动效时长（单位：ms）和溢出动效区域（溢出动效区域范围以卡片左上角为原点，单位为vp）默认为空。 |
## ChangeSceneAnimationStateRequest20+
互动卡片状态切换请求信息。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 LiveFormExtensionAbility 进程，加载应用自定义页面。
-**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。
-
**系统能力：** SystemCapability.Ability.Form
**系统接口：** 此接口为系统接口。
-| 名称 | 类型 | 必填 | 说明 |
-|--------|--------|----|-----------------------------|
-| formId | string | 是 | 卡片id。|
-| state | number | 是 | 1 表示请求切换为激活态，0 表示请求切换为非激活态。|
+| 名称 | 类型 | 只读 | 可选 | 说明 |
+|-----|-----|-----|-----|----------------------------------------|
+| formId | string | 是 | 否 | 卡片id。 |
+| state | number | 是 | 否 | 状态切换请求类型标记：1 表示请求切换为激活态，0 表示请求切换为非激活态。 |
## FunInteractionParams20+
-趣味交互类型互动卡片配置参数。
-
-**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。
+趣味交互卡片配置参数。
**系统能力：** SystemCapability.Ability.Form
**系统接口：** 此接口为系统接口。
-| 名称 | 类型 | 必填 | 说明 |
-|--------|--------|----|------------------------------------------------------------|
-| abilityName | string | 否 | 趣味交互场景 extensionAbility 名称，默认为鸿蒙小游戏引擎对应 extensionAbility。|
-| targetBundleName | string | 是 | 趣味交互场景 RPK 资源 bundle 名称。|
-| subBundleName | string | 否 | 趣味交互场景 RPK 资源子 bundle 名称。 |
-| keepStateDuration | number | 否 | 趣味交互场景无交互时，激活态保持时长（单位 ms）保持时长限制不超过 10000ms，配置超过 10000ms 按照 10000ms 计。可缺省，缺省按 10000ms 计。 |
+| 名称 | 类型 | 只读 | 可选 | 说明 |
+|-----|-----|----|-----|-----------------------------------------------------------------------------------------|
+| abilityName | string | 是 | 是 | 趣味交互场景 extensionAbility 名称，默认为鸿蒙快游戏引擎对应 ability |
+| targetBundleName | string | 是 | 否 | 趣味交互场景 RPK 资源 bundle 名称。 |
+| subBundleName | string | 是 | 否 | 趣味交互场景 RPK 资源子 bundle 名称。 |
+| keepStateDuration | number | 是 | 是 | 趣味交互场景无交互时，激活态保持时长。默认值为10000，单位ms。取值为[0,10000]的整数，超过取值范围则取默认值10000。 |
## SceneAnimationParams20+
-场景动效类型互动卡片配置参数。
-
-**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。
+场景动效卡片配置参数。
**系统能力：** SystemCapability.Ability.Form
**系统接口：** 此接口为系统接口。
-| 名称 | 类型 | 必填 | 说明 |
-|--------|--------|----|----------------------------|
-| abilityName | string | 是 | 场景动效 extensionAbility 名称，如卡片提供方 liveFormExtensionAbility名称。|
-| disabledDesktopBehaviors | string | 否 | 缺省为不禁用。支持禁用的用户操作有：滑动桌面（SWIPE_DESKTOP），下拉全搜（PULL_DOWN_SEARCH），长按（LONG_CLICK），拖动（DRAG）。通过 \| 的形式拼接。例如 SWIPE_DESKTOP\|PULL_DOWN_SEARCH\|LONG_CLICK\|DRAG。 |
\ No newline at end of file
+| 名称 | 类型 | 只读 | 可选 | 说明 |
+|-----|-----|------|----|-----------------------------------------------------------------------------------------|
+| abilityName | string | 是 | 否 | 场景动效 extensionAbility 名称，如卡片提供方 liveFormExtensionAbility名称。|
+| disabledDesktopBehaviors | string | 是 | 是 | 缺省为不禁用。支持禁用的用户操作有：滑动桌面（SWIPE_DESKTOP），下拉全搜（PULL_DOWN_SEARCH），长按（LONG_CLICK），拖动（DRAG）。通过 \| 的形式拼接。例如 SWIPE_DESKTOP\|PULL_DOWN_SEARCH\|LONG_CLICK\|DRAG。 |
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md
index a887bff0230..d96ec95d920 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md
@@ -46,8 +46,6 @@ import { formInfo } from '@kit.FormKit';
| previewImages18+ | Array<number> | 是 | 否 | 卡片预览图资源ID。
**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。|
| enableBlurBackground18+ | boolean | 是 | 否 | 卡片是否使用模糊背板。
**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。|
| renderingMode18+|[RenderingMode](./js-apis-app-form-formInfo-sys.md#renderingmode18)|是|否|卡片渲染模式。
**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。|
-| funInteractionParams20+ | [FunInteractionParams](./js-apis-app-form-formInfo-sys.md#funinteractionparams20) | 是 | 否 | 趣味交互类型互动卡片配置参数。
**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。|
-| sceneAnimationParams20+ | [SceneAnimationParams](./js-apis-app-form-formInfo-sys.md#sceneanimationparams20) | 是 | 否 | 场景动效类型互动卡片配置参数。
**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。|
## FormType
@@ -203,26 +201,22 @@ import { formInfo } from '@kit.FormKit';
互动卡片动效信息。
-**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。
-
**系统能力：** SystemCapability.Ability.Form
-| 名称 | 类型 | 必填 | 说明 |
-|----------|--------|----|---------------------------------|
-| area | Rect | 是 | 描述溢出动效区域范围, 以卡片左上角为原点, 单位为vp。|
-| duration | number | 是 | 描述溢出动效区域持续时长。限制动效时长不超过 3500 ms。|
+| 名称 | 类型 | 只读 | 可选 | 说明 |
+|-----|-----|------|-----|----------------------------------------|
+| area | [Rect](#rectsup20sup) | 是 | 否 | 描述溢出动效区域范围, 以卡片左上角为原点, 单位为vp。 |
+| duration | number | 是 | 否 | 溢出动效持续时长。取值为大于0、小于等于3500的整数，单位ms。 |
## Rect20+
-互动卡片动效渲染区域参数。
-
-**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。
+通用矩形区域信息。
**系统能力：** SystemCapability.Ability.Form
-| 字段名 | 类型 | 必填 | 说明 |
-|--------|--------|----|--------------------------|
-| left | number | 是 | 描述动效区域矩形的左上角顶点的 x 坐标，单位：vp。|
-| top | number | 是 | 描述动效区域矩形的左上角顶点的 y 坐标，单位：vp。|
-| width | number | 是 | 描述动效区域矩形的宽度，单位：vp。|
-| height | number | 是 | 描述动效区域矩形的高度，单位：vp。|
\ No newline at end of file
+| 名称 | 类型 | 只读 | 可选 | 说明 |
+|-----|-----|------|-----|-------|
+| left | number | 是 | 否 | 描述矩形的左上角顶点的 x 坐标，单位：vp。|
+| top | number | 是 | 否 | 描述矩形的左上角顶点的 y 坐标，单位：vp。|
+| width | number | 是 | 否 | 描述矩形的宽度，单位：vp。|
+| height | number | 是 | 否 | 描述矩形的高度，单位：vp。|
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
index a9cab43e894..9c0a5d4e459 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
@@ -328,7 +328,7 @@ try {
activateSceneAnimation(formId: string): Promise<void>
-卡片提供方发起互动卡片状态切换到激活态请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 LiveFormExtensionAbility 进程，加载应用自定义页面。
+互动卡片请求状态切换到激活态，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。
**系统能力：** SystemCapability.Ability.Form
@@ -340,6 +340,12 @@ activateSceneAnimation(formId: string): Promise<void>
| ------ | ------ | ---- |-------|
| formId | string | 是 | 卡片id。 |
+**返回值：**
+
+| 类型 | 说明 |
+| -------- | -------- |
+| Promise<void> | 无返回结果的Promise对象。 |
+
**错误码：**
以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[卡片错误码](errorcode-form.md)。
@@ -379,7 +385,7 @@ try {
deactivateSceneAnimation(formId: string): Promise<void>
-卡片提供方发起互动卡片状态切换到非激活态请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 LiveFormExtensionAbility 进程，加载应用自定义页面。
+互动卡片请求切换到非激活态，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。
**系统能力：** SystemCapability.Ability.Form
@@ -391,6 +397,12 @@ deactivateSceneAnimation(formId: string): Promise<void>
| ------ | ------ | ---- |-------|
| formId | string | 是 | 卡片id。|
+**返回值：**
+
+| 类型 | 说明 |
+| -------- | -------- |
+| Promise<void> | 无返回结果的Promise对象。 |
+
**错误码：**
以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[卡片错误码](errorcode-form.md)。
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider.md
index 4df4584c34e..0d281e9db1c 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider.md
@@ -600,7 +600,7 @@ try {
requestOverflow(formId: string, overflowInfo: formInfo.OverflowInfo): Promise<void>
-卡片提供方发起互动卡片动效请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效。
+卡片提供方发起互动卡片动效请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。
**系统能力：** SystemCapability.Ability.Form
@@ -609,7 +609,13 @@ requestOverflow(formId: string, overflowInfo: formInfo.OverflowInfo): Promise<
| 参数名 | 类型 | 必填 | 说明 |
| ------ |--------------------------------------------------------------------| ---- |-----------|
| formId | string | 是 | 卡片id标识。|
-| overflowInfo | [formInfo.OverflowInfo](js-apis-app-form-formInfo.md#overflowinfo) | 是 | 动效请求参数信息。|
+| overflowInfo | [formInfo.OverflowInfo](js-apis-app-form-formInfo.md#overflowinfo20) | 是 | 动效请求参数信息。|
+
+**返回值：**
+
+| 类型 | 说明 |
+| -------- | -------- |
+| Promise<void> | 无返回结果的Promise对象。 |
**错误码：**
@@ -629,8 +635,7 @@ requestOverflow(formId: string, overflowInfo: formInfo.OverflowInfo): Promise<
**示例：**
```ts
-import { formInfo } from '@kit.FormKit';
-import { formProvider } from '@kit.FormKit';
+import { formInfo, formProvider } from '@kit.FormKit';
import { BusinessError } from '@kit.BasicServicesKit';
let formId: string = '12400633174999288';
@@ -657,57 +662,9 @@ try {
## formProvider.cancelOverflow20+
-cancelOverflow(formId: string): Promise<void>;
+cancelOverflow(formId: string): Promise<void>
-卡片提供方发起取消互动卡片动效请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效。
-
-**系统能力：** SystemCapability.Ability.Form
-
-**参数：**
-
-| 参数名 | 类型 | 必填 | 说明 |
-| ------ | ------ | ---- |-------|
-| formId | string | 是 | 卡片id。|
-
-**错误码：**
-
-以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[卡片错误码](errorcode-form.md)。
-
-| 错误码ID | 错误信息 |
-| -------- | -------- |
-| 801 | Capability not supported.function cancelOverflow can not work correctly due to limited device capabilities. |
-| 16500050 | IPC connection error. |
-| 16500060 | Service connection error. |
-| 16500100 | Failed to obtain the configuration information. |
-| 16501000 | An internal functional error occurred. |
-| 16501001 | The ID of the form to be operated does not exist. |
-| 16501003 | The form cannot be operated by the current application. |
-| 16501011 | The form can not support this operation, please check your fom_config's sceneAnimationParams configuration infomation is correct or not. |
-
-**示例：**
-
-```ts
-import { formProvider } from '@kit.FormKit';
-import { BusinessError } from '@kit.BasicServicesKit';
-
-let formId: string = '12400633174999288';
-
-try {
- formProvider.cancelOverflow(formId).then(() => {
- console.info('cancelOverflow succeed.');
- }).catch((error: BusinessError) => {
- console.error(`promise error, code: ${error.code}, message: ${error.message})`);
- });
-} catch (error) {
- console.error(`catch error, code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message})`);
-}
-```
-
-## formProvider.getFormRect20+
-
-getFormRect(formId: string): Promise<formInfo.Rect>
-
-获取卡片区域尺寸信息，使用Promise异步回调。
+卡片提供方发起取消互动卡片动效请求，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。
**系统能力：** SystemCapability.Ability.Form
@@ -719,9 +676,9 @@ getFormRect(formId: string): Promise<formInfo.Rect>
**返回值：**
-| 类型 | 说明 |
-|-------------------------------------------------------------------|--------------------------|
-| Promise<[formInfo.Rect](js-apis-app-form-formInfo.md#Rect)> | Promise对象。返回查询到卡片区域尺寸信息。 |
+| 类型 | 说明 |
+| -------- | -------- |
+| Promise<void> | 无返回结果的Promise对象。 |
**错误码：**
@@ -736,19 +693,19 @@ getFormRect(formId: string): Promise<formInfo.Rect>
| 16501000 | An internal functional error occurred. |
| 16501001 | The ID of the form to be operated does not exist. |
| 16501003 | The form cannot be operated by the current application. |
+| 16501011 | The form can not support this operation, please check your fom_config's sceneAnimationParams configuration infomation is correct or not. |
**示例：**
```ts
-import { formInfo } from '@kit.FormKit';
import { formProvider } from '@kit.FormKit';
import { BusinessError } from '@kit.BasicServicesKit';
let formId: string = '12400633174999288';
try {
- formProvider.getFormRect(formId).then((data: formInfo.Rect) => {
- console.info(`getFormRect succeed, rect data: ${JSON.stringify(data)}`);
+ formProvider.cancelOverflow(formId).then(() => {
+ console.info('cancelOverflow succeed.');
}).catch((error: BusinessError) => {
console.error(`promise error, code: ${error.code}, message: ${error.message})`);
});
--
Gitee
From bbd041fe5145ac3467e2c59c72912d73a35f84e2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=80=95=E9=BA=BB=E7=83=A6?= <354431057@qq.com>
Date: Fri, 30 May 2025 01:15:42 +0800
Subject: [PATCH 07/12] add develop doc 10
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: 怕麻烦 <354431057@qq.com>
---
.../apis-form-kit/js-apis-app-form-formInfo-sys.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
index 9fc7025f8a3..e4d95b52749 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
@@ -164,7 +164,7 @@ import { formInfo } from '@kit.FormKit';
## ChangeSceneAnimationStateRequest20+
-互动卡片状态切换请求信息。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 LiveFormExtensionAbility 进程，加载应用自定义页面。
+互动卡片状态切换请求信息。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 [LiveFormExtensionAbility](js-apis-app-form-LiveFormExtensionAbility.md) 进程，加载应用自定义页面。
**系统能力：** SystemCapability.Ability.Form
@@ -198,7 +198,7 @@ import { formInfo } from '@kit.FormKit';
**系统接口：** 此接口为系统接口。
-| 名称 | 类型 | 只读 | 可选 | 说明 |
-|-----|-----|------|----|-----------------------------------------------------------------------------------------|
-| abilityName | string | 是 | 否 | 场景动效 extensionAbility 名称，如卡片提供方 liveFormExtensionAbility名称。|
-| disabledDesktopBehaviors | string | 是 | 是 | 缺省为不禁用。支持禁用的用户操作有：滑动桌面（SWIPE_DESKTOP），下拉全搜（PULL_DOWN_SEARCH），长按（LONG_CLICK），拖动（DRAG）。通过 \| 的形式拼接。例如 SWIPE_DESKTOP\|PULL_DOWN_SEARCH\|LONG_CLICK\|DRAG。 |
\ No newline at end of file
+| 名称 | 类型 | 只读 | 可选 | 说明 |
+|-----|-----|------|----|--------------------------------------------------------------------------------------------------------------------------------------------------|
+| abilityName | string | 是 | 否 | 场景动效 extensionAbility 名称，如卡片提供方 [LiveFormExtensionAbility](js-apis-app-form-LiveFormExtensionAbility.md) 名称。 |
+| disabledDesktopBehaviors | string | 是 | 是 | 支持的取值包括SWIPE_DESKTOP（滑动桌面）、PULL_DOWN_SEARCH（下拉全搜）、LONG_CLICK（长按）、DRAG（拖动）。可以取值一个或多个，不同行为通过 \| 拼接，例如SWIPE_DESKTOP \|PULL_DOWN_SEARCH。缺省表示不禁用任何行为。 |
\ No newline at end of file
--
Gitee
From 6eeabd6873bccbe14f38fc6ba0f7328bc19b926d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=80=95=E9=BA=BB=E7=83=A6?= <354431057@qq.com>
Date: Fri, 30 May 2025 01:21:09 +0800
Subject: [PATCH 08/12] add develop doc 11
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: 怕麻烦 <354431057@qq.com>
---
zh-cn/application-dev/form/arkts-ui-widget-configuration.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
index ae58003f636..673aa8bc6b0 100644
--- a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
+++ b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
@@ -181,7 +181,7 @@
| 名称 | 类型 | 必填 | 说明 |
|----------------------------------------|--------|----|----------------------------|
| abilityName | 字符串 | 是 | 场景动效 extensionAbility 名称，如卡片提供方 liveFormExtensionAbility 名称，相应业务逻辑需卡片提供方进一步开发。|
-| disabledDesktopBehaviors | 字符串数组 | 否 | 缺省为不禁用。支持禁用的用户操作有：滑动桌面（SWIPE_DESKTOP），下拉全搜（PULL_DOWN_SEARCH），长按（LONG_CLICK），拖动（DRAG）。通过 \| 的形式拼接。例如 SWIPE_DESKTOP\|PULL_DOWN_SEARCH\|LONG_CLICK\|DRAG。 |
+| disabledDesktopBehaviors | 字符串数组 | 否 | 支持的取值包括SWIPE_DESKTOP（滑动桌面）、PULL_DOWN_SEARCH（下拉全搜）、LONG_CLICK（长按）、DRAG（拖动）。可以取值一个或多个，不同行为通过 \| 拼接，例如SWIPE_DESKTOP \|PULL_DOWN_SEARCH。缺省表示不禁用任何行为。 |
```json
--
Gitee
From 86be3d1547baea9ccbf43951511cf4426aad1ecd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=80=95=E9=BA=BB=E7=83=A6?= <354431057@qq.com>
Date: Fri, 30 May 2025 12:17:56 +0800
Subject: [PATCH 09/12] add develop doc
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: 怕麻烦 <354431057@qq.com>
---
.../form/arkts-ui-widget-configuration.md | 120 ++++--------------
.../reference/apis-form-kit/errorcode-form.md | 2 +-
.../js-apis-app-form-formInfo-sys.md | 2 +-
3 files changed, 29 insertions(+), 95 deletions(-)
diff --git a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
index 673aa8bc6b0..35d2fe9c2a9 100644
--- a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
+++ b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
@@ -86,46 +86,9 @@
| designWidth | 标识页面设计基准宽度。以此为基准，根据实际设备宽度来缩放元素大小。 | 数值 | 可缺省，缺省值为720px。 |
| autoDesignWidth | 标识页面设计基准宽度是否自动计算。当配置为true时，designWidth将会被忽略，设计基准宽度由设备宽度与屏幕密度计算得出。 | 布尔值 | 可缺省，缺省值为false。 |
- 配置示例如下：
-
-
- ```json
- {
- "forms": [
- {
- "name": "widget",
- "displayName": "$string:widget_display_name",
- "description": "$string:widget_desc",
- "src": "./ets/widget/pages/WidgetCard.ets",
- "uiSyntax": "arkts",
- "window": {
- "designWidth": 720,
- "autoDesignWidth": true
- },
- "colorMode": "auto",
- "renderingMode": "fullColor",
- "isDefault": true,
- "updateEnabled": true,
- "scheduledUpdateTime": "10:30",
- "updateDuration": 1,
- "defaultDimension": "2*2",
- "supportDimensions": [
- "2*2"
- ],
- "formConfigAbility": "ability://EntryAbility",
- "dataProxyEnabled": false,
- "isDynamic": true,
- "transparencyEnabled": false,
- "metadata": []
- }
- ]
- }
- ```
-
-
## funInteractionParams标签
-此标签标识趣味交互类型互动卡片配置。
+此标签标识趣味交互类型互动卡片配置。funInteractionParams 和 sceneAnimationParams 同时配置时识别为趣味交互类型互动卡片。
| 名称 | 类型 | 必填 | 说明 |
|--------|-----|----|------------------------------------------------------|
@@ -141,30 +104,7 @@
{
"forms": [
{
- "name": "widget",
- "displayName": "$string:widget_display_name",
- "description": "$string:widget_desc",
- "src": "./ets/widget/pages/WidgetCard.ets",
- "uiSyntax": "arkts",
- "window": {
- "designWidth": 720,
- "autoDesignWidth": true
- },
- "colorMode": "auto",
- "renderingMode": "fullColor",
- "isDefault": true,
- "updateEnabled": true,
- "scheduledUpdateTime": "10:30",
- "updateDuration": 1,
- "defaultDimension": "2*2",
- "supportDimensions": [
- "2*2"
- ],
- "formConfigAbility": "ability://EntryAbility",
- "dataProxyEnabled": false,
- "isDynamic": true,
- "transparencyEnabled": false,
- "metadata": [],
+ // ...
"funInteractionParams": {
"targetBundleName": "com.example.funInteraction"
}
@@ -176,7 +116,7 @@
## sceneAnimationParams标签
-此标签标识场景动效类型互动卡片配置。
+此标签标识场景动效类型互动卡片配置。funInteractionParams 和 sceneAnimationParams 同时配置时识别为趣味交互类型互动卡片。
| 名称 | 类型 | 必填 | 说明 |
|----------------------------------------|--------|----|----------------------------|
@@ -188,30 +128,7 @@
{
"forms": [
{
- "name": "widget",
- "displayName": "$string:widget_display_name",
- "description": "$string:widget_desc",
- "src": "./ets/widget/pages/WidgetCard.ets",
- "uiSyntax": "arkts",
- "window": {
- "designWidth": 720,
- "autoDesignWidth": true
- },
- "colorMode": "auto",
- "renderingMode": "fullColor",
- "isDefault": true,
- "updateEnabled": true,
- "scheduledUpdateTime": "10:30",
- "updateDuration": 1,
- "defaultDimension": "2*2",
- "supportDimensions": [
- "2*2"
- ],
- "formConfigAbility": "ability://EntryAbility",
- "dataProxyEnabled": false,
- "isDynamic": true,
- "transparencyEnabled": false,
- "metadata": [],
+ // ...
"sceneAnimationParams": {
"abilityName": "MyLiveFormExtensionAbility"
}
@@ -225,6 +142,26 @@
系统应用配置样例
+
+ ```json
+ {
+ "forms": [
+ {
+ // ...
+ "sceneAnimationParams": {
+ "abilityName": "MyLiveFormExtensionAbility",
+ "disabledDesktopBehaviors": "LONG_CLICK|DRAG|SWIPE_DESKTOP|PULL_DOWN_SEARCH"
+ }
+ }
+ ]
+ }
+ ```
+
+
+
+
+配置示例如下：
+
```json
{
@@ -255,13 +192,10 @@
"transparencyEnabled": false,
"metadata": [],
"sceneAnimationParams": {
- "abilityName": "MyLiveFormExtensionAbility",
- "disabledDesktopBehaviors": "LONG_CLICK|DRAG|SWIPE_DESKTOP|PULL_DOWN_SEARCH"
- }
+ "abilityName": "MyLiveFormExtensionAbility"
+ }
}
]
}
```
-
-
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md b/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md
index ba5f02b63fd..2bc168731df 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md
@@ -201,7 +201,7 @@ The form can not support this operation, please check your fom_config's sceneAni
**处理步骤**
-检查当前卡片对应[互动卡片配置](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)是否正确。
+检查当前卡片对应[互动卡片配置项sceneanimationparams](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)是否正确。
## 2293761 内部服务错误
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
index e4d95b52749..15aa5eb54fd 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
@@ -160,7 +160,7 @@ import { formInfo } from '@kit.FormKit';
|-----|-----|----|----|-----|
| formId | string | 是 | 否 | 卡片id。|
| isOverflow | boolean | 是 | 否 | 动效请求类型标记，true 表示互动卡片请求触发动效，false 表示互动卡片请求取消动效。|
-| overflowInfo | [formInfo.OverflowInfo](js-apis-app-form-formInfo.md#overflowinfo20) | 是 | 是 | 动效请求参数信息，包括溢出动效时长（单位：ms）和溢出动效区域（溢出动效区域范围以卡片左上角为原点，单位为vp）默认为空。 |
+| overflowInfo | [formInfo.OverflowInfo](js-apis-app-form-formInfo.md#overflowinfo20) | 是 | 是 | 动效请求参数信息，包括溢出动效时长（单位：ms）和溢出动效区域（溢出动效区域范围以卡片左上角为原点，单位为vp），默认值为空。 |
## ChangeSceneAnimationStateRequest20+
--
Gitee
From 0729e2de6df3b0053b834545c22fec412b359fb6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=80=95=E9=BA=BB=E7=83=A6?= <354431057@qq.com>
Date: Fri, 30 May 2025 17:20:54 +0800
Subject: [PATCH 10/12] add develop doc 13
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: 怕麻烦 <354431057@qq.com>
---
.../form/arkts-ui-widget-configuration.md | 28 +++++++------------
.../js-apis-app-form-formHost-sys.md | 6 ++--
.../js-apis-app-form-formInfo-sys.md | 12 ++++----
.../js-apis-app-form-formInfo.md | 6 ++--
.../js-apis-app-form-formProvider-sys.md | 4 +--
5 files changed, 24 insertions(+), 32 deletions(-)
diff --git a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
index 35d2fe9c2a9..b18fe70c781 100644
--- a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
+++ b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
@@ -90,16 +90,15 @@
此标签标识趣味交互类型互动卡片配置。funInteractionParams 和 sceneAnimationParams 同时配置时识别为趣味交互类型互动卡片。
-| 名称 | 类型 | 必填 | 说明 |
-|--------|-----|----|------------------------------------------------------|
-| abilityName | 字符串 | 否 | 趣味交互场景 extensionAbility 名称，默认为鸿蒙小游戏引擎对应 extensionAbility。|
-| targetBundleName | 字符串 | 是 | 趣味交互场景资源 bundle 名称。|
-| subBundleName | 字符串 | 否 | 趣味交互场景资源子 bundle 名称。 |
-| keepStateDuration | 数值 | 否 | 趣味交互场景无交互时，激活态保持时长。默认值为10000，单位ms。取值为[0,10000]的整数，超过取值范围则取默认值10000。 |
+| 名称 | 类型 | 必填 | 说明 |
+|-------------------|-----|----|---------------------------------------------------------------------|
+| abilityName | 字符串 | 否 | 趣味交互场景 extensionAbility 名称，默认为空。 |
+| targetBundleName | string | 是 | 趣味交互场景主包包名。|
+| subBundleName | string | 是 | 趣味交互场景独立分包名称。|
+| keepStateDuration | 数值 | 否 | 趣味交互场景无交互时，激活态保持时长。默认值为10000，单位ms。取值为[0,10000]的整数，超过取值范围则取默认值10000。 |
配置示例如下：
-
```json
{
"forms": [
@@ -112,7 +111,6 @@
]
}
```
-
## sceneAnimationParams标签
@@ -120,10 +118,9 @@
| 名称 | 类型 | 必填 | 说明 |
|----------------------------------------|--------|----|----------------------------|
-| abilityName | 字符串 | 是 | 场景动效 extensionAbility 名称，如卡片提供方 liveFormExtensionAbility 名称，相应业务逻辑需卡片提供方进一步开发。|
-| disabledDesktopBehaviors | 字符串数组 | 否 | 支持的取值包括SWIPE_DESKTOP（滑动桌面）、PULL_DOWN_SEARCH（下拉全搜）、LONG_CLICK（长按）、DRAG（拖动）。可以取值一个或多个，不同行为通过 \| 拼接，例如SWIPE_DESKTOP \|PULL_DOWN_SEARCH。缺省表示不禁用任何行为。 |
+| abilityName | 字符串 | 是 | 场景动效 extensionAbility 名称。|
+| disabledDesktopBehaviors | 字符串数组 | 否 | 支持的取值包括SWIPE_DESKTOP（滑动桌面）、PULL_DOWN_SEARCH（下拉全搜）、LONG_CLICK（长按）、DRAG（拖动）。可以取值一个或多个，不同行为通过 \| 拼接，例如SWIPE_DESKTOP\|PULL_DOWN_SEARCH。缺省表示不禁用任何行为。 |
-
```json
{
"forms": [
@@ -136,13 +133,10 @@
]
}
```
-
-
-
系统应用配置样例
-
+
```json
{
"forms": [
@@ -156,9 +150,7 @@
]
}
```
-
-
-
+
配置示例如下：
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md
index 6a06851c0fe..456addbd975 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md
@@ -2902,7 +2902,7 @@ on(type: 'formOverflow', callback: Callback<formInfo.OverflowRequest>): vo
| 参数名 | 类型 | 必填 | 说明 |
|----------|--------|---|---------------------------------------|
| type | string | 是 | 事件回调类型，仅支持事件'formOverflow'，表示互动卡片动效请求。|
-| callback | Callback<[formInfo.OverflowRequest](js-apis-app-form-formInfo-sys.md#overflowrequest20)> | 是 | 回调函数，用于卡片使用方对动效请求进行处理|
+| callback | Callback<[formInfo.OverflowRequest](js-apis-app-form-formInfo-sys.md#overflowrequest20)> | 是 | 回调函数，用于卡片使用方对动效请求进行处理。|
**错误码：**
@@ -2943,7 +2943,7 @@ off(type: 'formOverflow', callback?: Callback<formInfo.OverflowRequest>):
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ |----|----------------------------------------|
| type | string | 是 | 事件回调类型，仅支持事件'formOverflow'，表示互动卡片动效请求。 |
-| callback |Callback<[formInfo.OverflowRequest](js-apis-app-form-formInfo-sys.md#overflowrequest20)> | 否 | 回调函数，对应已订阅互动卡片动效请求。缺省时，表示注销所有已注册事件回调。 |
+| callback |Callback<[formInfo.OverflowRequest](js-apis-app-form-formInfo-sys.md#overflowrequest20)> | 否 | 回调函数，对应已订阅互动卡片动效请求。缺省时，表示注销所有已注册互动卡片动效请求事件回调。 |
**错误码：**
@@ -3025,7 +3025,7 @@ off(type: 'changeSceneAnimationState', callback: Callback<formInfo.changeScen
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ |----| ------- |
| type | string | 是 | 事件回调类型，支持的事件为'changeSceneAnimationState'，表示互动卡片状态切换。|
-| callback |Callback<[formInfo.ChangeSceneAnimationStateRequest](js-apis-app-form-formInfo-sys.md#changesceneanimationstaterequest20)> | 否 | 回调函数，对应已订阅互动卡片状态切换请求。缺省时，表示注销所有已注册事件回调。|
+| callback |Callback<[formInfo.ChangeSceneAnimationStateRequest](js-apis-app-form-formInfo-sys.md#changesceneanimationstaterequest20)> | 否 | 回调函数，对应已订阅互动卡片状态切换请求。缺省时，表示注销所有已注册互动卡片状态切换事件回调。|
**错误码：**
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
index 15aa5eb54fd..d3c728660d1 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
@@ -164,7 +164,7 @@ import { formInfo } from '@kit.FormKit';
## ChangeSceneAnimationStateRequest20+
-互动卡片状态切换请求信息。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 [LiveFormExtensionAbility](js-apis-app-form-LiveFormExtensionAbility.md) 进程，加载应用自定义页面。
+互动卡片状态切换请求信息。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 [LiveFormExtensionAbility](js-apis-app-form-LiveFormExtensionAbility.md) 进程，实现互动卡片动效。
**系统能力：** SystemCapability.Ability.Form
@@ -183,11 +183,11 @@ import { formInfo } from '@kit.FormKit';
**系统接口：** 此接口为系统接口。
-| 名称 | 类型 | 只读 | 可选 | 说明 |
-|-----|-----|----|-----|-----------------------------------------------------------------------------------------|
-| abilityName | string | 是 | 是 | 趣味交互场景 extensionAbility 名称，默认为鸿蒙快游戏引擎对应 ability |
-| targetBundleName | string | 是 | 否 | 趣味交互场景 RPK 资源 bundle 名称。 |
-| subBundleName | string | 是 | 否 | 趣味交互场景 RPK 资源子 bundle 名称。 |
+| 名称 | 类型 | 只读 | 可选 | 说明 |
+|-----|-----|----|-----|---------------------------------------------------------------------|
+| abilityName | string | 是 | 是 | 趣味交互场景 extensionAbility 名称，默认为空 |
+| targetBundleName | string | 是 | 否 | 趣味交互场景主包包名。 |
+| subBundleName | string | 是 | 否 | 趣味交互场景独立分包名称。 |
| keepStateDuration | number | 是 | 是 | 趣味交互场景无交互时，激活态保持时长。默认值为10000，单位ms。取值为[0,10000]的整数，超过取值范围则取默认值10000。 |
## SceneAnimationParams20+
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md
index d96ec95d920..80aa3d13711 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md
@@ -205,12 +205,12 @@ import { formInfo } from '@kit.FormKit';
| 名称 | 类型 | 只读 | 可选 | 说明 |
|-----|-----|------|-----|----------------------------------------|
-| area | [Rect](#rectsup20sup) | 是 | 否 | 描述溢出动效区域范围, 以卡片左上角为原点, 单位为vp。 |
-| duration | number | 是 | 否 | 溢出动效持续时长。取值为大于0、小于等于3500的整数，单位ms。 |
+| area | [Rect](#rect20) | 是 | 否 | 描述溢出动效区域范围, 以卡片左上角为原点, 单位为vp。|
+| duration | number | 是 | 否 | 溢出动效持续时长。取值为大于0、小于等于3500的整数，单位ms。|
## Rect20+
-通用矩形区域信息。
+通用矩形区域信息。可用于描述卡片位置，互动卡片动效区域等信息。
**系统能力：** SystemCapability.Ability.Form
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
index 9c0a5d4e459..aa3b934c9e7 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
@@ -328,7 +328,7 @@ try {
activateSceneAnimation(formId: string): Promise<void>
-互动卡片请求状态切换到激活态，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。
+互动卡片请求状态切换到激活态，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 [LiveFormExtensionAbility](js-apis-app-form-LiveFormExtensionAbility.md) 进程，加载应用自定义页面。
**系统能力：** SystemCapability.Ability.Form
@@ -385,7 +385,7 @@ try {
deactivateSceneAnimation(formId: string): Promise<void>
-互动卡片请求切换到非激活态，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。
+互动卡片请求切换到非激活态，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 [LiveFormExtensionAbility](js-apis-app-form-LiveFormExtensionAbility.md) 进程，加载应用自定义页面。
**系统能力：** SystemCapability.Ability.Form
--
Gitee
From a30a42e635baabda95c0349052a0ebf5384c2b51 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=80=95=E9=BA=BB=E7=83=A6?= <354431057@qq.com>
Date: Fri, 30 May 2025 17:24:38 +0800
Subject: [PATCH 11/12] add develop doc 15
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: 怕麻烦 <354431057@qq.com>
---
.../reference/apis-form-kit/js-apis-app-form-formHost-sys.md | 4 ++--
.../reference/apis-form-kit/js-apis-app-form-formInfo-sys.md | 4 ++--
.../apis-form-kit/js-apis-app-form-formProvider-sys.md | 4 ++--
3 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md
index 456addbd975..2d43ac586f8 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md
@@ -2973,7 +2973,7 @@ try {
on(type: 'changeSceneAnimationState', callback: Callback<formInfo.ChangeSceneAnimationStateRequest>): void
-订阅互动卡片状态切换请求事件。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 [LiveFormExtensionAbility](js-apis-app-form-LiveFormExtensionAbility.md) 进程，加载应用自定义页面。
+订阅互动卡片状态切换请求事件。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，加载应用自定义页面。
**系统能力：** SystemCapability.Ability.Form
@@ -3014,7 +3014,7 @@ try {
off(type: 'changeSceneAnimationState', callback: Callback<formInfo.changeSceneAnimationState>): void
-取消订阅互动卡片状态切换请求事件。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 [LiveFormExtensionAbility](js-apis-app-form-LiveFormExtensionAbility.md) 进程，加载应用自定义页面。
+取消订阅互动卡片状态切换请求事件。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，加载应用自定义页面。
**系统能力：** SystemCapability.Ability.Form
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
index d3c728660d1..5d33f1a4683 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
@@ -164,7 +164,7 @@ import { formInfo } from '@kit.FormKit';
## ChangeSceneAnimationStateRequest20+
-互动卡片状态切换请求信息。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 [LiveFormExtensionAbility](js-apis-app-form-LiveFormExtensionAbility.md) 进程，实现互动卡片动效。
+互动卡片状态切换请求信息。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，实现互动卡片动效。
**系统能力：** SystemCapability.Ability.Form
@@ -200,5 +200,5 @@ import { formInfo } from '@kit.FormKit';
| 名称 | 类型 | 只读 | 可选 | 说明 |
|-----|-----|------|----|--------------------------------------------------------------------------------------------------------------------------------------------------|
-| abilityName | string | 是 | 否 | 场景动效 extensionAbility 名称，如卡片提供方 [LiveFormExtensionAbility](js-apis-app-form-LiveFormExtensionAbility.md) 名称。 |
+| abilityName | string | 是 | 否 | 场景动效 extensionAbility 名称，如卡片提供方LiveFormExtensionAbility名称。 |
| disabledDesktopBehaviors | string | 是 | 是 | 支持的取值包括SWIPE_DESKTOP（滑动桌面）、PULL_DOWN_SEARCH（下拉全搜）、LONG_CLICK（长按）、DRAG（拖动）。可以取值一个或多个，不同行为通过 \| 拼接，例如SWIPE_DESKTOP \|PULL_DOWN_SEARCH。缺省表示不禁用任何行为。 |
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
index aa3b934c9e7..aa3ab0ecdc9 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
@@ -328,7 +328,7 @@ try {
activateSceneAnimation(formId: string): Promise<void>
-互动卡片请求状态切换到激活态，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 [LiveFormExtensionAbility](js-apis-app-form-LiveFormExtensionAbility.md) 进程，加载应用自定义页面。
+互动卡片请求状态切换到激活态，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，加载应用自定义页面。
**系统能力：** SystemCapability.Ability.Form
@@ -385,7 +385,7 @@ try {
deactivateSceneAnimation(formId: string): Promise<void>
-互动卡片请求切换到非激活态，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的 [LiveFormExtensionAbility](js-apis-app-form-LiveFormExtensionAbility.md) 进程，加载应用自定义页面。
+互动卡片请求切换到非激活态，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，加载应用自定义页面。
**系统能力：** SystemCapability.Ability.Form
--
Gitee
From c6f94b44730bf2adde7cbf44e4c2f11351288e41 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=80=95=E9=BA=BB=E7=83=A6?= <354431057@qq.com>
Date: Fri, 30 May 2025 17:55:53 +0800
Subject: [PATCH 12/12] add develop doc 16
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: 怕麻烦 <354431057@qq.com>
---
.../form/arkts-ui-widget-configuration.md | 38 ++-----------------
.../reference/apis-form-kit/errorcode-form.md | 2 +-
.../js-apis-app-form-formHost-sys.md | 4 +-
.../js-apis-app-form-formInfo-sys.md | 16 ++++----
.../js-apis-app-form-formInfo.md | 10 ++---
.../js-apis-app-form-formProvider-sys.md | 4 +-
6 files changed, 22 insertions(+), 52 deletions(-)
diff --git a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
index b18fe70c781..d5aac6594b8 100644
--- a/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
+++ b/zh-cn/application-dev/form/arkts-ui-widget-configuration.md
@@ -93,25 +93,10 @@
| 名称 | 类型 | 必填 | 说明 |
|-------------------|-----|----|---------------------------------------------------------------------|
| abilityName | 字符串 | 否 | 趣味交互场景 extensionAbility 名称，默认为空。 |
-| targetBundleName | string | 是 | 趣味交互场景主包包名。|
-| subBundleName | string | 是 | 趣味交互场景独立分包名称。|
+| targetBundleName | string | 是 | 趣味交互场景[主包包名](https://developer.huawei.com/consumer/cn/doc/quickApp-Guides/quickgame-independent-subpackage-0000002076341729)。|
+| subBundleName | string | 是 | 趣味交互场景[独立分包名](https://developer.huawei.com/consumer/cn/doc/quickApp-Guides/quickgame-independent-subpackage-0000002076341729)。|
| keepStateDuration | 数值 | 否 | 趣味交互场景无交互时，激活态保持时长。默认值为10000，单位ms。取值为[0,10000]的整数，超过取值范围则取默认值10000。 |
-配置示例如下：
-
- ```json
- {
- "forms": [
- {
- // ...
- "funInteractionParams": {
- "targetBundleName": "com.example.funInteraction"
- }
- }
- ]
- }
- ```
-
## sceneAnimationParams标签
此标签标识场景动效类型互动卡片配置。funInteractionParams 和 sceneAnimationParams 同时配置时识别为趣味交互类型互动卡片。
@@ -121,21 +106,6 @@
| abilityName | 字符串 | 是 | 场景动效 extensionAbility 名称。|
| disabledDesktopBehaviors | 字符串数组 | 否 | 支持的取值包括SWIPE_DESKTOP（滑动桌面）、PULL_DOWN_SEARCH（下拉全搜）、LONG_CLICK（长按）、DRAG（拖动）。可以取值一个或多个，不同行为通过 \| 拼接，例如SWIPE_DESKTOP\|PULL_DOWN_SEARCH。缺省表示不禁用任何行为。 |
- ```json
- {
- "forms": [
- {
- // ...
- "sceneAnimationParams": {
- "abilityName": "MyLiveFormExtensionAbility"
- }
- }
- ]
- }
- ```
-
-系统应用配置样例
-
```json
{
@@ -183,8 +153,8 @@
"isDynamic": true,
"transparencyEnabled": false,
"metadata": [],
- "sceneAnimationParams": {
- "abilityName": "MyLiveFormExtensionAbility"
+ "funInteractionParams": {
+ "targetBundleName": "com.example.funInteraction"
}
}
]
diff --git a/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md b/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md
index 2bc168731df..fdb6a38480b 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/errorcode-form.md
@@ -201,7 +201,7 @@ The form can not support this operation, please check your fom_config's sceneAni
**处理步骤**
-检查当前卡片对应[互动卡片配置项sceneanimationparams](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)是否正确。
+检查当前卡片对应[互动卡片配置项sceneAnimationParams](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)是否正确。
## 2293761 内部服务错误
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md
index 2d43ac586f8..5fdefb94e77 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formHost-sys.md
@@ -2973,7 +2973,7 @@ try {
on(type: 'changeSceneAnimationState', callback: Callback<formInfo.ChangeSceneAnimationStateRequest>): void
-订阅互动卡片状态切换请求事件。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，加载应用自定义页面。
+订阅互动卡片状态切换请求事件。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，实现互动卡片动效。
**系统能力：** SystemCapability.Ability.Form
@@ -3014,7 +3014,7 @@ try {
off(type: 'changeSceneAnimationState', callback: Callback<formInfo.changeSceneAnimationState>): void
-取消订阅互动卡片状态切换请求事件。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，加载应用自定义页面。
+取消订阅互动卡片状态切换请求事件。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，实现互动卡片动效。
**系统能力：** SystemCapability.Ability.Form
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
index 5d33f1a4683..5d600f464f5 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo-sys.md
@@ -183,11 +183,11 @@ import { formInfo } from '@kit.FormKit';
**系统接口：** 此接口为系统接口。
-| 名称 | 类型 | 只读 | 可选 | 说明 |
-|-----|-----|----|-----|---------------------------------------------------------------------|
-| abilityName | string | 是 | 是 | 趣味交互场景 extensionAbility 名称，默认为空 |
-| targetBundleName | string | 是 | 否 | 趣味交互场景主包包名。 |
-| subBundleName | string | 是 | 否 | 趣味交互场景独立分包名称。 |
+| 名称 | 类型 | 只读 | 可选 | 说明 |
+|-----|-----|----|-----|--------------------------------------------------------------------------------------------------------------------------------------|
+| abilityName | string | 是 | 是 | 趣味交互场景 extensionAbility 名称，默认为空。 |
+| targetBundleName | string | 是 | 否 | 趣味交互场景[主包包名](https://developer.huawei.com/consumer/cn/doc/quickApp-Guides/quickgame-independent-subpackage-0000002076341729)。 |
+| subBundleName | string | 是 | 否 | 趣味交互场景趣味交互场景[独立分包名](https://developer.huawei.com/consumer/cn/doc/quickApp-Guides/quickgame-independent-subpackage-0000002076341729)。 |
| keepStateDuration | number | 是 | 是 | 趣味交互场景无交互时，激活态保持时长。默认值为10000，单位ms。取值为[0,10000]的整数，超过取值范围则取默认值10000。 |
## SceneAnimationParams20+
@@ -198,7 +198,7 @@ import { formInfo } from '@kit.FormKit';
**系统接口：** 此接口为系统接口。
-| 名称 | 类型 | 只读 | 可选 | 说明 |
-|-----|-----|------|----|--------------------------------------------------------------------------------------------------------------------------------------------------|
+| 名称 | 类型 | 只读 | 可选 | 说明 |
+|-----|-----|------|----|-------------------------------------------------------------------------------------------------------------------------------------------------|
| abilityName | string | 是 | 否 | 场景动效 extensionAbility 名称，如卡片提供方LiveFormExtensionAbility名称。 |
-| disabledDesktopBehaviors | string | 是 | 是 | 支持的取值包括SWIPE_DESKTOP（滑动桌面）、PULL_DOWN_SEARCH（下拉全搜）、LONG_CLICK（长按）、DRAG（拖动）。可以取值一个或多个，不同行为通过 \| 拼接，例如SWIPE_DESKTOP \|PULL_DOWN_SEARCH。缺省表示不禁用任何行为。 |
\ No newline at end of file
+| disabledDesktopBehaviors | string | 是 | 是 | 支持的取值包括SWIPE_DESKTOP（滑动桌面）、PULL_DOWN_SEARCH（下拉全搜）、LONG_CLICK（长按）、DRAG（拖动）。可以取值一个或多个，不同行为通过 \| 拼接，例如SWIPE_DESKTOP\|PULL_DOWN_SEARCH。缺省表示不禁用任何行为。 |
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md
index 80aa3d13711..3cde8632016 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formInfo.md
@@ -203,14 +203,14 @@ import { formInfo } from '@kit.FormKit';
**系统能力：** SystemCapability.Ability.Form
-| 名称 | 类型 | 只读 | 可选 | 说明 |
-|-----|-----|------|-----|----------------------------------------|
-| area | [Rect](#rect20) | 是 | 否 | 描述溢出动效区域范围, 以卡片左上角为原点, 单位为vp。|
-| duration | number | 是 | 否 | 溢出动效持续时长。取值为大于0、小于等于3500的整数，单位ms。|
+| 名称 | 类型 | 只读 | 可选 | 说明 |
+|-----|-----|------|-----|-----------------------------------|
+| area | [Rect](#rect20) | 是 | 否 | 描述溢出动效区域范围，以卡片左上角为原点，单位为vp。 |
+| duration | number | 是 | 否 | 溢出动效持续时长。取值为大于0、小于等于3500的整数，单位ms。 |
## Rect20+
-通用矩形区域信息。可用于描述卡片位置，互动卡片动效区域等信息。
+通用矩形区域信息。可用于描述卡片位置、互动卡片动效区域等信息。
**系统能力：** SystemCapability.Ability.Form
diff --git a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
index aa3ab0ecdc9..e08ae9c9b5c 100644
--- a/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
+++ b/zh-cn/application-dev/reference/apis-form-kit/js-apis-app-form-formProvider-sys.md
@@ -328,7 +328,7 @@ try {
activateSceneAnimation(formId: string): Promise<void>
-互动卡片请求状态切换到激活态，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，加载应用自定义页面。
+互动卡片请求状态切换到激活态，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，实现互动卡片动效。
**系统能力：** SystemCapability.Ability.Form
@@ -385,7 +385,7 @@ try {
deactivateSceneAnimation(formId: string): Promise<void>
-互动卡片请求切换到非激活态，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，加载应用自定义页面。
+互动卡片请求切换到非激活态，只针对[场景动效类型互动卡片](../../form/arkts-ui-widget-configuration.md#sceneanimationparams标签)生效，使用Promise异步回调。互动卡片状态分为激活态和非激活态，非激活态下，互动卡片同普通卡片一致；激活态下，互动卡片支持拉起卡片提供方所开发的LiveFormExtensionAbility进程，实现互动卡片动效。
**系统能力：** SystemCapability.Ability.Form
--
Gitee