1# 配置卡片的配置文件 2 3 4卡片相关的配置文件主要包含FormExtensionAbility的配置和卡片的配置两部分。 5 6 71. 卡片需要在[module.json5配置文件](../quick-start/module-configuration-file.md)中的extensionAbilities标签下,配置FormExtensionAbility相关信息。FormExtensionAbility需要填写metadata元信息标签,其中键名称为固定字符串“ohos.extension.form”,资源为卡片的具体配置信息的索引。 8 9 配置示例如下: 10 11 12 ```json 13 { 14 "module": { 15 // ... 16 "extensionAbilities": [ 17 { 18 "name": "EntryFormAbility", 19 "srcEntry": "./ets/entryformability/EntryFormAbility.ets", 20 "label": "$string:EntryFormAbility_label", 21 "description": "$string:EntryFormAbility_desc", 22 "type": "form", 23 "metadata": [ 24 { 25 "name": "ohos.extension.form", 26 "resource": "$profile:form_config" 27 } 28 ] 29 } 30 ] 31 } 32 } 33 ``` 34 352. 卡片的具体配置信息。在上述FormExtensionAbility的元信息(“metadata”配置项)中,可以指定卡片具体配置信息的资源索引。例如当resource指定为$profile:form_config时,会使用开发视图的resources/base/profile/目录下的form_config.json作为卡片profile配置文件。内部字段结构说明如下表所示。 36 37 **表1** 卡片form_config.json配置文件 38 39 | 属性名称 | 含义 | 数据类型 | 是否可缺省 | 40 | -------- | -------- | -------- | -------- | 41 | name | 表示卡片的名称,字符串最大长度为127字节。 | 字符串 | 否 | 42 | displayName | 表示卡片的显示名称。取值可以是名称内容,也可以是对名称内容的资源索引,以支持多语言。字符串最小长度为1字节,最大长度为30字节。 | 字符串 | 否 | 43 | description | 表示卡片的描述。取值可以是描述性内容,也可以是对描述性内容的资源索引,以支持多语言。字符串最大长度为255字节。 | 字符串 | 可缺省,缺省为空。 | 44 | src | 表示卡片对应的UI代码的完整路径。当为ArkTS卡片时,完整路径需要包含卡片文件的后缀,如:"./ets/widget/pages/WidgetCard.ets"。当为JS卡片时,完整路径无需包含卡片文件的后缀,如:"./js/widget/pages/WidgetCard" | 字符串 | 否 | 45 | uiSyntax | 表示该卡片的类型,当前支持如下两种类型:<br/>- arkts:当前卡片为ArkTS卡片。<br/>- hml:当前卡片为JS卡片。 | 字符串 | 可缺省,缺省值为“hml”。 | 46 | [window](#window标签) | 用于定义与显示窗口相关的配置。 | 对象 | 可缺省,缺省值见表2。 | 47 | isDefault | 表示该卡片是否为默认卡片,每个UIAbility有且只有一个默认卡片。<br/>- true:默认卡片。<br/>- false:非默认卡片。 | 布尔值 | 否 | 48 | colorMode | 表示卡片的主题样式,取值范围如下:<br/>- auto:跟随系统的颜色模式值选取主题。<br/>- dark:深色主题。<br/>- light:浅色主题。 | 字符串 | 可缺省,缺省值为“auto”。 | 49 | supportDimensions | 表示卡片支持的外观规格,取值范围:<br/>- 1 \* 2:表示1行2列的二宫格。<br/>- 2 \* 2:表示2行2列的四宫格。<br/>- 2 \* 4:表示2行4列的八宫格。<br/>- 4 \* 4:表示4行4列的十六宫格。<br/>- 1 \* 1:表示1行1列的圆形卡片。<br/>- 6 \* 4:表示6行4列的二十四宫格。 | 字符串数组 | 否 | 50 | defaultDimension | 表示卡片的默认外观规格,取值必须在该卡片supportDimensions配置的列表中。 | 字符串 | 否 | 51 | updateEnabled | 表示卡片是否支持周期性刷新(包含定时刷新和定点刷新),取值范围:<br/>- true:表示支持周期性刷新,可以在定时刷新(updateDuration)和定点刷新(scheduledUpdateTime)两种方式任选其一,当两者同时配置时,定时刷新优先生效。<br/>- false:表示不支持周期性刷新。 | 布尔类型 | 否 | 52 | scheduledUpdateTime | 表示卡片的定点刷新的时刻,采用24小时制,精确到分钟。<br/>**说明:**<br/>updateDuration参数优先级高于scheduledUpdateTime,两者同时配置时,以updateDuration配置的刷新时间为准。 | 字符串 | 可缺省,缺省时不进行定点刷新。 | 53 | updateDuration | 表示卡片定时刷新的更新周期,单位为30分钟,取值为自然数。<br/>当取值为0时,表示该参数不生效。<br/>当取值为正整数N时,表示刷新周期为30\*N分钟。<br/>**说明:**<br/>updateDuration参数优先级高于scheduledUpdateTime,两者同时配置时,以updateDuration配置的刷新时间为准。 | 数值 | 可缺省,缺省值为“0”。 | 54 | formConfigAbility | 表示卡片的配置跳转链接,采用URI格式。| 字符串 | 可缺省,缺省值为空。 | 55 | metadata | 表示卡片的自定义信息,参考[Metadata](../reference/apis-ability-kit/js-apis-bundleManager-metadata.md)数组标签。 | 对象 | 可缺省,缺省值为空。 | 56 | dataProxyEnabled | 表示卡片是否支持卡片代理刷新,取值范围:<br/>- true:表示支持代理刷新。<br/>- false:表示不支持代理刷新。<br/>设置为true时,[定时刷新和下次刷新不生效,但不影响定点刷新](./arkts-ui-widget-update-by-time.md)。 | 布尔类型 | 可缺省,缺省值为false。 | 57 | [isDynamic](#isdynamic标签) | 表示此卡片是否为动态卡片(仅针对ArkTS卡片生效)。 <br/>- true:为动态卡片 。<br/>- false:为静态卡片。<br/>| 布尔类型 | 可缺省,缺省值为true。 | 58 | fontScaleFollowSystem | 表示卡片使用方设置此卡片的字体是否支持跟随系统变化。 <br/>- true:支持跟随系统字体大小变化 。<br/>- false:不支持跟随系统字体大小变化。<br/>| 布尔类型 | 可缺省,缺省值为true。 | 59 | supportShapes | 表示卡片的显示形状,取值范围如下:<br/>- rect:表示方形卡片。<br/>- circle:表示圆形卡片。| 字符串 | 可缺省,缺省值为“rect”。 | 60 | <!--DelRow-->formVisibleNotify | 表示是否允许卡片使用卡片可见性通知(仅对系统应用的卡片生效)。 | 布尔类型 | 可缺省,缺省值为false。 | 61 | <!--DelRow-->transparencyEnabled | 表示是否支持卡片使用方设置此卡片的背景透明度(仅对系统应用的ArkTS卡片生效。)。 <br/>- true:支持设置背景透明度 。<br/>- false:不支持设置背景透明度。<br/>| 布尔类型 | 可缺省,缺省值为false。 | 62 63## isDynamic标签 64 65此标签标识卡片是否为动态卡片(仅针对ArkTS卡片生效)。 66 67| 卡片类型 | 支持的能力 | 适用场景 | 优缺点 | 68| ------- | ------ | ------- | ------- | 69| 静态卡片 | 仅支持UI组件和布局能力。| 主要用于展示静态信息(UI相对固定),仅可以通过FormLink组件跳转到指定的UIAbility。| 功能简单但可以有效控制内存开销。| 70| 动态卡片 | 除了支持UI组件和布局能力,还支持通用事件能力和自定义动效能力。 | 用于有复杂业务逻辑和交互的场景。例如:卡片页面图片的刷新、卡片内容的刷新等。| 功能丰富但内存开销较大。| 71 72## window标签 73 74此标签标识window对象的内部结构说明。 75 76 | 属性名称 | 含义 | 数据类型 | 是否可缺省 | 77 | -------- | -------- | -------- | -------- | 78 | designWidth | 标识页面设计基准宽度。以此为基准,根据实际设备宽度来缩放元素大小。 | 数值 | 可缺省,缺省值为720px。 | 79 | autoDesignWidth | 标识页面设计基准宽度是否自动计算。当配置为true时,designWidth将会被忽略,设计基准宽度由设备宽度与屏幕密度计算得出。 | 布尔值 | 可缺省,缺省值为false。 | 80 81 配置示例如下: 82 83 84 ```json 85 { 86 "forms": [ 87 { 88 "name": "widget", 89 "displayName": "$string:widget_display_name", 90 "description": "$string:widget_desc", 91 "src": "./ets/widget/pages/WidgetCard.ets", 92 "uiSyntax": "arkts", 93 "window": { 94 "designWidth": 720, 95 "autoDesignWidth": true 96 }, 97 "colorMode": "auto", 98 "isDefault": true, 99 "updateEnabled": true, 100 "scheduledUpdateTime": "10:30", 101 "updateDuration": 1, 102 "defaultDimension": "2*2", 103 "supportDimensions": [ 104 "2*2" 105 ], 106 "formConfigAbility": "ability://EntryAbility", 107 "dataProxyEnabled": false, 108 "isDynamic": true, 109 "transparencyEnabled": false, 110 "metadata": [] 111 } 112 ] 113 } 114 ```