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

子组件

可以包含单个子组件。

接口

ListItem¹⁰⁺

ListItem(value?: ListItemOptions)

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

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

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

参数：

展开

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

ListItem^(deprecated)

ListItem(value?: string)

从API version 10开始, 该接口不再维护，推荐使用ListItem¹⁰⁺。

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

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

参数：

展开

参数名	类型	必填	说明
value	string	否	无

属性

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

sticky^(deprecated)

sticky(value: Sticky)

设置ListItem吸顶效果。

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

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

参数：

展开

参数名	类型	必填	说明
value	Sticky	是	ListItem吸顶效果。默认值：Sticky.None

参数名

类型

必填

说明

value

Sticky

是

ListItem吸顶效果。

默认值：Sticky.None

editable^(deprecated)

editable(value: boolean | EditMode)

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

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

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

参数：

展开

参数名	类型	必填	说明
value	boolean \| EditMode	是	ListItem元素是否可编辑。默认值：false

参数名

类型

必填

说明

value

boolean | EditMode

是

ListItem元素是否可编辑。

默认值：false

selectable⁸⁺

selectable(value: boolean)

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

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

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

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

参数：

展开

参数名	类型	必填	说明
value	boolean	是	ListItem元素是否可以被鼠标框选。默认值：true

参数名

类型

必填

说明

value

boolean

是

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

默认值：true

selected¹⁰⁺

selected(value: boolean)

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

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

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

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

参数：

展开

参数名	类型	必填	说明
value	boolean	是	当前ListItem选中状态。默认值：false

参数名

类型

必填

说明

value

boolean

是

当前ListItem选中状态。

默认值：false

swipeAction⁹⁺

swipeAction(value: SwipeActionOptions)

用于设置ListItem的划出组件。

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

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

参数：

展开

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

Sticky^(deprecated)枚举说明

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

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

展开

名称	枚举值	描述
None	0	无吸顶效果。
Normal	1	当前item吸顶。
Opacity	2	当前item吸顶显示透明度变化效果。

EditMode^(deprecated)枚举说明

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

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

展开

名称	枚举值	描述
None	0	编辑操作不限制。
Deletable	1	可删除。
Movable	2	可移动。

SwipeEdgeEffect⁹⁺枚举说明

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

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

展开

名称	枚举值	描述
Spring	0	ListItem划动距离超过划出组件大小后可以继续划动。如果设置了删除区域，ListItem划动距离超过删除阈值后可以继续划动，松手后按照弹簧阻尼曲线回弹。
None	1	ListItem划动距离不能超过划出组件大小。如果设置了删除区域，ListItem划动距离不能超过删除阈值，并且在设置删除回调的情况下，达到删除阈值后松手触发删除回调。

名称

枚举值

描述

Spring

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

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

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

None

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

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

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

SwipeActionOptions⁹⁺对象说明

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

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

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

展开

名称	类型	必填	说明
start	CustomBuilder \| SwipeActionItem	否	ListItem向右划动时item左边的组件（List垂直布局时）或ListItem向下划动时item上方的组件（List水平布局时）。元服务API：从API version 11开始，该接口支持在元服务中使用。
end	CustomBuilder \| SwipeActionItem	否	ListItem向左划动时item右边的组件（List垂直布局时）或ListItem向上划动时item下方的组件（List水平布局时）。元服务API：从API version 11开始，该接口支持在元服务中使用。
edgeEffect	SwipeEdgeEffect	否	滑动效果。元服务API：从API version 11开始，该接口支持在元服务中使用。
onOffsetChange¹¹⁺	(offset: number) => void	否	滑动操作偏移量更改时调用。说明：当列表项向左或向右滑动（当列表方向为“垂直”时），向上或向下滑动（当列方向为“水平”时）位置发生变化触发，以vp为单位。元服务API：从API version 12开始，该接口支持在元服务中使用。

SwipeActionItem¹⁰⁺对象说明

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

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

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

展开

名称	类型	必填	说明
actionAreaDistance	Length	否	设置组件长距离滑动删除距离阈值。默认值：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开始，该接口支持在元服务中使用。
builder	CustomBuilder	否	当列表项向左或向右滑动（当列表方向为“垂直”时），向上或向下滑动（当列方向为“水平”时）时显示的操作项。元服务API：从API version 11开始，该接口支持在元服务中使用。
onStateChange¹¹⁺	(state:SwipeActionState) => void	否	当列表项滑动状态变化时候触发。元服务API：从API version 12开始，该接口支持在元服务中使用。

ListItemOptions¹⁰⁺对象说明

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

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

展开

名称	类型	必填	说明
style	ListItemStyle	否	设置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，居中对齐显示。

名称

类型

必填

说明

style

ListItemStyle

否

设置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，居中对齐显示。

ListItemStyle¹⁰⁺枚举说明

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

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

展开

名称	枚举值	描述
NONE	0	无样式。
CARD	1	显示默认卡片样式。

SwipeActionState¹¹⁺枚举说明

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

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

展开

名称	枚举值	描述
COLLAPSED	0	收起状态，当ListItem向左或向右滑动（当列表方向为“垂直”时），向上或向下滑动（当列方向为“水平”时）时操作项处于隐藏状态。
EXPANDED	1	展开状态，当ListItem向左或向右滑动（当列表方向为“垂直”时），向上或向下滑动（当列方向为“水平”时）时操作项处于显示状态。说明：需要ListItem设置向左或向右滑动（当列表方向为“垂直”时），向上或向下滑动（当列方向为“水平”时）时显示的操作项。
ACTIONING	2	长距离状态，当ListItem进入长距删除区后删除ListItem的状态。说明: 滑动后松手的位置超过或等于设置的距离阈值，并且设置的距离阈值有效时才能进入该状态。

名称

枚举值

描述

COLLAPSED

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

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

EXPANDED

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

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

说明：

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

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

ACTIONING

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

说明:

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

事件

onSelect⁸⁺

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

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

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

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

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

参数：

展开

参数名	类型	必填	说明
isSelected	boolean	是	进入鼠标框选范围即被选中返回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 })
  }
}

List

ListItemGroup

ListItem

子组件

接口

ListItem10+

ListItem(deprecated)

属性

sticky(deprecated)

editable(deprecated)

selectable8+

selected10+

swipeAction9+

Sticky(deprecated)枚举说明

EditMode(deprecated)枚举说明

SwipeEdgeEffect9+枚举说明

SwipeActionOptions9+对象说明

SwipeActionItem10+对象说明

ListItemOptions10+对象说明

ListItemStyle10+枚举说明

SwipeActionState11+枚举说明

事件

onSelect8+

示例

示例1（创建ListItem）

示例2（设置划出组件）

示例3（设置卡片样式）

ListItem¹⁰⁺

ListItem^(deprecated)

sticky^(deprecated)

editable^(deprecated)

selectable⁸⁺

selected¹⁰⁺

swipeAction⁹⁺

Sticky^(deprecated)枚举说明

EditMode^(deprecated)枚举说明

SwipeEdgeEffect⁹⁺枚举说明

SwipeActionOptions⁹⁺对象说明

SwipeActionItem¹⁰⁺对象说明

ListItemOptions¹⁰⁺对象说明

ListItemStyle¹⁰⁺枚举说明

SwipeActionState¹¹⁺枚举说明

onSelect⁸⁺