harmony 鸿蒙配置卡片的配置文件

2025-06-12
浏览 (3)

配置卡片的配置文件

卡片相关的配置文件主要包含FormExtensionAbility的配置和卡片的配置两部分。

卡片需要在module.json5配置文件中的extensionAbilities标签下，配置FormExtensionAbility相关信息。FormExtensionAbility需要填写metadata元信息标签，其中键名称为固定字符串“ohos.extension.form”，资源为卡片的具体配置信息的索引。

配置示例如下：

   {
     "module": {
       // ...
       "extensionAbilities": [
         {
           "name": "EntryFormAbility",
           "srcEntry": "./ets/entryformability/EntryFormAbility.ets",
           "label": "$string:EntryFormAbility_label",
           "description": "$string:EntryFormAbility_desc",
           "type": "form",
           "metadata": [
             {
               "name": "ohos.extension.form",
               "resource": "$profile:form_config"
             }
           ]
         }
       ]
     }
   }

卡片的具体配置信息。在上述FormExtensionAbility的元信息（“metadata”配置项）中，可以指定卡片具体配置信息的资源索引。例如当resource指定为$profile:form_config时，会使用开发视图的resources/base/profile/目录下的form_config.json作为卡片profile配置文件。在创建卡片时会自动生成form_config.json配置文件。

表1 卡片form_config.json配置文件

isDynamic标签

此标签标识卡片是否为动态卡片（仅针对ArkTS卡片生效）。

卡片类型	支持的能力	适用场景	优缺点
静态卡片	仅支持UI组件和布局能力。	主要用于展示静态信息（UI相对固定），仅可以通过FormLink组件跳转到指定的UIAbility。	功能简单但可以有效控制内存开销。
动态卡片	除了支持UI组件和布局能力，还支持通用事件能力和自定义动效能力。	用于有复杂业务逻辑和交互的场景。例如：卡片页面图片的刷新、卡片内容的刷新等。	功能丰富但内存开销较大。

window标签

此标签标识window对象的内部结构说明。

|属性名称|含义|数据类型|是否可缺省| |——–|——–|——–|——–| |designWidth|标识页面设计基准宽度。以此为基准，根据实际设备宽度来缩放元素大小。|数值|可缺省，缺省值为720px。| |autoDesignWidth|标识页面设计基准宽度是否自动计算。当配置为true时，designWidth将会被忽略，设计基准宽度由设备宽度与屏幕密度计算得出。|布尔值|可缺省，缺省值为false。|

funInteractionParams标签

此标签标识趣味交互类型互动卡片配置。funInteractionParams 和 sceneAnimationParams 同时配置时识别为趣味交互类型互动卡片。

名称	类型	必填	说明
abilityName	字符串	否	趣味交互场景LiveFormExtensionAbility名称，默认为空。
targetBundleName	字符串	是	趣味交互场景主包包名。
subBundleName	字符串	否	趣味交互场景独立分包名，默认为空。
keepStateDuration	数值	否	趣味交互场景无交互时，激活态保持时长。默认值为10000，单位ms。取值为[0,10000]的整数，超过取值范围则取默认值10000。

sceneAnimationParams标签

此标签标识场景动效类型互动卡片配置。funInteractionParams 和 sceneAnimationParams 同时配置时识别为趣味交互类型互动卡片。

名称	类型	必填	说明
abilityName	字符串	是	场景动效 extensionAbility 名称。
disabledDesktopBehaviors	字符串数组	否	支持的取值包括SWIPE_DESKTOP（滑动桌面）、PULL_DOWN_SEARCH（下拉全搜）、LONG_CLICK（长按）、DRAG（拖动）。可以取值一个或多个，不同行为通过 \|拼接，例如SWIPE_DESKTOP\|PULL_DOWN_SEARCH。缺省表示不禁用任何行为。

   {
     "forms": [
       {
          // ...
         "sceneAnimationParams": {
            "abilityName": "MyLiveFormExtensionAbility",
            "disabledDesktopBehaviors": "LONG_CLICK|DRAG|SWIPE_DESKTOP|PULL_DOWN_SEARCH"
         }          
       }
     ]
   }

配置示例如下：

   {
     "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
         },
         "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",
            "subBundleName": "com.example.subFunInteraction"
         }
       }
     ]
   }