FormComponent (系统接口)

提供卡片组件，实现卡片的显示功能。

说明：

• 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

• 该组件为卡片组件的使用方，对应提供方的使用参考文档JS服务卡片UI组件。

• 该组件使用需要具有系统签名。

• 本模块为系统接口。

权限

ohos.permission.REQUIRE_FORM, ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

子组件

无

接口

FormComponent (value: FormInfo)

创建卡片组件，用于显示提供的卡片。

参数：

FormInfo¹²⁺

卡片信息。

FormCallbackInfo¹²⁺

卡片查询或者卸载时获取formId的参数。

FormSize¹⁸⁺

卡片大小信息。

ErrorInformation¹⁸⁺

卡片错误信息。

FormDimension

FormRenderingMode¹¹⁺

属性

size¹⁸⁺

size(formSize: FormSize)

设置高宽尺寸。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

moduleName

moduleName(value: string)

设置卡片模块名称。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

dimension

dimension(value: FormDimension)

设置卡片尺寸，支持2 * 2，4 * 4，2 * 4等类型卡片。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

allowUpdate

allowUpdate(value: boolean)

设置是否允许卡片更新。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

visibility

visibility(value: Visibility)

设置是否允许卡片可见。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

事件

onAcquired

onAcquired(callback:&nbsp;Callback<FormCallbackInfo>)&nbsp;

获取到卡片后触发的回调。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

onError¹⁸⁺

onError(callback: Callback<ErrorInformation>)

卡片加载错误触发的回调。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

onRouter¹⁸⁺

onRouter(callback: Callback<object>)

卡片点击回调。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

|参数名|类型|必填|说明 | |——|-|—-|————————————————————| |callback|Callback<object>|是 |获得routerEvent对象。|

onUninstall

onUninstall(callback:&nbsp;Callback<FormCallbackInfo>)&nbsp;

卡片卸载回调。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

onLoad¹⁸⁺

onLoad(callback: VoidCallback)

卡片加载回调。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

onUpdate¹⁸⁺

onUpdate(callback:&nbsp;Callback<FormCallbackInfo>)&nbsp;

卡片内容更新回调。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

示例

卡片示例。

该示例创建一张2 * 2尺寸大小的卡片，并注册事件回调。

//card.ets
@Entry
@Component
struct CardExample {
  @State formId:string = '0';
  build() {
    Column() {
      Text('this is a card')
        .fontSize(50)
        .fontWeight(FontWeight.Bold)
      FormComponent({
        id:this.formId,
        name:"Form1",
        bundle:"com.example.cardexample",
        ability:"FormAbility",
        module:"entry",
        dimension:FormDimension.Dimension_2_2,
        temporary:false
      })
        .allowUpdate(true)
        .size({width:360,height:360})
        .visibility(Visibility.Visible)
        .onAcquired((form: FormCallbackInfo)=>{
          console.log(`form info : ${JSON.stringify(form)}`);
          // Invalid form id
          if (form.id == -1) {
            this.formId = form.idString;
          } else {
            this.formId = form.id.toString();
          }
        })
        .onError((err)=>{
          console.log(`fail to add form, err: ${JSON.stringify(err)}`);
        })
        .onUninstall((form: FormCallbackInfo)=>{
          console.log(`uninstall form success : ${JSON.stringify(form)}`);
          // Invalid form id
          if (form.id == -1) {
            this.formId = form.idString;
          } else {
            this.formId = form.id.toString();
          }
        })
        .onUpdate((form: FormCallbackInfo)=>{
          console.log(`form update done : ${JSON.stringify(form)}`);
        })
    }
    .width('100%')
    .height('100%')
  }
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙图像AI分析错误码

harmony 鸿蒙ArcButton

harmony 鸿蒙ArcSlider

harmony 鸿蒙Chip

harmony 鸿蒙ChipGroup

harmony 鸿蒙ComposeListItem

harmony 鸿蒙ComposeTitleBar

harmony 鸿蒙advanced.Counter

harmony 鸿蒙弹出框 (Dialog)

harmony 鸿蒙DialogV2