<list>

简介

<list> 组件是提供垂直列表功能的核心组件,拥有平滑的滚动和高效的内存管理,非常适合用于长列表的展示。最简单的使用方法是在 <list> 标签内使用一组由简单数组循环生成的 <cell> 标签填充。

  1. <template>
  2. <list>
  3. <cell v-for="num in lists">
  4. <text>{{num}}</text>
  5. </cell>
  6. </list>
  7. </template>
  8. <script>
  9. export default {
  10. data () {
  11. return {
  12. lists: ['A', 'B', 'C', 'D', 'E']
  13. }
  14. }
  15. }
  16. </script>

注意

  • 不允许相同方向的 <list> 或者 <scroller> 互相嵌套,换句话说就是嵌套的 <list> / <scroller> 必须是不同的方向。
  • <list> 需要显式的设置其宽高,可使用 position: absolute; 定位或 widthheight 设置其宽高值。

子组件

<list> 的子组件只能包括以下四种组件或是 fix 定位的组件,其他形式的组件将不能被正确渲染。

  • <cell>用于定义列表中的子列表项,类似于 HTML 中的 ul 之于 li。Weex 会对 <cell> 进行高效的内存回收以达到更好的性能。
  • <header><header> 到达屏幕顶部时,吸附在屏幕顶部。
  • <refresh>用于给列表添加下拉刷新的功能。
  • <loading><loading> 用法与特性和 <refresh> 类似,用于给列表添加上拉加载更多的功能。

属性

属性名说明类型默认值
show-scrollbar控制是否出现滚动条booleantrue
loadmoreoffset触发 loadmore 事件所需要的垂直偏移距离(设备屏幕底部与 list 底部之间的距离),建议手动设置此值,设置大于0的值即可number0
offset-accuracy控制 onscroll 事件触发的频率:表示两次onscroll事件之间列表至少滚动了10px。注意,将该值设置为较小的数值会提高滚动事件采样的精度,但同时也会降低页面的性能number10
pagingEnabled是否按分页模式线上List,默认值falsev0.20+booleantrue/false
scrollable是否运行List关系booleantrue/false

loadmoreoffset 示意图:

list - 图1

事件

  • loadmore 事件如果列表滚动到底部将会立即触发这个事件,你可以在这个事件的处理函数中加载下一页的列表项。 如果未触发,请检查是否设置了loadmoreoffset的值,建议此值设置大于0

  • scroll 事件列表发生滚动时将会触发该事件,事件的默认抽样率为 10px,即列表每滚动 10px 触发一次,可通过属性 offset-accuracy 设置抽样率。

事件中的 event 对象属性:

  • contentSize {Object}:列表的内容尺寸
    • width {number}:列表内容宽度
    • height {number}:列表内容高度
  • contentOffset {Object}:列表的偏移尺寸
    • x {number}:x轴上的偏移量
    • y {number}:y轴上的偏移量
  • isDragging {boolean}: 用户是否正在拖动列表

扩展

scrollToElement(node, options)

滚动到列表某个指定项是常见需求,<list> 拓展了该功能,可通过 dom.scrollToElement() 滚动到指定 <cell>。更多信息可参考 dom module。相应的 demo 可参考 <scroller> 示例list - 图2中的实现。

示例

简单示例list - 图3滑动加载list - 图4头部示例list - 图5cell appear事件list - 图6