@ohos.arkui.advanced.ComposeListItem (列表)

列表包含一系列相同宽度的列表项。内容包括适合连续、多行呈现同类数据的组合,例如图片和文本。

说明:

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

导入模块

import { ComposeListItem } from "@ohos.arkui.advanced.ComposeListItem"

子组件

属性

支持通用属性

ComposeListItem

ComposeListItem({contentItem?: ContentItem, operateItem?: OperateItem})

装饰器类型:@Component

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

参数:

名称 类型 必填 装饰器类型 说明
contentItem ContentItem @Prop 定义左侧以及中间元素。
operateItem OperateItem @Prop 定义右侧元素。

ContentItem

名称 类型 必填 说明
iconStyle IconType 左侧元素的图标样式。
icon ResourceStr 左侧元素的图标资源。
primaryText ResourceStr 中间元素的标题内容,超出以"..."显示。
secondaryText ResourceStr 中间元素的副标题内容,超出以"..."显示。
description ResourceStr 中间元素的描述内容,超出以"..."显示。

IconType

名称 说明
BADGE 1 左侧图标为badge类型,图标大小为8*8dp。
NORMAL_ICON 2 左侧图标为小图标类型,图标大小为16*16dp。
SYSTEM_ICON 3 左侧图标为系统图标类型,图标大小为24*24dp。
HEAD_SCULPTURE 4 左侧图标为头像类型,图标大小为40*40dp。
APP_ICON 5 左侧图标为应用图标类型,图标大小为64*64dp。
PREVIEW 6 左侧图标为预览图类型,图标大小为96*96dp。
LONGITUDINAL 7 左侧图标为横向特殊比例(宽比高大),保持最长边为96dp。
VERTICAL 8 左侧图标为竖向特殊比例(高比宽大),保持最长边为96dp。

OperateItem

名称 类型 必填 说明
arrow OperateIcon 右侧元素为箭头,大小为12*24dp。
icon OperateIcon 右侧元素的第一个图标,大小为24*24dp。
subIcon OperateIcon 右侧元素的第二个图标,大小为24*24dp。
button OperateButton 右侧元素为按钮。
switch OperateCheck 右侧元素为开关。
checkbox OperateCheck 右侧元素为多选框,大小为24*24dp。
radio OperateCheck 右侧元素为单选,大小为24*24dp。
image ResourceStr 右侧元素为图片,大小为48*48dp。
text ResourceStr 右侧元素为文字。

OperateIcon

名称 类型 必填 说明
value ResourceStr 右侧图标/箭头资源。
action ()=>void 右侧图标/箭头点击事件。

OperateButton

名称 类型 必填 说明
text ResourceStr 右侧按钮文字。

OperateCheck

名称 类型 必填 说明
isCheck boolean 右侧Switch/CheckBox/Radio选中状态。
isCheck默认值为false。
isCheck为true时,表示为选中。
isCheck为false时,表示为未选中。
onChange (value: boolean)=>void 右侧Switch/CheckBox/Radio选中状态改变时触发回调。
value为true时,表示从未选中变为选中。
value为false时,表示从选中变为未选中。

事件

支持通用事件

示例

import { IconType, ComposeListItem } from '@ohos.arkui.advanced.ComposeListItem';
import promptAction from '@ohos.promptAction'

@Entry
@Component
struct ComposeListItemExample {
  build() {
    Column() {
      List() {
        ListItem() {
          ComposeListItem({
            contentItem: ({
              iconStyle: IconType.NORMAL_ICON,
              icon: $r('sys.media.ohos_app_icon'),
              primaryText: '双行列表',
              secondaryText: '辅助文字'
            }),
            operateItem: ({
              icon: {
                value: $r('sys.media.ohos_app_icon'),
                action: () => {
                  promptAction.showToast({ message: 'icon' })
                } },
              text: '右侧文本'
            })
          })
        }
      }
    }
  }
}

示例4-左右元素+文本