openharmony 鸿蒙 ts-basic-components-formcomponent-sys

2025-06-12 浏览 (1)

FormComponent (系统接口)

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

说明：

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

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

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

  • 本模块为系统接口。

权限

ohos.permission.REQUIRE_FORM, ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

子组件

无

接口

FormComponent (value: FormInfo)

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

参数：

参数名参数类型必填参数描述
valueFormInfo是卡片信息。

FormInfo12+

卡片信息。

参数名参数类型必填参数描述
idnumber |string是卡片标识（新建卡片填0）。
说明：
不同使用方不可使用相同id。
同一使用方使用相同id时，显示后添加的卡片。
namestring是卡片名称。
bundlestring是目标卡片包名。
abilitystring是目标卡片Ability名称。
modulestring是卡片模块名称。
dimensionFormDimension否卡片尺寸，支持2 * 2，4 * 4，2 * 4等类型卡片。
默认值：Dimension_2_2。
temporaryboolean否卡片是否为临时卡片，true表示是临时卡片，false表示不是临时卡片。
默认值：false。
renderingModeFormRenderingMode否卡片渲染模式。取值如下，默认值为 FULL_COLOR。
- FULL_COLOR：代表全色模式，卡片框架不会对卡片效果做出修改，保持和卡片开发者设置的效果不变。
- SINGLE_COLOR：代表单色模式，卡片框架会把卡片背景设为透明，开发者需按最佳实践设置卡片风格。
说明：
如果系统不支持统一渲染模式，卡片框架在单色模式下也不会把卡片背景设为透明。

FormCallbackInfo12+

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

参数名参数类型必填参数描述
idnumber是卡片标识（number类型）。
说明：
如果获取到的id为-1，说明id大于等于2^53，需要使用idString获取。
idStringstring是卡片标识（string类型）。
isLocked18+boolean是标识卡片是否为管控状态，true表示管控状态，false表示非管控状态。

FormSize18+

卡片大小信息。

参数名参数类型必填参数描述
widthnumber是卡片宽的尺寸，单位：vp。
heightnumber是卡片高的尺寸，单位：vp。

ErrorInformation18+

卡片错误信息。

参数名参数类型必填参数描述
errcodenumber是错误码。
msgstring是错误信息。

FormDimension

名称描述
Dimension_1_21*2 卡片
Dimension_2_22*2 卡片
Dimension_2_42*4 卡片
Dimension_4_44*4 卡片
Dimension_2_19+2*1 卡片
Dimension_1_111+1*1 卡片
Dimension_6_412+6*4 卡片
Dimension_2_318+2*3 卡片为穿戴设备使用
Dimension_3_318+3*3 卡片为穿戴设备使用

FormRenderingMode11+

名称描述
FULL_COLOR全色模式。
SINGLE_COLOR单色模式。

属性

size18+

size(formSize: FormSize)

设置高宽尺寸。

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

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

参数：

参数名类型必填说明
formSizeFormSize是宽高尺寸。

moduleName

moduleName(value: string)

设置卡片模块名称。

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

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

参数：

参数名类型必填说明
valuestring是卡片模块名称。

dimension

dimension(value: FormDimension)

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

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

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

参数：

参数名类型必填说明
valueFormDimension是卡片尺寸。
默认值：Dimension_2_2。

allowUpdate

allowUpdate(value: boolean)

设置是否允许卡片更新。

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

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

参数：

参数名类型必填说明
valueboolean是是否允许卡片更新，ture表示允许卡片更新，false表示不允许卡片更新。
默认值：true。

visibility

visibility(value: Visibility)

设置是否允许卡片可见。

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

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

参数：

参数名类型必填说明
valueVisibility是是否允许卡片可见。
默认值：Visible。

事件

onAcquired

onAcquired(callback: Callback<FormCallbackInfo>) 

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

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

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

参数：

参数名类型必填说明
callbackCallback<FormCallbackInfo>是回调函数，获得FormCallbackInfo对象。

onError18+

onError(callback: Callback<ErrorInformation>)

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

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

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

参数：

参数名类型必填说明
callbackCallback<ErrorInformation>是errcode: 错误码。
msg: 错误信息。

onRouter18+

onRouter(callback: Callback<object>)

卡片点击回调。

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

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

参数：

参数名类型必填说明
callbackCallback<object>是获得routerEvent对象。

onUninstall

onUninstall(callback: Callback<FormCallbackInfo>) 

卡片卸载回调。

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

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

参数：

参数名类型必填说明
callbackCallback<FormCallbackInfo>是回调函数，获得FormCallbackInfo对象。

onLoad18+

onLoad(callback: VoidCallback)

卡片加载回调。

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

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

参数：

参数名类型必填说明
callbackVoidCallback是无返回值。

onUpdate18+

onUpdate(callback: Callback<FormCallbackInfo>) 

卡片内容更新回调。

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

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

参数：

参数名类型必填说明
callbackCallback<FormCallbackInfo>是回调函数，获得FormCallbackInfo对象。

示例

卡片示例。

该示例创建一张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%')
  }
}

Form

你可能感兴趣的鸿蒙文章

harmony 鸿蒙图像AI分析错误码

harmony 鸿蒙ArcButton

harmony 鸿蒙ArcSlider

harmony 鸿蒙Chip

harmony 鸿蒙ChipGroup

harmony 鸿蒙ComposeListItem

harmony 鸿蒙ComposeTitleBar

harmony 鸿蒙advanced.Counter

harmony 鸿蒙弹出框 (Dialog)

harmony 鸿蒙DialogV2

  • 所属分类： 后端技术
  • 本文标签： 软件 鸿蒙
  • 版权声明： 本文链接 https://seaxiang.com/blog/PnZ67U