list.md 4.0 KB
Newer Older
d-u-a's avatar
d-u-a 已提交
1 2
#### list

W
wanganxp 已提交
3
app端nvue专用组件。在app-nvue下,如果是长列表,使用list组件的性能高于使用view或scroll-view的滚动。原因在于list在不可见部分的渲染资源回收有特殊的优化处理。
d-u-a's avatar
d-u-a 已提交
4

W
wanganxp 已提交
5 6
原生渲染的资源回收机制,与webview渲染不同。webview不需要数据有规则格式,长页面处于不可视的部分,其渲染资源会自动回收,除非webview使用区域滚动而不是页面滚动。所以vue页面只要不用scroll-view,就不需要关注这个问题。而原生渲染则必须注意。

W
wanganxp 已提交
7
**如果需要跨端,建议使用uni-ui的uni-list组件,它会自动处理webview渲染和原生渲染的情况,在app-nvue下使用list组件,而在其他平台则使用页面滚动。详见[https://ext.dcloud.net.cn/plugin?id=24](https://ext.dcloud.net.cn/plugin?id=24)**
W
wanganxp 已提交
8

d-u-a's avatar
d-u-a 已提交
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
`<list>` 组件是提供垂直列表功能的核心组件,拥有平滑的滚动和高效的内存管理,非常适合用于长列表的展示。最简单的使用方法是在 `<list>` 标签内使用一组由简单数组循环生成的 `<cell>` 标签填充。

```
<template>
  <list>
    <cell v-for="num in lists">
      <text>{{num}}</text>
    </cell>
  </list>
</template>

<script>
  export default {
    data () {
      return {
        lists: ['A', 'B', 'C', 'D', 'E']
      }
    }
  }
</script>
```

> **注意**
d-u-a's avatar
d-u-a 已提交
32
> - 相同方向 `<list>` 或者 `<scroll-view>` 互相嵌套时,Android 平台子 `<list>` 不可滚动,iOS 可以,iOS 有Bounce效果, Android仅可滚动时有
d-u-a's avatar
d-u-a 已提交
33
> - `<list>` 需要显式的设置其宽高,可使用 position: absolute; 定位或 width、height 设置其宽高值。
W
wanganxp 已提交
34
> - list是区域滚动,不会触发页面滚动,无法触发pages.json配置的下拉刷新、页面触底onReachBottomDistance、titleNView的transparent透明渐变。
d-u-a's avatar
d-u-a 已提交
35

d-u-a's avatar
d-u-a 已提交
36

d-u-a's avatar
d-u-a 已提交
37 38 39 40
#### 子组件
`<list>` 的子组件只能包括以下四种组件或是 fix 定位的组件,其他形式的组件将不能被正确渲染。

- `<cell>`<br>
d-u-a's avatar
d-u-a 已提交
41
 用于定义列表中的子列表项,类似于 HTML 中的 ul 之于 li。`<list>` 会对 `<cell>` 进行高效的内存回收以达到更好的性能。
d-u-a's avatar
d-u-a 已提交
42 43 44 45 46 47 48 49 50 51 52 53
- `<header>`<br>`<header>` 到达屏幕顶部时,吸附在屏幕顶部。
- `<refresh>`<br>用于给列表添加下拉刷新的功能。
- `<loading>`<br>
  `<loading>` 用法与特性和 `<refresh>` 类似,用于给列表添加上拉加载更多的功能。

#### 属性

|属性名|说明|类型|默认值|
|:-|:-|:-|:-|
|show-scrollbar|控制是否出现滚动条|boolean|true|
|loadmoreoffset|触发 loadmore 事件所需要的垂直偏移距离(设备屏幕底部与 list 底部之间的距离),建议手动设置此值,设置大于0的值即可|number|0|
|offset-accuracy|控制 onscroll 事件触发的频率:表示两次onscroll事件之间列表至少滚动了10px。注意,将该值设置为较小的数值会提高滚动事件采样的精度,但同时也会降低页面的性能|number|10|
雪洛's avatar
雪洛 已提交
54 55
|pagingEnabled|是否按分页模式显示List,默认值false|boolean|true/false|
|scrollable|是否允许List滚动|boolean|true/false|
d-u-a's avatar
d-u-a 已提交
56 57 58

`loadmoreoffset` 示意图:

d-u-a's avatar
d-u-a 已提交
59 60
<img src="https://img-cdn-qiniu.dcloud.net.cn/app-nvue-component-list.png" />

d-u-a's avatar
d-u-a 已提交
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
#### 事件


- `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}`: 用户是否正在拖动列表