【鸿蒙next开发】ArkUI框架：ArkTS组件-ListItem

于 2025-05-19 14:17:15 发布
阅读量499 收藏 6
点赞数 8
分类专栏： ArkUI框架 鸿蒙5.0开发 ArkTS组件 文章标签： harmonyos 华为 ArkTS ArkUI android 鸿蒙系统 前端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_73088370/article/details/148062487
版权

 往期鸿蒙5.0全套实战文章必看：（文中附带鸿蒙5.0全栈学习资料）

ListItem

用来展示列表具体item，必须配合List来使用。

说明

  • 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
  • 该组件的父组件只能是List或者ListItemGroup。
  • 当ListItem配合LazyForEach使用时，ListItem子组件在ListItem创建时创建。配合if/else、ForEach使用时，或父组件为List/ListItemGroup时，ListItem子组件在ListItem布局时创建。

子组件

可以包含单个子组件。

接口

ListItem10+

ListItem(value?: ListItemOptions)

卡片能力： 从API version 10开始，该接口支持在ArkTS卡片中使用。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

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

参数：

参数名类型必填说明
valueListItemOptions否为ListItem提供可选参数, 该对象内含有ListItemStyle枚举类型的style参数。

ListItem(deprecated)

ListItem(value?: string)

从API version 10开始, 该接口不再维护，推荐使用ListItem10+。

卡片能力： 从API version 9开始，该接口支持在ArkTS卡片中使用。

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

参数：

参数名类型必填说明
valuestring否无

属性

除支持通用属性外，还支持以下属性：

sticky(deprecated)

sticky(value: Sticky)

设置ListItem吸顶效果。

从API version9开始废弃不再使用，推荐使用List组件sticky属性。

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

参数：

参数名类型必填说明
valueSticky是

ListItem吸顶效果。

默认值：Sticky.None

editable(deprecated)

editable(value: boolean | EditMode)

设置当前ListItem元素是否可编辑，进入编辑模式后可删除或移动列表项。

从API version9开始废弃不再使用，无替代接口。

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

参数：

参数名类型必填说明
valueboolean | EditMode是

ListItem元素是否可编辑。

默认值：false

selectable8+

selectable(value: boolean)

设置当前ListItem元素是否可以被鼠标框选。外层List容器的鼠标框选开启时，ListItem的框选才生效。

卡片能力： 从API version 9开始，该接口支持在ArkTS卡片中使用。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

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

参数：

参数名类型必填说明
valueboolean是

ListItem元素是否可以被鼠标框选。

默认值：true

selected10+

selected(value: boolean)

设置当前ListItem选中状态。该属性支持$$双向绑定变量。该属性需要在设置选中态样式前使用才能生效选中态样式。

卡片能力： 从API version 10开始，该接口支持在ArkTS卡片中使用。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

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

参数：

参数名类型必填说明
valueboolean是

当前ListItem选中状态。

默认值：false

swipeAction9+

swipeAction(value: SwipeActionOptions)

用于设置ListItem的划出组件。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

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

参数：

参数名类型必填说明
valueSwipeActionOptions是ListItem的划出组件。

Sticky(deprecated)枚举说明

从API version9开始废弃不再使用，推荐使用List组件stickyStyle枚举。

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

名称枚举值描述
None0无吸顶效果。
Normal1当前item吸顶。
Opacity2当前item吸顶显示透明度变化效果。

EditMode(deprecated)枚举说明

从API version9开始废弃不再使用，无替代接口。

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

名称枚举值描述
None0编辑操作不限制。
Deletable1可删除。
Movable2可移动。

SwipeEdgeEffect9+枚举说明

元服务API： 从API version 11开始，该接口支持在元服务中使用。

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

名称枚举值描述
Spring0

ListItem划动距离超过划出组件大小后可以继续划动。

如果设置了删除区域，ListItem划动距离超过删除阈值后可以继续划动，

松手后按照弹簧阻尼曲线回弹。

None1

ListItem划动距离不能超过划出组件大小。

如果设置了删除区域，ListItem划动距离不能超过删除阈值，

并且在设置删除回调的情况下，达到删除阈值后松手触发删除回调。

SwipeActionOptions9+对象说明

start和end对应的@builder函数中顶层必须是单个组件，不能是if/else、ForEach、LazyForEach语句。

滑动手势只在listItem区域上，如果子组件划出ListItem区域外，在ListItem以外部分不会响应划动手势。所以在多列模式下，建议不要将划出组件设置太宽。

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

名称类型必填说明
startCustomBuilder | SwipeActionItem否

ListItem向右划动时item左边的组件（List垂直布局时）或ListItem向下划动时item上方的组件（List水平布局时）。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

