• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# ArcList
2
3弧形列表包含一系列列表项。适合连续、多行呈现同类数据，例如图片和文本。
4
5> **说明：**
6>
7> 该组件从API version 18开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
8
9
10## 导入模块
11
12```ts
13import { ArcList, ArcListAttribute } from '@kit.ArkUI';
14```
15
16## 子组件
17
18仅支持[ArcListItem](ts-container-arclistitem.md)子组件。
19
20> **说明：**
21>
22> ArcList的子组件索引值计算规则：
23>
24> - 按子组件的顺序依次递增。
25>
26> - [if/else](../../../ui/state-management/arkts-rendering-control-ifelse.md)语句中，只有条件成立的分支内的子组件会参与索引值计算，条件不成立的分支内子组件不计算索引值。
27>
28> - [ForEach](../../../ui/state-management/arkts-rendering-control-foreach.md)/[LazyForEach](../../../ui/state-management/arkts-rendering-control-lazyforeach.md)语句中，会计算展开所有子节点索引值。
29>
30> - [if/else](../../../ui/state-management/arkts-rendering-control-ifelse.md)、[ForEach](../../../ui/state-management/arkts-rendering-control-foreach.md)和[LazyForEach](../../../ui/state-management/arkts-rendering-control-lazyforeach.md)发生变化以后，会更新子节点索引值。
31>
32> - ArcList子组件[visibility](ts-universal-attributes-visibility.md#visibility)属性设置为Hidden或None依然会计算索引值。
33
34
35## 接口
36
37ArcList(options?: ArkListOptions)
38
39创建弧形列表实例，传入弧形列表配置项参数。
40
41**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
42
43**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
44
45**参数：**
46
47| 参数名  | 类型                                  | 必填 | 说明                |
48| ------- | ----------------------------------------- | ---- | ----------------------- |
49| options | [ArkListOptions](#arklistoptions) | 否   | 为ArcList提供可选参数。 |
50
51## 属性
52
53除支持[通用属性](ts-component-general-attributes.md)外，还支持以下属性：
54
55### digitalCrownSensitivity
56
57digitalCrownSensitivity(sensitivity: Optional\<CrownSensitivity>)
58
59设置表冠响应事件灵敏度。
60
61**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
62
63**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
64
65**参数：**
66
67| 参数名      | 类型                                                         | 必填 | 说明                                                         |
68| ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
69| sensitivity | [Optional&lt;CrownSensitivity&gt;](ts-appendix-enums.md#crownsensitivity18) | 是   | 表冠响应灵敏度。<br/>默认值：CrownSensitivity.MEDIUM，响应速度适中。 |
70
71### space
72
73space(space: Optional\<LengthMetrics>)
74
75设置列表子项之间的距离。
76
77**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
78
79**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
80
81**参数：**
82
83| 参数名 | 类型                                                         | 必填 | 说明                               |
84| ------ | ------------------------------------------------------------ | ---- | ---------------------------------- |
85| space  | [Optional&lt;LengthMetrics&gt;](../js-apis-arkui-graphics.md#lengthmetrics12) | 是   | 列表子项之间的间距。<br/>默认值：0<br/>ArcList子组件的[visibility](ts-universal-attributes-visibility.md#visibility)属性设置为None时不显示，但该子组件上下的space还会生效。 |
86
87### scrollBar
88
89scrollBar(status: Optional\<BarState>)
90
91设置滚动条状态。
92
93**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
94
95**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
96
97**参数：**
98
99| 参数名 | 类型                                                 | 必填 | 说明                                     |
100| ------ | ---------------------------------------------------- | ---- | ---------------------------------------- |
101| status | [Optional\<BarState>](ts-appendix-enums.md#barstate) | 是   | 滚动条状态。<br/>默认值：BarState.Auto |
102
103### cachedCount
104
105cachedCount(count: Optional\<number>)
106
107设置列表中ArcListItem的预加载数量，懒加载场景只会预加载ArcList显示区域外cachedCount的内容，非懒加载场景会全部加载。懒加载、非懒加载都只布局ArcList显示区域+ArcList显示区域外cachedCount的内容。
108
109ArcList设置cachedCount后，显示区域外上下各会预加载并布局cachedCount行ArcListItem。
110
111**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
112
113**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
114
115**参数：**
116
117| 参数名 | 类型              | 必填 | 说明                                       |
118| ------ | ----------------- | ---- | ------------------------------------------ |
119| count  | Optional\<number> | 是   | ArcListItem的预加载数量。<br/>默认值：根据屏幕内显示的节点个数设置，最大值为16。<br/>取值范围：[0, +∞) |
120
121### chainAnimation
122
123chainAnimation(enable: Optional\<boolean>)
124
125设置当前ArcList是否启用链式联动动效，开启后列表滑动以及顶部和底部拖拽时会有链式联动的效果。
126
127链式联动效果：ArcList内的ArcListItem间隔一定距离，在基本的滑动交互行为下，主动对象驱动从动对象进行联动，驱动效果遵循弹簧物理动效。
128
129链式动效生效需要满足前提条件：ArcList边缘效果为[EdgeEffect.Spring](ts-appendix-enums.md#edgeeffect)类型。
130
131**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
132
133**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
134
135**参数：**
136
137| 参数名 | 类型               | 必填 | 说明                                                         |
138| ------ | ------------------ | ---- | ------------------------------------------------------------ |
139| enable | Optional\<boolean> | 是   | 是否启用链式联动动效。<br/>默认值：false，不启用链式联动。true，启用链式联动。 |
140
141### enableScrollInteraction
142
143enableScrollInteraction(enable: Optional\<boolean>)
144
145设置是否支持滚动手势。
146
147**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
148
149**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
150
151**参数：**
152
153| 参数名 | 类型               | 必填 | 说明                                |
154| ------ | ------------------ | ---- | ----------------------------------- |
155| enable | Optional\<boolean> | 是   | 是否支持滚动手势。设置为true时可以通过手指或者鼠标滚动，设置为false时无法通过手指或者鼠标滚动，但不影响控制器[Scroller](ts-container-scroll.md#scroller)的滚动接口。<br/>默认值：true |
156
157### fadingEdge
158
159fadingEdge(enable: Optional&lt;boolean&gt;)
160
161设置是否开启边缘渐隐效果。
162
163**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
164
165**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
166
167**参数：**
168
169| 参数名  | 类型                                              | 必填 | 说明                                                         |
170| ------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
171| enable | Optional&lt;boolean&gt;                           | 是   | fadingEdge生效时，会覆盖原组件的.overlay()属性。<br/>fadingEdge生效时，建议不在该组件上设置background相关属性，会影响渐隐的显示效果。<br/>fadingEdge生效时，组件会裁剪到边界，设置组件的clip属性为false不生效。<br/>设置为true时开启边缘渐隐效果，设置为false时不开启边缘渐隐效果。<br/>默认值：false |
172
173### friction
174
175friction(friction: Optional\<number>)
176
177设置摩擦系数，手动划动滚动区域时生效，仅影响惯性滚动过程，对惯性滚动过程中的链式效果有间接影响。设置为小于等于0的值时，按默认值处理。
178
179**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
180
181**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
182
183**参数：**
184
185| 参数名   | 类型              | 必填 | 说明                         |
186| -------- | ----------------- | ---- | ---------------------------- |
187| friction | Optional\<number> | 是   | 摩擦系数。<br/>默认值：0.8<br/>取值范围：(0, +∞) |
188
189### scrollBarWidth
190
191scrollBarWidth(width: Optional\<LengthMetrics>)
192
193设置滚动条的宽度。宽度设置后，滚动条按压状态宽度为设置的宽度值。
194
195**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
196
197**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
198
199**参数：**
200
201| 参数名 | 类型                                                         | 必填 | 说明                                                        |
202| ------ | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
203| width  | [Optional&lt;LengthMetrics&gt;](../js-apis-arkui-graphics.md#lengthmetrics12) | 是   | 滚动条的宽度。<br/>默认值：24<br/>最小值：4<br />单位：vp |
204
205### scrollBarColor
206
207scrollBarColor(color: Optional\<ColorMetrics>)
208
209设置滚动条的颜色。
210
211**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
212
213**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
214
215**参数：**
216
217| 参数名 | 类型                                                         | 必填 | 说明                                     |
218| ------ | ------------------------------------------------------------ | ---- | ---------------------------------------- |
219| color  | [Optional\<ColorMetrics>](../js-apis-arkui-graphics.md#colormetrics12) | 是   | 设置滚动条颜色。<br />默认值：0xA9FFFFFF |
220
221### flingSpeedLimit
222
223flingSpeedLimit(speed: Optional\<number>)
224
225限制跟手滑动结束后，惯性滚动动效开始时的最大初始速度。设置为小于等于0的值时，按默认值处理。
226
227**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
228
229**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
230
231**参数：**
232
233| 参数名 | 类型              | 必填 | 说明                            |
234| ------ | ----------------- | ---- | ------------------------------- |
235| speed  | Optional\<number> | 是   | 惯性滚动动效开始时的最大初始速度。<br/>默认值：9000<br/>单位：vp/s<br />取值范围：(0, +∞) |
236
237### childrenMainSize
238
239childrenMainSize(size: Optional\<ChildrenMainSize>)
240
241设置ArcList组件的子组件在主轴方向的大小信息。
242
243**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
244
245**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
246
247**参数：**
248
249| 参数名 | 类型                                                         | 必填 | 说明                                                         |
250| ------ | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
251| size   | [Optional\<ChildrenMainSize>](ts-container-scrollable-common.md#childrenmainsize12对象说明) | 是   | 通过[ChildrenMainSize](ts-container-scrollable-common.md#childrenmainsize12对象说明)对象向ArcList组件精确提供所有子组件在主轴方向的大小信息，能够确保ArcList组件在子组件主轴尺寸不统一、子组件的增删变动、以及使用[scrollToIndex](ts-container-scroll.md#scrolltoindex)等场景时，仍能保持其滑动位置的准确性。进而保证了[scrollTo](ts-container-scroll.md#scrollto)能够精准跳转至指定位置，[currentOffset](ts-container-scroll.md#currentoffset)准确反映当前的滑动位置，且内置滚动条能够实现平滑移动，避免任何跳跃或突变。<br/> **说明：** <br/>提供的主轴方向大小必须与子组件实际在主轴方向的大小一致，子组件在主轴方向大小发生变化或进行增删操作时，必须通过调用ChildrenMainSize对象的方法来及时通知ArcList组件。 |
252
253## 事件
254
255### onScrollIndex
256
257onScrollIndex(handler: Optional\<ArcScrollIndexHandler>)
258
259当子组件划入或划出ArcList的显示区域时，将触发此事件。在ArcList初始化时，此事件会被触发一次。当ArcList显示区域内的首个或末个子组件的索引值发生变化，或是显示区域中心的子组件发生变动时，同样会触发此事件。
260
261ArcList的边缘效果为弹簧效果时，在ArcList划动到边缘继续划动和松手回弹过程不会触发onScrollIndex事件。
262
263**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
264
265**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
266
267**参数：**
268
269| 参数名  | 类型                                                         | 必填 | 说明                                            |
270| ------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- |
271| handler | [Optional\<ArcScrollIndexHandler>](#arcscrollindexhandler) | 是   | 有子组件划入或划出ArcList显示区域时触发该回调。 |
272
273### onReachStart
274
275onReachStart(handler: Optional\<VoidCallback>)
276
277列表到达起始位置时触发。
278
279当ArcList进行初始化时，若[initialIndex](#arklistoptions)设定为0，将触发一次事件。当ArcList滚动至起始位置，亦会触发一次事件。在ArcList的边缘效果设置为弹簧效果时，滑动经过起始位置时会触发一次事件，而在回弹返回起始位置时，将再次触发一次事件。
280
281**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
282
283**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
284
285| 参数名  | 类型                                             | 必填 | 说明                     |
286| ------- | ------------------------------------------------ | ---- | ------------------------ |
287| handler | [Optional\<VoidCallback>](ts-types.md#voidcallback12) | 是   | 列表到达起始位置时触发。 |
288
289### onReachEnd
290
291onReachEnd(handler: Optional\<VoidCallback>)
292
293列表到达末尾位置时触发。
294
295ArcList边缘效果为弹簧效果时，划动经过末尾位置时触发一次该事件，回弹回末尾位置时再触发一次该事件。
296
297**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
298
299**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
300
301| 参数名  | 类型                                             | 必填 | 说明                     |
302| ------- | ------------------------------------------------ | ---- | ------------------------ |
303| handler | [Optional\<VoidCallback>](ts-types.md#voidcallback12) | 是   | 列表到达末尾位置时触发。 |
304
305### onScrollStart
306
307onScrollStart(handler: Optional\<VoidCallback>)
308
309列表滑动开始时触发。手指拖动列表或列表的滚动条触发的滑动开始时，会触发该事件。使用[Scroller](ts-container-scroll.md#scroller)滑动控制器触发的带动画的滑动，动画开始时会触发该事件。
310
311**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
312
313**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
314
315| 参数名  | 类型                                             | 必填 | 说明                 |
316| ------- | ------------------------------------------------ | ---- | -------------------- |
317| handler | [Optional\<VoidCallback>](ts-types.md#voidcallback12) | 是   | 列表滑动开始时触发。 |
318
319### onScrollStop
320
321onScrollStop(handler: Optional\<VoidCallback>)
322
323列表滑动停止时触发。手拖动列表或列表的滚动条触发的滑动，手离开屏幕并且滑动停止时会触发该事件。使用[Scroller](ts-container-scroll.md#scroller)滑动控制器触发的带动画的滑动，动画停止会触发该事件。
324
325**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
326
327**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
328
329| 参数名  | 类型                                             | 必填 | 说明                 |
330| ------- | ------------------------------------------------ | ---- | -------------------- |
331| handler | [Optional\<VoidCallback>](ts-types.md#voidcallback12) | 是   | 列表滑动停止时触发。 |
332
333### onWillScroll
334
335onWillScroll(handler: Optional\<OnWillScrollCallback>)
336
337列表划动时每帧开始前触发，返回当前帧将要滑动的偏移量和当前滑动状态。返回的偏移量为计算得到的将要滑动的偏移量值，并非最终实际滑动偏移。
338
339**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
340
341**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
342
343**参数：**
344
345| 参数名 | 类型 | 必填 | 说明 |
346| ------ | ------ | ------ | ------|
347| handler | [Optional\<OnWillScrollCallback>](ts-container-scrollable-common.md#onwillscrollcallback12) | 是 | 列表划动时每帧开始前触发的回调。 |
348
349> **说明：**
350>
351> 调用ScrollEdge和不带动画的ScrollToIndex时，不触发onWillScroll。
352
353### onDidScroll
354onDidScroll(handler: Optional\<OnScrollCallback>)
355
356列表滑动时触发，返回当前帧滑动的偏移量和当前滑动状态。
357
358**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
359
360**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
361
362**参数：**
363
364| 参数名 | 类型 | 必填 | 说明 |
365| ------ | ------ | ------ | ------|
366| handler | [Optional\<OnScrollCallback>](ts-container-scrollable-common.md#onscrollcallback12) | 是 | 列表滑动时触发的回调。 |
367
368## ArkListOptions
369
370包含创建ArcList组件的基础参数。
371
372**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
373
374**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
375
376| 名称       | 类型                                    | 必填 | 说明                                                     |
377| ------------ | ------------------------------------------- | ---- | ------------------------------------------------------------ |
378| initialIndex | number                                      | 否   | 设置当前ArcList初次加载时视口起始位置显示的item的索引值。<br/>默认值：0<br/>**说明：** <br/>设置为负数或超过了当前ArcList最后一个item的索引值时视为无效取值，无效取值按默认值显示。 |
379| scroller     | [Scroller](ts-container-scroll.md#scroller) | 否   | 可滚动组件的控制器。用于与可滚动组件进行绑定。<br/>**说明：** <br/>不允许和其他滚动类组件，如：[ArcList](ts-container-arclist.md)、[List](ts-container-list.md)、[Grid](ts-container-grid.md)、[Scroll](ts-container-scroll.md)和[WaterFlow](ts-container-waterflow.md)绑定同一个滚动控制对象。 |
380| header       | [ComponentContent](../js-apis-arkui-ComponentContent.md)                            | 否   | 支持标题设置。                                               |
381
382## ArcScrollIndexHandler
383
384type ArcScrollIndexHandler = (start: number, end: number, center: number) => void
385
386有子组件划入或划出ArcList显示区域时触发的回调。
387
388**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。
389
390**系统能力：** SystemCapability.ArkUI.ArkUI.Circle
391
392| 参数名 | 类型   | 必填 | 说明                                      |
393| ------ | ------ | ---- | ----------------------------------------- |
394| start  | number | 是   | ArcList显示区域内第一个子组件的索引值。   |
395| end    | number | 是   | ArcList显示区域内最后一个子组件的索引值。 |
396| center | number | 是   | ArcList显示区域内中间位置子组件的索引值。 |
397
398## 示例
399
400该示例增加了ArcList支持标题栏设置的效果，子项自动缩放显示。
401
402```ts
403// xxx.ets
404import { ComponentContent, LengthMetrics } from "@kit.ArkUI";
405import { UIContext, CircleShape } from '@kit.ArkUI';
406import { ArcList, ArcListItem, ArcListAttribute, ArcListItemAttribute } from '@kit.ArkUI';
407
408@Builder
409function buildText() {
410  Column() {
411    Text("header")
412      .fontSize('60px')
413      .fontWeight(FontWeight.Bold)
414  }.margin(0)
415}
416
417@Entry
418@Component
419struct Index {
420  @State  private numItems: number[] = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
421
422  private watchSize: string = '466px' // 手表默认宽高：466*466
423  private listSize: string = '414px' // item宽度
424
425  context: UIContext = this.getUIContext()
426  tabBar1: ComponentContent<Object> = new ComponentContent(this.context, wrapBuilder(buildText));
427
428  @Builder
429  buildList2() {
430    Stack() {
431      Column() {
432      }
433      .justifyContent(FlexAlign.Center)
434      .width(this.watchSize)
435      .height(this.watchSize)
436      .clipShape(new CircleShape({ width: '100%', height: '100%' }))
437      .backgroundColor(Color.White)
438
439      ArcList({ initialIndex: 0, header: this.tabBar1 }) {
440        ForEach(this.numItems, (item: number, index: number) => {
441          ArcListItem() {
442            Button('' + item, { type: ButtonType.Capsule })
443              .width(this.listSize)
444              .height('100px')
445              .fontSize('40px')
446              .focusable(true)
447              .focusOnTouch(true)
448              .backgroundColor(0x17A98D)
449          }.align(Alignment.Center)
450        }, (item: string, index: number) => item + index)
451      }
452      .space(LengthMetrics.px(10))
453      .borderRadius(this.watchSize)
454      .focusable(true)
455      .focusOnTouch(true)
456      .defaultFocus(true)
457    }
458    .align(Alignment.Center)
459    .width(this.watchSize)
460    .height(this.watchSize)
461    .border({color: Color.Black, width: 1})
462    .borderRadius(this.watchSize)
463  }
464
465  build() {
466    Column() {
467      this.buildList2()
468    }
469    .width('100%')
470    .height('100%')
471    .alignItems(HorizontalAlign.Center)
472    .justifyContent(FlexAlign.Center)
473  }
474}
475```
476
477![arkts-arclist](figures/arkts-arclist.png)