ListItem
用來(lái)展示列表具體item,必須配合List來(lái)使用。
說(shuō)明:
開(kāi)發(fā)前請(qǐng)熟悉鴻蒙開(kāi)發(fā)指導(dǎo)文檔 :[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md
]
- 該組件從API Version 7開(kāi)始支持。后續(xù)版本如有新增內(nèi)容,則采用上角標(biāo)單獨(dú)標(biāo)記該內(nèi)容的起始版本。
- 該組件的父組件只能是[List]或者[ListItemGroup]。
子組件
可以包含單個(gè)子組件。
接口
從API version 9開(kāi)始,該接口支持在ArkTS卡片中使用。
ListItem10+
ListItem(value?: ListItemOptions)
參數(shù):
參數(shù)名 | 參數(shù)類(lèi)型 | 必填 | 參數(shù)描述 |
---|---|---|---|
value | [ListItemOptions] | 否 | 為L(zhǎng)istItem提供可選參數(shù), 該對(duì)象內(nèi)含有ListItemStyle枚舉類(lèi)型的style參數(shù)。 |
屬性
除支持[通用屬性]外,還支持以下屬性:
名稱(chēng) | 參數(shù)類(lèi)型 | 描述 |
---|---|---|
selectable8+ | boolean | 當(dāng)前ListItem元素是否可以被鼠標(biāo)框選。**說(shuō)明:**外層List容器的鼠標(biāo)框選開(kāi)啟時(shí),ListItem的框選才生效。 默認(rèn)值:true |
selected10+ | boolean | 設(shè)置當(dāng)前ListItem選中狀態(tài)。該屬性支持[$$]雙向綁定變量。**說(shuō)明:**該屬性需要在設(shè)置[選中態(tài)樣式]前使用才能生效選中態(tài)樣式。 默認(rèn)值:false |
swipeAction9+ | { start?: CustomBuilder | [SwipeActionItem], end?:CustomBuilder |
SwipeEdgeEffect9+枚舉說(shuō)明
名稱(chēng) | 描述 |
---|---|
Spring | ListItem劃動(dòng)距離超過(guò)劃出組件大小后可以繼續(xù)劃動(dòng)。如果設(shè)置了刪除區(qū)域,ListItem劃動(dòng)距離超過(guò)刪除閾值后可以繼續(xù)劃動(dòng),松手后按照彈簧阻尼曲線回彈。 |
None | ListItem劃動(dòng)距離不能超過(guò)劃出組件大小。如果設(shè)置了刪除區(qū)域,ListItem劃動(dòng)距離不能超過(guò)刪除閾值,并且在設(shè)置刪除回調(diào)的情況下,達(dá)到刪除閾值后松手觸發(fā)刪除回調(diào)。 |
SwipeActionItem10+對(duì)象說(shuō)明
List垂直布局,ListItem向右滑動(dòng),item左邊的長(zhǎng)距離滑動(dòng)刪除選項(xiàng)或向左滑動(dòng)時(shí),item右邊的長(zhǎng)距離滑動(dòng)刪除選項(xiàng)。 List水平布局,ListItem向上滑動(dòng),item下邊的長(zhǎng)距離滑動(dòng)刪除選項(xiàng)或向下滑動(dòng)時(shí),item上邊的長(zhǎng)距離滑動(dòng)刪除選項(xiàng)。
名稱(chēng) | 參數(shù)類(lèi)型 | 必填 | 描述 |
---|---|---|---|
actionAreaDistance | [Length] | 否 | 設(shè)置組件長(zhǎng)距離滑動(dòng)刪除距離閾值。 默認(rèn)值:56vp**說(shuō)明:**不支持設(shè)置百分比。 刪除距離閾值大于item寬度減去劃出組件寬度,或刪除距離閾值小于等于0就不會(huì)設(shè)置刪除區(qū)域。 |
onAction | () => void | 否 | 組件進(jìn)入長(zhǎng)距刪除區(qū)后刪除ListItem時(shí)調(diào)用,進(jìn)入長(zhǎng)距刪除區(qū)后抬手時(shí)觸發(fā)。**說(shuō)明:**滑動(dòng)后松手的位置超過(guò)或等于設(shè)置的距離閾值,并且設(shè)置的距離閾值有效時(shí)才會(huì)觸發(fā)。 |
onEnterActionArea | () => void | 否 | 在滑動(dòng)條目進(jìn)入刪除區(qū)域時(shí)調(diào)用,只觸發(fā)一次,當(dāng)再次進(jìn)入時(shí)仍觸發(fā)。 |
onExitActionArea | () => void | 否 | 當(dāng)滑動(dòng)條目退出刪除區(qū)域時(shí)調(diào)用,只觸發(fā)一次,當(dāng)再次退出時(shí)仍觸發(fā)。 |
builder | CustomBuilder | 否 | 當(dāng)列表項(xiàng)向右或向右滑動(dòng)(當(dāng)列表方向?yàn)椤按怪薄睍r(shí)),向下或向下滑動(dòng)(當(dāng)列方向?yàn)椤八健睍r(shí))時(shí)顯示的操作項(xiàng)。 |
ListItemOptions10+對(duì)象說(shuō)明
名稱(chēng) | 參數(shù)類(lèi)型 | 必填 | 描述 |
---|---|---|---|
style | [ListItemStyle] | 否 | 設(shè)置List組件卡片樣式。 默認(rèn)值: ListItemStyle.NONE 設(shè)置為L(zhǎng)istItemStyle.NONE時(shí)無(wú)樣式。 設(shè)置為L(zhǎng)istItemStyle.CARD時(shí),必須配合[ListItemGroup]的ListItemGroupStyle.CARD同時(shí)使用,顯示默認(rèn)卡片樣式。 卡片樣式下,ListItem默認(rèn)規(guī)格:高度48vp,寬度100%。 卡片樣式下, 為卡片內(nèi)的列表選項(xiàng)提供了默認(rèn)的focus、hover、press、selected和disable樣式。**說(shuō)明:**當(dāng)前卡片模式下,不支持listDirection屬性設(shè)置,使用默認(rèn)Axis.Vertical排列方向。 當(dāng)前卡片模式下,List屬性alignListItem默認(rèn)為L(zhǎng)istItemAlign.Center,居中對(duì)齊顯示。 若僅設(shè)置ListItemStyle.CARD,未設(shè)置ListItemGroupStyle.CARD時(shí),只顯示部分卡片樣式及功能。 |
ListItemStyle10+枚舉說(shuō)明
名稱(chēng) | 描述 |
---|---|
NONE | 無(wú)樣式。 |
CARD | 顯示默認(rèn)卡片樣式。 |
事件
名稱(chēng) | 功能描述HarmonyOS與OpenHarmony鴻蒙文檔籽料:mau123789是v直接拿 |
---|---|
onSelect(event: (isSelected: boolean) => void)8+ | ListItem元素被鼠標(biāo)框選的狀態(tài)改變時(shí)觸發(fā)回調(diào)。 isSelected:進(jìn)入鼠標(biāo)框選范圍即被選中返回true, 移出鼠標(biāo)框選范圍即未被選中返回false。 |
示例
示例1
// 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
// xxx.ets
@Entry
@Component
struct ListItemExample2 {
@State message: string = 'Hello World'
@State arr: number[] = [0, 1, 2, 3, 4]
@State enterEndDeleteAreaString: string = "not enterEndDeleteArea"
@State exitEndDeleteAreaString: string = "not exitEndDeleteArea"
@Builder itemEnd() {
Row() {
Button("Delete").margin("4vp")
Button("Set").margin("4vp")
}.padding("4vp").justifyContent(FlexAlign.SpaceEvenly)
}
build() {
Column() {
List({ space: 10 }) {
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
// 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) // 淺藍(lán)色的List
}
.width('100%')
.padding({ top: 5 })
}
}
審核編輯 黃宇
-
組件
+關(guān)注
關(guān)注
1文章
532瀏覽量
18424 -
鴻蒙
+關(guān)注
關(guān)注
60文章
2620瀏覽量
44059
發(fā)布評(píng)論請(qǐng)先 登錄
HarmonyOS/OpenHarmony原生應(yīng)用-ArkTS萬(wàn)能卡片組件Badge
鴻蒙ArkTS容器組件:Scroll
鴻蒙ArkTS容器組件:SideBarContainer

評(píng)論