endCustomBuilder | SwipeActionItem否

ListItem向左划动时item右边的组件（List垂直布局时）或ListItem向上划动时item下方的组件（List水平布局时）。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

edgeEffectSwipeEdgeEffect否

滑动效果。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

onOffsetChange11+(offset: number) => void否

滑动操作偏移量更改时调用。

说明：

当列表项向左或向右滑动（当列表方向为“垂直”时），向上或向下滑动（当列方向为“水平”时）位置发生变化触发，以vp为单位。

元服务API： 从API version 12开始，该接口支持在元服务中使用。

SwipeActionItem10+对象说明

List垂直布局，ListItem向右滑动，item左边的长距离滑动删除选项或向左滑动时，item右边的长距离滑动删除选项。

List水平布局，ListItem向上滑动，item下边的长距离滑动删除选项或向下滑动时，item上边的长距离滑动删除选项。

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

名称类型必填说明
actionAreaDistanceLength否

设置组件长距离滑动删除距离阈值。

默认值：56vp

说明：

不支持设置百分比。

删除距离阈值大于item宽度减去划出组件宽度，或删除距离阈值小于等于0就不会设置删除区域。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

onAction() => void否

组件进入长距删除区后删除ListItem时调用，进入长距删除区后抬手时触发。

说明：

滑动后松手的位置超过或等于设置的距离阈值，并且设置的距离阈值有效时才会触发。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

onEnterActionArea() => void否

在滑动条目进入删除区域时调用，只触发一次，当再次进入时仍触发。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

onExitActionArea() => void否

当滑动条目退出删除区域时调用，只触发一次，当再次退出时仍触发。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

builderCustomBuilder否

当列表项向左或向右滑动（当列表方向为“垂直”时），向上或向下滑动（当列方向为“水平”时）时显示的操作项。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

onStateChange11+(state:SwipeActionState) => void否

当列表项滑动状态变化时候触发。

元服务API： 从API version 12开始，该接口支持在元服务中使用。

ListItemOptions10+对象说明

元服务API： 从API version 11开始，该接口支持在元服务中使用。

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

名称类型必填说明
styleListItemStyle否

设置List组件卡片样式。

默认值: ListItemStyle.NONE

设置为ListItemStyle.NONE时无样式。

设置为ListItemStyle.CARD时，建议配合ListItemGroup的ListItemGroupStyle.CARD同时使用，显示默认卡片样式。

卡片样式下，ListItem默认规格：高度48vp，宽度100%，左右内边距8vp。如果需要实现ListItem高度自适应，可以把height设置为undefined。

卡片样式下, 为卡片内的列表选项提供了默认的focus、hover、press、selected和disable样式。

说明：

当前卡片模式下，使用默认Axis.Vertical排列方向，如果listDirection属性设置为Axis.Horizontal，会导致显示混乱；List属性alignListItem默认为ListItemAlign.Center，居中对齐显示。

ListItemStyle10+枚举说明

元服务API： 从API version 11开始，该接口支持在元服务中使用。

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

名称枚举值描述
NONE0无样式。
CARD1显示默认卡片样式。

SwipeActionState11+枚举说明

元服务API： 从API version 12开始，该接口支持在元服务中使用。

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

名称枚举值描述
COLLAPSED0

收起状态，当ListItem向左或向右滑动（当列表方向为“垂直”时），

向上或向下滑动（当列方向为“水平”时）时操作项处于隐藏状态。

EXPANDED1

展开状态，当ListItem向左或向右滑动（当列表方向为“垂直”时），

向上或向下滑动（当列方向为“水平”时）时操作项处于显示状态。

说明：

需要ListItem设置向左或向右滑动（当列表方向为“垂直”时），

向上或向下滑动（当列方向为“水平”时）时显示的操作项。

ACTIONING2

长距离状态，当ListItem进入长距删除区后删除ListItem的状态。

说明:

滑动后松手的位置超过或等于设置的距离阈值，并且设置的距离阈值有效时才能进入该状态。

事件

onSelect8+

onSelect(event: (isSelected: boolean) => void)

ListItem元素被鼠标框选的状态改变时触发回调。

卡片能力： 从API version 9开始，该接口支持在ArkTS卡片中使用。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

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

参数：

参数名类型必填说明
isSelectedboolean是进入鼠标框选范围即被选中返回true， 移出鼠标框选范围即未被选中返回false。

示例

示例1（创建ListItem）

该实例实现了创建ListItem的基本用法。

