目录

@ohos.data.UdmfComponents (内容卡片)

针对ContentForm标准数据结构的内容卡片,支持设置标题(必选)、描述、应用图标、应用名称、跳转链接、内容图片。用户点击卡片时,执行传入的回调事件函数,若设置的跳转链接不为空,则跳转到指定的页面。

使用场景:

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

本模块接口仅可在Stage模型下使用。

导入模块

import { ContentFormCard, FormType } from '@kit.ArkData';

子组件

无

ContentFormCard

ContentFormCard({contentFormData: uniformDataStruct.ContentForm, formType: FormType, formWidth?: number, formHeight?: number, handleOnClick?: Function})

内容卡片控件,用于在应用内展示标题、描述、内容图片、应用信息等。适用于内容分发、社交动态、消息通知等场景。

装饰器类型:@Component

系统能力: SystemCapability.DistributedDataManager.UDMF.Core

名称 类型 必填 装饰器类型 说明
contentFormData uniformDataStruct.ContentForm 是 - 内容卡片数据,用于设置卡片展示的标题、描述、应用图标、应用名称、跳转链接或内容图片等信息。
formType FormType 是 @Prop 内容卡片类型,影响内容卡片的大小。
formWidth number 否 @Prop 卡片宽度,其范围在设置的内容卡片类型默认宽度的0.8 ~ 1.2倍之间,当formType为TYPE_SMALL时,其范围在设置的内容卡片类型默认宽度的0.4 ~ 1.2倍之间。单位为vp。省略时使用内容卡片类型的默认宽度。
formHeight number 否 @Prop 卡片高度,当contentFormData中的title为空字符串时,卡片高度为传入的值,否则其范围在设置的内容卡片类型默认高度的0.8 ~ 1.2倍之间,当formType为TYPE_SMALL时,其范围在设置的内容卡片类型默认高度的0.4 ~ 1.2倍之间。单位为vp。省略时使用内容卡片类型的默认高度。
handleOnClick Function 否 - 点击事件回调函数。用户点击卡片时,会执行传入的回调函数,实现自定义点击行为。

FormType

内容卡片类型枚举,提供了大、中、小三种尺寸。

系统能力: SystemCapability.DistributedDataManager.UDMF.Core

名称 值 说明
TYPE_BIG 0 表示 4 x 4 的尺寸。默认卡片宽度为200vp,默认高度为200vp。
TYPE_MID 1 表示 4 x 2 的尺寸。默认卡片宽度为200vp,默认高度为100vp。
TYPE_SMALL 2 表示 2 x 1 的尺寸。默认卡片宽度为137vp,默认高度为83vp。

示例

// 导入所需模块
import { uniformDataStruct } from '@kit.ArkData'

@Entry
@Component
struct Index {
  // 定义内容卡片数据
  @State contentForm: uniformDataStruct.ContentForm = {
    uniformDataType: 'general.content-form',
    title: ''
  };
  // 控制卡片显示状态
  @State startToShow: boolean = false;

  // 组件即将显示时初始化数据
  aboutToAppear(): void {
    this.initData();
  }

  // 初始化内容卡片数据
  async initData() {
    // 获取应用上下文
    let context = this.getUIContext().getHostContext();
    if (!context) {
      return;
    }
    try {
      // 加载应用图标和缩略图资源
      let appIcon = await context.resourceManager.getMediaContent($r('app.media.startIcon').id);
      let thumbImage = await context.resourceManager.getMediaContent($r('app.media.foreground').id);
      // 构建内容卡片数据对象
      this.contentForm = {
        uniformDataType: 'general.content-form',
        title: 'Content form title',
        thumbData: thumbImage,
        description: 'Content form description',
        appIcon: appIcon,
        appName: 'com.test.demo'
      };
    } catch (err) {
      console.error(`Init data error`);
    }
  }

  // 构建UI界面
  build() {
    Column() {
      // 显示按钮,点击后展示内容卡片
      Button('show card')
        .onClick(() => {
          this.startToShow = true;
        })
      // 条件渲染内容卡片组件
      if (this.startToShow) {
        ContentFormCard({
          contentFormData: this.contentForm,
          formType: FormType.TYPE_SMALL,
          formWidth: 110,
          formHeight: 50,
          // 点击卡片的回调函数
          handleOnClick: () => {
            console.info(`Clicked card`);
          }
        })
      }
    }
  }
}

效果呈现

本例效果如下: