配置卡片的配置文件

2024-01-25 12:18 更新

卡片相關(guān)的配置文件主要包含F(xiàn)ormExtensionAbility的配置和卡片的配置兩部分:

  1. 卡片需要在module.json5配置文件中的extensionAbilities標(biāo)簽下,配置FormExtensionAbility相關(guān)信息。FormExtensionAbility需要填寫(xiě)metadata元信息標(biāo)簽,其中鍵名稱(chēng)為固定字符串“ohos.extension.form”,資源為卡片的具體配置信息的索引。

    配置示例如下:

    1. {
    2. "module": {
    3. ...
    4. "extensionAbilities": [
    5. {
    6. "name": "EntryFormAbility",
    7. "srcEntrance": "./ets/entryformability/EntryFormAbility.ts",
    8. "label": "$string:EntryFormAbility_label",
    9. "description": "$string:EntryFormAbility_desc",
    10. "type": "form",
    11. "metadata": [
    12. {
    13. "name": "ohos.extension.form",
    14. "resource": "$profile:form_config"
    15. }
    16. ]
    17. }
    18. ]
    19. }
    20. }
  2. 卡片的具體配置信息。在上述FormExtensionAbility的元信息(“metadata”配置項(xiàng))中,可以指定卡片具體配置信息的資源索引。例如當(dāng)resource指定為$profile:form_config時(shí),會(huì)使用開(kāi)發(fā)視圖的resources/base/profile/目錄下的form_config.json作為卡片profile配置文件。內(nèi)部字段結(jié)構(gòu)說(shuō)明如下表所示。

    表1 卡片form_config.json配置文件

    屬性名稱(chēng)

    含義

    數(shù)據(jù)類(lèi)型

    是否可缺省

    name

    表示卡片的類(lèi)名,字符串最大長(zhǎng)度為127字節(jié)。

    字符串

    description

    表示卡片的描述。取值可以是描述性?xún)?nèi)容,也可以是對(duì)描述性?xún)?nèi)容的資源索引,以支持多語(yǔ)言。字符串最大長(zhǎng)度為255字節(jié)。

    該屬性將顯示在卡片預(yù)覽界面上,以便用戶(hù)識(shí)別不同卡片。

    字符串

    可缺省,缺省為空。

    src

    表示卡片對(duì)應(yīng)的UI代碼的完整路徑。當(dāng)為ArkTS卡片時(shí),完整路徑需要包含卡片文件的后綴,如:"./ets/widget/pages/WidgetCard.ets"。當(dāng)為JS卡片時(shí),完整路徑無(wú)需包含卡片文件的后綴,如:"./js/widget/pages/WidgetCard"

    字符串

    uiSyntax

    表示該卡片的類(lèi)型,當(dāng)前支持如下兩種類(lèi)型:

    - arkts:當(dāng)前卡片為ArkTS卡片。

    - hml:當(dāng)前卡片為JS卡片。

    字符串

    可缺省,缺省值為hml

    window

    用于定義與顯示窗口相關(guān)的配置。

    對(duì)象

    可缺省

    isDefault

    表示該卡片是否為默認(rèn)卡片,每個(gè)UIAbility有且只有一個(gè)默認(rèn)卡片。

    - true:默認(rèn)卡片。

    - false:非默認(rèn)卡片。

    布爾值

    colorMode

    表示卡片的主題樣式,取值范圍如下:

    - auto:自適應(yīng)。

    - dark:深色主題。

    - light:淺色主題。

    字符串

    可缺省,缺省值為“auto”。

    supportDimensions

    表示卡片支持的外觀規(guī)格,取值范圍:

    - 1 * 2:表示1行2列的二宮格。

    - 2 * 2:表示2行2列的四宮格。

    - 2 * 4:表示2行4列的八宮格。

    - 4 * 4:表示4行4列的十六宮格。

    字符串?dāng)?shù)組

    defaultDimension

    表示卡片的默認(rèn)外觀規(guī)格,取值必須在該卡片supportDimensions配置的列表中。

    字符串

    updateEnabled

    表示卡片是否支持周期性刷新(包含定時(shí)刷新和定點(diǎn)刷新),取值范圍:

    - true:表示支持周期性刷新,可以在定時(shí)刷新(updateDuration)和定點(diǎn)刷新(scheduledUpdateTime)兩種方式任選其一,當(dāng)兩者同時(shí)配置時(shí),定時(shí)刷新優(yōu)先生效。

    - false:表示不支持周期性刷新。

    布爾類(lèi)型

    scheduledUpdateTime

    表示卡片的定點(diǎn)刷新的時(shí)刻,采用24小時(shí)制,精確到分鐘。

    說(shuō)明:

    > updateDuration參數(shù)優(yōu)先級(jí)高于scheduledUpdateTime,兩者同時(shí)配置時(shí),以u(píng)pdateDuration配置的刷新時(shí)間為準(zhǔn)。

    字符串

    可缺省,缺省時(shí)不進(jìn)行定點(diǎn)刷新。

    updateDuration

    表示卡片定時(shí)刷新的更新周期,單位為30分鐘,取值為自然數(shù)。

    當(dāng)取值為0時(shí),表示該參數(shù)不生效。

    當(dāng)取值為正整數(shù)N時(shí),表示刷新周期為30*N分鐘。

    說(shuō)明:

    > updateDuration參數(shù)優(yōu)先級(jí)高于scheduledUpdateTime,兩者同時(shí)配置時(shí),以u(píng)pdateDuration配置的刷新時(shí)間為準(zhǔn)。

    數(shù)值

    可缺省,缺省值為“0”。

    formConfigAbility

    表示卡片的配置跳轉(zhuǎn)鏈接,采用URI格式。

    字符串

    可缺省,缺省值為空。

    formVisibleNotify

    標(biāo)識(shí)是否允許卡片使用卡片可見(jiàn)性通知。

    字符串

    可缺省,缺省值為空。

    metadata

    表示卡片的自定義信息,包含customizeData數(shù)組標(biāo)簽。

    對(duì)象

    可缺省,缺省值為空。

    配置示例如下:

    1. {
    2. "forms": [
    3. {
    4. "name": "widget",
    5. "description": "This is a service widget.",
    6. "src": "./ets/widget/pages/WidgetCard.ets",
    7. "uiSyntax": "arkts",
    8. "window": {
    9. "designWidth": 720,
    10. "autoDesignWidth": true
    11. },
    12. "colorMode": "auto",
    13. "isDefault": true,
    14. "updateEnabled": true,
    15. "scheduledUpdateTime": "10:30",
    16. "updateDuration": 1,
    17. "defaultDimension": "2*2",
    18. "supportDimensions": [
    19. "2*2"
    20. ]
    21. }
    22. ]
    23. }
以上內(nèi)容是否對(duì)您有幫助:
在線(xiàn)筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)