// xxx.ets
@Entry
@Component
struct ListItemExample {
  private arr: number[] = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]


  build() {
    Column() {
      List({ space: 20, initialIndex: 0 }) {
        ForEach(this.arr, (item: number) => {
          ListItem() {
            Text('' + item)
              .width('100%')
              .height(100)
              .fontSize(16)
              .textAlign(TextAlign.Center)
              .borderRadius(10)
              .backgroundColor(0xFFFFFF)
          }
        }, (item: string) => item)
      }.width('90%')
      .scrollBar(BarState.Off)
    }.width('100%').height('100%').backgroundColor(0xDCDCDC).padding({ top: 5 })
  }
}

示例2（设置划出组件）

该示例展示了ListItem设置了swipeAction的横滑效果。

// xxx.ets
@Entry
@Component
struct ListItemExample2 {
  @State arr: number[] = [0, 1, 2, 3, 4]
  @State enterEndDeleteAreaString: string = "not enterEndDeleteArea"
  @State exitEndDeleteAreaString: string = "not exitEndDeleteArea"
  private scroller: ListScroller = new ListScroller()


  @Builder itemEnd() {
    Row() {
      Button("Delete").margin("4vp")
      Button("Set").margin("4vp").onClick(() => {
        this.scroller.closeAllSwipeActions()
      })
    }.padding("4vp").justifyContent(FlexAlign.SpaceEvenly)
  }


  build() {
    Column() {
      List({ space: 10, scroller: this.scroller }) {
        ForEach(this.arr, (item: number) => {
          ListItem() {
            Text("item" + item)
              .width('100%')
              .height(100)
              .fontSize(16)
              .textAlign(TextAlign.Center)
              .borderRadius(10)
              .backgroundColor(0xFFFFFF)
          }
          .transition({ type: TransitionType.Delete, opacity: 0 })
          .swipeAction({
            end: {
              builder: () => { this.itemEnd() },
              onAction: () => {
                animateTo({ duration: 1000 }, () => {
                  let index = this.arr.indexOf(item)
                  this.arr.splice(index, 1)
                })
              },
              actionAreaDistance: 56,
              onEnterActionArea: () => {
                this.enterEndDeleteAreaString = "enterEndDeleteArea"
                this.exitEndDeleteAreaString = "not exitEndDeleteArea"
              },
              onExitActionArea: () => {
                this.enterEndDeleteAreaString = "not enterEndDeleteArea"
                this.exitEndDeleteAreaString = "exitEndDeleteArea"
              }
            }
          })
        }, (item: string) => item)
      }
      Text(this.enterEndDeleteAreaString).fontSize(20)
      Text(this.exitEndDeleteAreaString).fontSize(20)
    }
    .padding(10)
    .backgroundColor(0xDCDCDC)
    .width('100%')
    .height('100%')
  }
}

示例3（设置卡片样式）

该示例展示了ListItem的卡片样式效果。

// xxx.ets
@Entry
@Component
struct ListItemExample3 {
  build() {
    Column() {
      List({ space: "4vp", initialIndex: 0 }) {
        ListItemGroup({ style: ListItemGroupStyle.CARD }) {
          ForEach([ListItemStyle.CARD, ListItemStyle.CARD, ListItemStyle.NONE], (itemStyle: number, index?: number) => {
            ListItem({ style: itemStyle }) {
              Text("" + index)
                .width("100%")
                .textAlign(TextAlign.Center)
            }
          })
        }
        ForEach([ListItemStyle.CARD, ListItemStyle.CARD, ListItemStyle.NONE], (itemStyle: number, index?: number) => {
          ListItem({ style: itemStyle }) {
            Text("" + index)
              .width("100%")
              .textAlign(TextAlign.Center)
          }
        })
      }
      .width('100%')
      .multiSelectable(true)
      .backgroundColor(0xDCDCDC)
    }
    .width('100%')
    .padding({ top: 5 })
  }
}

