参数名

参数类型

必填

参数描述

space

number | string

否

列表项间距。

默认值：0

initialIndex

number

否

设置当前List初次加载时视口起始位置显示的item的索引值。如果设置的值超过了当前List最后一个item的索引值，则设置不生效。

默认值：0

scroller

Scroller

否

可滚动组件的控制器。用于与可滚动组件进行绑定。

名称

参数类型

描述

listDirection

Axis

设置List组件排列方向参照Axis枚举说明。

默认值：Vertical

divider

{

strokeWidth: Length,

color?: ResourceColor,

startMargin?: Length,

endMargin?: Length

} | null

用于设置ListItem分割线样式，默认无分割线。

strokeWidth: 分割线的线宽。

color: 分割线的颜色。

startMargin： 分割线与列表侧边起始端的距离。

endMargin: 分割线与列表侧边结束端的距离。

scrollBar

BarState

设置滚动条状态。

默认值：BarState.Off

cachedCount

number

设置预加载的ListItem的数量。具体使用可参考减少应用白块说明。

默认值：1

editMode

boolean

声明当前List组件是否处于可编辑模式。

默认值：false

edgeEffect

EdgeEffect

滑动效果，目前支持的滑动效果参见EdgeEffect的枚举说明。

默认值：EdgeEffect.Spring

chainAnimation

boolean

用于设置当前list是否启用链式联动动效，开启后列表滑动以及顶部和底部拖拽时会有链式联动的效果。链式联动效果：list内的list-item间隔一定距离，在基本的滑动交互行为下，主动对象驱动从动对象进行联动，驱动效果遵循弹簧物理动效。

- false：不启用链式联动。

- true：启用链式联动。

默认值：false

multiSelectable8+

boolean

是否开启鼠标框选。

>默认值：false

- false：关闭框选。

- true：开启框选。

名称

功能描述

onItemDelete(event: (index: number) => boolean)

列表项删除时触发。

onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void)

列表滑动时触发，返回值scrollOffset为滑动偏移量，scrollState为当前滑动状态。

onScrollIndex(event: (start: number, end: number) => void)

列表滑动时触发，返回值分别为滑动起始位置索引值与滑动结束位置索引值。

onReachStart(event: () => void)

列表到达起始位置时触发。

onReachEnd(event: () => void)

列表到底末尾位置时触发。

onScrollStop(event: () => void)

列表滑动停止时触发。

onItemMove(event: (from: number, to: number) => boolean)

列表元素发生移动时触发，返回值from、to分别为移动前索引值与移动后索引值。

onItemDragStart(event: (event: ItemDragInfo, itemIndex: number) => ((() => any) | void))

开始拖拽列表元素时触发，返回值event见ItemDragInfo对象说明，itemIndex为被拖拽列表元素索引值。

onItemDragEnter(event: (event: ItemDragInfo) => void)

拖拽进入列表元素范围内时触发，返回值event见ItemDragInfo对象说明。

onItemDragMove(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number) => void)

拖拽在列表元素范围内移动时触发，返回值event见ItemDragInfo对象说明，itemIndex为拖拽起始位置，insertIndex为拖拽插入位置。

onItemDragLeave(event: (event: ItemDragInfo, itemIndex: number) => void)

拖拽离开列表元素时触发，返回值event见ItemDragInfo对象说明，itemIndex为拖拽离开的列表元素索引值。

onItemDrop(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number, isSuccess: boolean) => void)

绑定该事件的列表元素可作为拖拽释放目标，当在列表元素内停止拖拽时触发，返回值event见ItemDragInfo对象说明，itemIndex为拖拽起始位置，insertIndex为拖拽插入位置，isSuccess为是否成功释放。

名称

描述

Idle

未滑动状态。

Scroll

惯性滑动状态。

Fling

手指拖动状态。

名称

参数类型

默认值

描述

sticky

Sticky

Sticky.None

设置ListItem吸顶效果，参见Sticky枚举描述。

默认值：Sticky.None

editable

boolean | EditMode

false

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

默认值：false

selectable8+

boolean

true

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

默认值：true

说明：

外层List容器的鼠标框选开启时，ListItem的框选才生效。

名称

描述

None

无吸顶效果。

Normal

当前item吸顶。

Opacity

当前item吸顶显示透明度变化效果。

名称

描述

None

编辑操作不限制。

Deletable

可删除。

Movable

可移动。

名称

功能描述

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

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

isSelected：进入鼠标框选范围即被选中返回true， 移出鼠标框选范围即未被选中返回false。