• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# list
2
3
4列表包含一系列相同宽度的列表项。适合连续、多行呈现同类数据,例如图片和文本。
5
6> **说明:**
7>
8> 从API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
9>
10> 针对卡片场景,建议开发者控制list中的子节点list-item的数量(建议30条以内)以便获取更好的卡片交互体验。
11
12
13
14
15## 子组件
16
17仅支持<[list-item](js-service-widget-container-list-item.md)>子组件。
18
19
20## 属性
21
22除支持[通用属性](js-service-widget-common-attributes.md)外,还支持如下属性:
23
24| 名称            | 类型             | 默认值     | 必填   | 描述                                       |
25| ------------- | -------------- | ------- | ---- | ---------------------------------------- |
26| cachedcount   | number         | 0       | 否    | 长列表延迟加载时list-item最少缓存数量。                 |
27| scrollbar     | string         | off     | 否    | 侧边滑动栏的显示模式(当前只支持纵向):<br/>-&nbsp;off:不显示。<br/>-&nbsp;auto:按需显示(触摸时显示,2s后消失)。<br/>-&nbsp;on:常驻显示。 |
28| scrolleffect  | string         | spring  | 否    | 滑动效果,目前支持如下滑动效果:<br/>-&nbsp;spring:弹性物理动效,滑动到边缘后可以根据初始速度或通过触摸事件继续滑动一段距离,松手后回弹。<br/>-&nbsp;fade:渐隐物理动效,滑动到边缘后展示一个波浪形的渐隐,根据速度和滑动距离的变化渐隐也会发送一定的变化。<br/>-&nbsp;no:滑动到边缘后无效果。 |
29| divider       | boolean        | false   | 否    | item是否自带分隔线。<br/>其样式参考[样式列表](#样式)的divider-color、divider-height、divider-length、divider-origin。 |
30| shapemode     | string         | default | 否    | 侧边滑动栏的形状类型。<br/>-&nbsp;default:不指定,跟随主题。<br/>-&nbsp;rect:矩形。<br/>-&nbsp;round:圆形。 |
31| updateeffect  | boolean        | false   | 否    | 用于设置当list内部的item发生删除或新增时是否支持动效。<br/>-&nbsp;false:新增删除item时无过渡动效。<br/>-&nbsp;true:新增删除item时播放过程动效。 |
32| initialindex  | number         | 0       | 否    | 用于设置当前List初次加载时视口起始位置显示的item,默认为0,即显示第一个item,如设置的序号超过了最后一个item的序号,则设置不生效,当同时设置了initialoffset属性时,当前属性不生效。 |
33| initialoffset | &lt;length&gt; | 0       | 否    | 用于设置当前List初次加载时视口的起始偏移量,偏移量无法超过当前List可滑动的范围,如果超过会被截断为可滑动范围的极限值。 |
34| selected      | string         | -       | 否    | 指定当前列表中被选中激活的项,可选值为list-item的section属性值。 |
35
36
37## 样式
38
39除支持[通用样式](js-service-widget-common-styles.md)外,还支持如下样式:
40
41| 名称               | 类型                                       | 默认值         | 必填   | 描述                                       |
42| ---------------- | ---------------------------------------- | ----------- | ---- | ---------------------------------------- |
43| divider-color    | &lt;color&gt;                            | transparent | 否    | item分隔线颜色,仅当list的divider属性为true时生效。      |
44| divider-height   | &lt;length&gt;                           | 1           | 否    | item分隔线高度,仅当list的divider属性为true时生效。      |
45| divider-length   | &lt;length&gt;                           | 主轴宽度        | 否    | item分隔线长度,不设置时最大长度为主轴宽度,具体长度取决于divider-origin,仅当list的divider属性为true时生效。 |
46| divider-origin   | &lt;length&gt;                           | 0           | 否    | item分隔线相对于item主轴起点位置的偏移量,仅当list的divider属性为true时生效。 |
47| flex-direction   | string                                   | column      | 否    | 设置flex容器主轴的方向,指定flex项如何放置在flex容器中,可选值为:<br/>-&nbsp;column:主轴为纵向。<br/>-&nbsp;row:主轴为横向。<br/>其他组件默认值为row,在list组件中默认值为column。 |
48| columns          | number                                   | 1           | 否    | list交叉轴方向的显示列数,默认为1列。<br/>设置多列时,在list交叉轴上进行均分,每一列大小相同。 |
49| align-items      | string                                   | stretch     | 否    | list每一列交叉轴上的对齐格式,可选值为:<br/>-&nbsp;stretch:弹性元素被在交叉轴方向被拉伸到与容器相同的高度或宽度。<br/>-&nbsp;flex-start:元素向交叉轴起点对齐。<br/>-&nbsp;flex-end:元素向交叉轴终点对齐。<br/>-&nbsp;center:元素在交叉轴居中。<br/>&nbsp;align-items样式作用在每一列的子元素上,列与列之间采用均分方式布局。 |
50| item-extent      | &lt;length&gt;&nbsp;\|&nbsp;&lt;percentage&gt; | -           | 否    | 设置内部item为固定大小,设置为百分比格式时,指相对于list的视口主轴方向长度的百分比。 |
51| fade-color       | &lt;color&gt;                            | grey        | 否    | 设置渐隐物理动效的颜色。当滑动效果设置为渐隐物理动效时生效。           |
52| scrollbar-color  | &lt;color&gt;                            | -           | 否    | 设置滚动条的颜色。                                |
53| scrollbar-width  | &lt;length&gt;                           | -           | 否    | 设置滚动条的宽度。                                |
54| scrollbar-offset | &lt;length&gt;                           | 0           | 否    | 设置滚动条距离List默认位置的偏移量,只支持正数,默认位置在List右边缘,可以通过这个偏移量调整滚动条的水平位置,如果滚动条绘制在list外部,而list父组件有裁剪,会导致滚动条被裁剪。 |
55
56
57## 事件
58
59支持[通用事件](js-service-widget-common-events.md)。
60
61
62## 示例
63
64
65```html
66<!-- index.hml -->
67<div class="container">
68  <list class="todo-wraper">
69    <list-item for="{{todolist}}" class="todo-item">
70      <text class="todo-title">{{$item.title}}</text>
71      <text class="todo-title">{{$item.date}}</text>
72    </list-item>
73  </list>
74</div>
75```
76
77
78```json
79{
80  "data": {
81    "todolist": [{
82      "title": "work",
83      "date": "2021-12-31 10:00:00"
84    }, {
85      "title": "watch movie",
86      "date": "2021-12-31 20:00:00"
87    }]
88  }
89}
90```
91
92
93```css
94/* index.css */
95.container {
96  display: flex;
97  justify-content: center;
98  align-items: center;
99  left: 0px;
100  top: 0px;
101  width: 454px;
102  height: 454px;
103}
104.todo-wraper {
105  width: 454px;
106  height: 300px;
107}
108.todo-item {
109  width: 454px;
110  height: 80px;
111  flex-direction: column;
112}
113.todo-title {
114  width: 454px;
115  height: 40px;
116  text-align: center;
117}
118```
119**4*4卡片**
120
121![zh-cn_image_0000001231370803](figures/zh-cn_image_0000001231370803.png)