鸿蒙Harmony应用开发—ArkTS声明式开发（容器组件：ListItem）
m0_64420071的博客
03-15 1769
ArkTS声明式开发（容器组件：ListItem）
鸿蒙5.0版开发：ArkTS组件-ListItem
m0_69424697的博客
11-04 862
用来展示列表具体item，必须配合List来使用。
鸿蒙HarmonyOS开发：List列表组件的使用详解及案例演示
在这里，我乐于倾囊相授，分享我的技术心得、项目实战经验、技术技巧。希望能够惠及更多的开发者，助力大家在技术的海洋中扬帆远航。
05-15 9701
在我们常用的手机应用中，经常会见到一些数据列表，如设置页面、通讯录、商品列表等。下图中两个页面都包含列表，“首页”页面中包含两个网格布局，“商城”页面中包含一个商品列表。列表中都包含一系列相同宽度的列表项，连续、多行呈现同类数据，例如图片和文本。常见的列表有线性列表（List列表）和网格布局（Grid列表）。为了帮助开发者构建包含列表的应用，ArkUI提供了List组件和Grid组件，开发者使用List和Grid组件能够很轻松的完成一些列表页面。
鸿蒙5.0开发进阶：UI框架-ArkTS组件（ListItem）
Androidbye的博客
01-06 779
用来展示列表具体item，必须配合List来使用。
HarmonyOS ArkUI滚动类组件-List、ListItem
1
04-22 3646
List 是很常用的滚动类容器组件之一，它按照水平或者竖直方向线性排列子组件， List 的子组件必须是 ListItem ，它的宽度默认充满 List 的宽度。
List item
测试0901-1
09-21 1262
List item c List item List item <div class="element"> <div class="etitle">商户订单号:</div> <div class=&
鸿蒙5.0开发进阶：API ArkUI框架-ArkTS组件（自定义绘制设置）
Androidbye的博客
12-27 915
当某些组件本身的绘制内容不满足需求时...........
鸿蒙5.0版开发：ArkTS组件-LoadingProgress
m0_69424697的博客
11-17 965
用于显示加载动效的组件。
鸿蒙5.0版开发：ArkTS组件-ComposeListItem
m0_69424697的博客
11-06 1052
列表包含一系列相同宽度的列表项。
鸿蒙5.0版开发：ArkTS组件-List
m0_69424697的博客
11-04 1021
列表包含一系列相同宽度的列表项。
HarmonyOS列表组件
juer2017的博客
11-03 1345
鸿蒙开发构建列表页面
HarmonyOS 组件8--List列表
weixin_56595425的博客
01-25 468
掌握List容器，打造流畅滚动与多样排列的交互体验 在这篇博客中，我们将深入研究前端开发中常用的List容器，解析其强大的特性，包括自动滚动、竖向横向排列等。通过简单易懂的语法和实例代码，你将学会如何运用List容器创建出令用户惊艳的交互体验。无论是展示大量数据还是实现独特的界面布局，List容器都将成为你前端工具箱中的得力助手。让我们一同探索前端开发中这个新的玩法吧！
鸿蒙Harmony应用开发—ArkTS声明式开发（容器组件：List）
m0_64420071的博客
03-15 2814
ArkTS声明式开发（容器组件：List）
ListItem控件
topso的专栏
02-17 2030
在从一个ListBox选择内容copy到另外一个ListBox时候用下面的方法:if (ListBox2.Items.IndexOf(ListBox1.SelectedItem) == -1)        {            ListBox2.Items.Add(new ListItem(ListBox1.SelectedValue));            //ListBox2.I
HarmonyOS_ListContainer
Kelvin_LBY的博客
06-30 232
HarmonyOS_ListContainer 准备ListContainer 在layout下新建listitem.xml来设计每一项布局 <?xml version="1.0" encoding="utf-8"?> <DirectionalLayout xmlns:ohos="http://schemas.huawei.com/res/ohos" ohos:height="match_content" ohos:width="match_parent"
鸿蒙ArkTS容器组件：【List】
2401_82772199的博客
07-09 2053
列表包含一系列相同宽度的列表项。适合连续、多行呈现同类数据，例如图片和文本。点击或者复制转到。
ListItem的设置
lianghui0811
08-30 2230
ListItem的设置是ScrollView和自定义每行Item的结合 1、创建一个ScrollView 2、创建一个节点Templates 3、在Templates创建一个精灵Item，该节点存放的东西为每行类似的东西，比如每行都有用户名和俱乐部ID等等，在精灵Item上可以添加精灵Sprite和文本Label。 4、创建一个脚本Item并且精灵Item控件关联这个脚本， cons...
鸿蒙的 ListItem 组件
最新发布
小淼淼的博客
03-14 2046
ListItem是鸿蒙 Next 中用于构建列表界面的核心组件。通过与List组件配合，可以实现丰富的列表布局和交互效果。本文介绍了ListItem的基本用法，包括简单列表项、带图标和文本的列表项、分组列表项、水平滚动列表以及动态加载数据的示例。希望这些内容能帮助你更好地理解和使用ListItem组件。如果你有任何问题或需要进一步讨论，欢迎随时交流！
深入浅出Svelte UI框架：基础组件与项目模板指南
入门资料库提供的示例中没有具体的代码生成器或使用指导，但定义了一些基础组件并将其整合到主要组件中，例如App、Button、Headline、List、ListItem、UserInput、Contenteditable、Table、RadioBoxes、ModalDialog/...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值