List(列表)
大约 4 分钟
List(列表)
用于展示一系列项目的视图组件,支持垂直方向和水平方向,继承自Scroller
属性
除了支持所有基础属性,还支持以下属性:
scrollEnable
是否允许滑动内容,默认true
| 参数 | 描述 | 类型 |
|---|---|---|
| value | 是否允许滑动内容,默认true | Boolean |
bouncesEnable H5实现中 微信小程序实现中
是否开启回弹效果,默认 true
| 参数 | 描述 | 类型 |
|---|---|---|
| value | 是否开启回弹效果,默认true | Boolean |
showScrollerIndicator
是否显示滚动条,默认 true
| 参数 | 描述 | 类型 |
|---|---|---|
| value | 是否显示滚动条,默认true | Boolean |
flexDirection
指定排版方向,FlexDirection.COLUMN为垂直方向,FlexDirection.Row为水平方向,默认为垂直方向
| 参数 | 描述 | 类型 |
|---|---|---|
| flexDirection | 指定排版方向 | FlexDirection |
pagingEnable
是否开启分页
| 参数 | 描述 | 类型 |
|---|---|---|
| flexDirection | 是否开启分页 | Boolean |
firstContentLoadMaxIndex
首次内容加载最大条数,用于优化首屏耗
| 参数 | 描述 | 类型 |
|---|---|---|
| maxIndex | 首次内容加载最大条数 | Int |
visibleAreaIgnoreTopMargin
计算可见性面积时忽略顶部的距离
| 参数 | 描述 | 类型 |
|---|---|---|
| margin | 忽略顶部的距离 | Float |
visibleAreaIgnoreBottomMargin
计算可见性面积时忽略底部的距离
| 参数 | 描述 | 类型 |
|---|---|---|
| margin | 忽略底部的距离 | Float |
preloadViewDistance
列表视图预加载距离,默认为 list高度,则多加载一屏视图
| 参数 | 描述 | 类型 |
|---|---|---|
| distance | 列表视图预加载距离 | Float |
事件
除了支持所有基础事件,还支持以下事件:
scroll
监听滚动事件,该方法接收一个闭包回调, 回调中的参数为 ScrollParms
ScrollParms
| 参数 | 描述 | 类型 |
|---|---|---|
| offsetX | 列表当前横轴偏移量 | Float |
| offsetY | 列表当前纵轴偏移量 | Float |
| contentWidth | 列表当前内容总宽度 | Float |
| contentHeight | 列表当前内容总高度 | Float |
| viewWidth | 列表View宽度 | Float |
| viewHeight | 列表View高度 | Float |
| isDragging | 当前是否处于拖拽列表滚动中 | Boolean |
scrollEnd
滚动结束时事件, 该方法接收一个闭包回调, 回调中的参数为 ScrollParms
ScrollParms
| 参数 | 描述 | 类型 |
|---|---|---|
| offsetX | 列表当前横轴偏移量 | Float |
| offsetY | 列表当前纵轴偏移量 | Float |
| contentWidth | 列表当前内容总宽度 | Float |
| contentHeight | 列表当前内容总高度 | Float |
| viewWidth | 列表View宽度 | Float |
| viewHeight | 列表View高度 | Float |
| isDragging | 当前是否处于拖拽列表滚动中 | Boolean |
dragBegin
用户开始拖拽事件, 该方法接收一个闭包回调, 回调中的参数为 ScrollParms
ScrollParms
| 参数 | 描述 | 类型 |
|---|---|---|
| offsetX | 列表当前横轴偏移量 | Float |
| offsetY | 列表当前纵轴偏移量 | Float |
| contentWidth | 列表当前内容总宽度 | Float |
| contentHeight | 列表当前内容总高度 | Float |
| viewWidth | 列表View宽度 | Float |
| viewHeight | 列表View高度 | Float |
| isDragging | 当前是否处于拖拽列表滚动中 | Boolean |
dragEnd
用户停止拖拽事件, 该方法接收一个闭包回调, 回调中的参数为 ScrollParms
ScrollParms
| 参数 | 描述 | 类型 |
|---|---|---|
| offsetX | 列表当前横轴偏移量 | Float |
| offsetY | 列表当前纵轴偏移量 | Float |
| contentWidth | 列表当前内容总宽度 | Float |
| contentHeight | 列表当前内容总高度 | Float |
| viewWidth | 列表View宽度 | Float |
| viewHeight | 列表View高度 | Float |
| isDragging | 当前是否处于拖拽列表滚动中 | Boolean |
contentSizeChanged
组件 Size 发生变化事件, 该方法接收一个闭包回调, 回调中的参数如下
| 参数 | 描述 | 类型 |
|---|---|---|
| width | 组件宽度 | Float |
| height | 组件高度 | Float |
方法
setContentOffset
设置Scroller滚动到某个具体坐标偏移值(offset)的位置。
| 参数 | 描述 | 类型 |
|---|---|---|
| offsetX | 滚动到x轴的偏移量 | Float |
| offsetY | 滚动到y轴的偏移量 | Float |
| animated | 是否使用动画进行偏移,默认为 false | Boolean |
| springAnimation | 是否使用spring动画滚动, 默认为null | SpringAnimation |
setContentInset
设置Scroller内容边距
| 参数 | 描述 | 类型 |
|---|---|---|
| top | 上边距 | Float |
| left | 左边距 | Float |
| bottom | 下边距 | Float |
| right | 右边距 | Float |
| animated | 滑动过程是否使用动画, 默认false | Boolean |
contentInsetWhenEndDrag
设置 OverScroll 时停留的内容边距
| 参数 | 描述 | 类型 |
|---|---|---|
| top | 上边距 | Float |
| left | 左边距 | Float |
| bottom | 下边距 | Float |
| right | 右边距 | Float |