鸿蒙5.0版开发：ArkTS容器组件（Scroll）

于 2024-09-27 17:12:29 发布
阅读量1k 收藏 28
点赞数 21
分类专栏： 鸿蒙5.0 ArkUI ArkTS 文章标签： harmonyos 华为 鸿蒙 android ArkTS ArkUI 前端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_69424697/article/details/142598153
版权
鸿蒙5.0 同时被 3 个专栏收录
214 篇文章 0 订阅
订阅专栏
ArkUI
214 篇文章 0 订阅
订阅专栏
ArkTS
210 篇文章 0 订阅
订阅专栏

Scroll

可滚动的容器组件，当子组件的布局尺寸超过父组件的尺寸时，内容可以滚动。

说明：

  • 该组件从API version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
  • 该组件嵌套List子组件滚动时，若List不设置宽高，则默认全部加载，在对性能有要求的场景下建议指定List的宽高。
  • 该组件滚动的前提是主轴方向大小小于内容大小。
  • 该组件回弹的前提是要有滚动。内容小于一屏时，没有回弹效果。

子组件

支持单个子组件。

接口

Scroll(scroller?: Scroller)

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

参数：

参数名参数类型必填参数描述
scrollerScroller否可滚动组件的控制器。用于与可滚动组件进行绑定。

属性

除支持通用属性外，还支持以下属性：

scrollable

scrollable(value: ScrollDirection)

设置滚动方向。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名类型必填说明
valueScrollDirection是滚动方向。
默认值：ScrollDirection.Vertical

scrollBar

scrollBar(barState: BarState)

设置滚动条状态。如果容器组件无法滚动，则滚动条不显示。如果容器组件的子组件大小为无穷大，则滚动条不支持拖动和伴随滚动。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名类型必填说明
barStateBarState是滚动条状态。
默认值：BarState.Auto

scrollBarColor

scrollBarColor(color: Color | number | string)

设置滚动条的颜色。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名类型必填说明
colorstring | number | Color是滚动条的颜色。
默认值：‘#182431’（40%不透明度）

scrollBarWidth

scrollBarWidth(value: number | string)

设置滚动条的宽度，不支持百分比设置。宽度设置后，滚动条正常状态和按压状态宽度均为滚动条的宽度值。如果滚动条的宽度超过Scroll组件主轴方向的高度，则滚动条的宽度会变为默认值。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名类型必填说明
valuestring | number是滚动条的宽度。
默认值：4
单位：vp

scrollSnap10+

scrollSnap(value: ScrollSnapOptions)

设置Scroll组件的限位滚动模式。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名类型必填说明
valueScrollSnapOptions是Scroll组件的限位滚动模式。

edgeEffect

edgeEffect(edgeEffect: EdgeEffect, options?: EdgeEffectOptions)

设置边缘滑动效果。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名类型必填说明
edgeEffectEdgeEffect是Scroll组件的边缘滑动效果，支持弹簧效果和阴影效果。
默认值：EdgeEffect.None
options11+EdgeEffectOptions否组件内容大小小于组件自身时，是否开启滑动效果。
默认值：true

enableScrollInteraction10+

enableScrollInteraction(value: boolean)

设置是否支持滚动手势，当设置为false时，无法通过手指或者鼠标滚动，但不影响控制器的滚动接口。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名类型必填说明
valueboolean是是否支持滚动手势。
默认值：true

nestedScroll10+

nestedScroll(value: NestedScrollOptions)

设置向前向后两个方向上的嵌套滚动模式，实现与父组件的滚动联动。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名类型必填说明
valueNestedScrollOptions是嵌套滚动选项。

friction10+

friction(value: number | Resource)

设置摩擦系数，手动划动滚动区域时生效，只对惯性滚动过程有影响，对惯性滚动过程中的链式效果有间接影响。设置为小于等于0的值时，按默认值处理

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名类型必填说明
valueResource | number是摩擦系数。
默认值：非可穿戴设备为0.6，可穿戴设备为0.9。
从API version 11开始，非可穿戴设备默认值为0.7。

enablePaging11+

enablePaging(value: boolean)

设置是否支持划动翻页。如果同时设置了划动翻页enablePaging和限位滚动scrollSnap，则scrollSnap优先生效，enablePaging不生效。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名类型必填说明
valueboolean是是否支持划动翻页。
默认值：false

flingSpeedLimit11+

flingSpeedLimit(speedLimit: number)

限制跟手滑动结束后，Fling动效开始时的最大初始速度。单位是vp/s。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名类型必填说明
speedLimitnumber是Fling动效开始时的最大初始速度。

initialOffset12+

initialOffset(value: OffsetOptions)

设置初始滚动偏移量。只在首次布局时生效，后续动态修改该属性值不生效。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名类型必填说明
valueOffsetOptions是当输入的大小为百分比时，初始滚动偏移量为Scroll组件主轴方向大小与百分比数值之积。

ScrollDirection枚举说明

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

名称描述
Horizontal仅支持水平方向滚动。
Vertical仅支持竖直方向滚动。
None不可滚动。
Free(deprecated)支持竖直或水平方向滚动
从API version 9开始废弃

ScrollSnapOptions10+

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

名称参数类型必填描述
snapAlignScrollSnapAlign是设置Scroll组件限位滚动时的对齐方式。
说明：
1.该属性默认值为ScrollSnapAlign.NONE。
snapPaginationDimension | Array<Dimension>否设置Scroll组件限位滚动时的限位点，限位点即为Scroll组件能滑动停靠的偏移量。
说明：
1.当属性为Dimension时，表示每页的大小，系统会按照该大小来自动计算每个限位点的位置：如当Dimension为500时，实际的限位点即为[0,500,1000,1500,…]。
2.当属性为Array<Dimension>时，每个Dimension代表限位点的位置。每个Dimension的范围为[0,可滑动距离]，0和可滑动距离的底部自动成为限位点。
3.当该属性不填或者Dimension为小于等于0的输入时，按异常值，无限位滚动处理。当该属性值为Array<Dimension>数组时，数组中的数值必须为单调递增。
4.当输入为百分比时，实际的大小为Scroll组件的视口与百分比数值之积。
enableSnapToStartboolean否在Scroll组件限位滚动模式下，该属性设置为false后，允许Scroll在开头和第一个限位点间自由滑动。
说明：
1.该属性值默认为true。
2.该属性仅当snapPagination属性为Array<Dimension>时生效，不支持Dimension。
enableSnapToEndboolean否在Scroll组件限位滚动模式下，该属性设置为false后，允许Scroll在最后一个限位点和末尾间自由滑动。
说明：
1.该属性值默认为true。
2.该属性仅当snapPagination属性为Array<Dimension>时生效，不支持Dimension。

事件

onScrollFrameBegin9+

onScrollFrameBegin(event: (offset: number, state: ScrollState) => { offsetRemain: number; })

每帧开始滚动时触发，事件参数传入即将发生的滚动量，事件处理函数中可根据应用场景计算实际需要的滚动量并作为事件处理函数的返回值返回，Scroll将按照返回值的实际滚动量进行滚动。

支持offsetRemain为负值。

若通过onScrollFrameBegin事件和scrollBy方法实现容器嵌套滚动，需设置子滚动节点的EdgeEffect为None。如Scroll嵌套List滚动时，List组件的edgeEffect属性需设置为EdgeEffect.None。

触发该事件的条件：

1、滚动组件触发滚动时触发，包括键鼠操作等其他触发滚动的输入设置。
2、调用控制器接口时不触发。
3、越界回弹不触发。
4、拖动滚动条不触发。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名类型必填说明
offsetnumber是即将发生的滑动量，单位vp。
stateScrollState是当前滑动状态。

返回值：

类型说明
{ offsetRemain: number }实际滑动量，单位vp。

onScroll(deprecated)

onScroll(event: (xOffset: number, yOffset: number) => void)

滚动事件回调，返回滚动时水平、竖直方向偏移量，单位vp。

触发该事件的条件 ：

1、滚动组件触发滚动时触发，支持键鼠操作等其他触发滚动的输入设置。

2、通过滚动控制器API接口调用。

3、越界回弹。

从API version12开始废弃不再使用，推荐使用onWillScroll事件替代。

参数：

参数名类型必填说明
xOffsetnumber是每帧滚动时水平方向的偏移量，Scroll的内容向左滚动时偏移量为正，向右滚动时偏移量为负。
单位vp。
yOffsetnumber是每帧滚动时竖直方向的偏移量，Scroll的内容向上滚动时偏移量为正，向下滚动时偏移量为负。
单位vp。

onWillScroll12+

onWillScroll(handler: ScrollOnWillScrollCallback)

滚动事件回调，Scroll滚动前触发。

回调当前帧将要滚动的偏移量和当前滚动状态和滚动操作来源，其中回调的偏移量为计算得到的将要滚动的偏移量值，并非最终实际滚动偏移。可以通过该回调返回值指定Scroll将要滚动的偏移。

触发该事件的条件 ：

1、滚动组件触发滚动时触发，支持键鼠操作等其他触发滚动的输入设置。

2、通过滚动控制器API接口调用。

3、越界回弹。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名类型必填说明
handlerScrollOnWillScrollCallback是Scroll滚动前触发的回调。

onDidScroll12+

onDidScroll(handler: ScrollOnScrollCallback)

滚动事件回调，Scroll滚动时触发。

返回当前帧滚动的偏移量和当前滚动状态。

触发该事件的条件 ：

1、滚动组件触发滚动时触发，支持键鼠操作等其他触发滚动的输入设置。

2、通过滚动控制器API接口调用。

3、越界回弹。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名类型必填说明
handlerScrollOnScrollCallback是Scroll滚动时触发的回调

ScrollOnScrollCallback对象说明

Scroll滚动时触发的回调

参数名类型必填说明
xOffsetnumber是每帧滚动时水平方向的偏移量，Scroll中的内容向左滚动时偏移量为正，向右滚动时偏移量为负。
单位vp。
yOffsetnumber是每帧滚动时竖直方向的偏移量，Scroll中的内容向上滚动时偏移量为正，向下滚动时偏移量为负。
单位vp。
scrollStateScrollState是当前滚动状态。

说明：

若通过onScrollFrameBegin事件和scrollBy方法实现容器嵌套滚动，需设置子滚动节点的EdgeEffect为None。如Scroll嵌套List滚动时，List组件的edgeEffect属性需设置为EdgeEffect.None。

ScrollOnWillScrollCallback12+

type ScrollOnWillScrollCallback = (xOffset: number, yOffset: number, scrollState: ScrollState, scrollSource: ScrollSource) => void | OffsetResult

Scroll滚动前触发的回调

参数名类型必填说明
xOffsetnumber是每帧滚动时水平方向的偏移量，Scroll中的内容向左滚动时偏移量为正，向右滚动时偏移量为负。
单位vp。
yOffsetnumber是每帧滚动时竖直方向的偏移量，Scroll中的内容向上滚动时偏移量为正，向下滚动时偏移量为负。
单位vp。
scrollStateScrollState是当前滚动状态。
scrollSourceScrollSource是当前滚动操作的来源。

返回值：

类型说明
void | OffsetResult返回OffsetResult时按照开发者指定的偏移量滚动；不返回时按回调参数(xOffset，yOffset)滚动。

onScrollEdge

onScrollEdge(event: (side: Edge) => void)

滚动到边缘事件回调。

触发该事件的条件 ：

1、滚动组件滚动到边缘时触发，支持键鼠操作等其他触发滚动的输入设置。
2、通过滚动控制器API接口调用。
3、越界回弹。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名类型必填说明
sideEdge是滚动到的边缘位置。

onScrollEnd(deprecated)

onScrollEnd(event: () => void)

滚动停止事件回调。

触发该事件的条件 ：

1、滚动组件触发滚动后停止，支持键鼠操作等其他触发滚动的输入设置。
2、通过滚动控制器API接口调用后停止，带过渡动效。

该事件从API version 9开始废弃，使用onScrollStop事件替代。

系统能力： SystemCapability.ArkUI.ArkUI.Full

onScrollStart9+

onScrollStart(event: () => void)

滚动开始时触发。手指拖动Scroll或拖动Scroll的滚动条触发的滚动开始时，会触发该事件。使用Scroller滚动控制器触发的带动画的滚动，动画开始时会触发该事件。

触发该事件的条件 ：

1、滚动组件开始滚动时触发，支持键鼠操作等其他触发滚动的输入设置。
2、通过滚动控制器API接口调用后开始，带过渡动效。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

onScrollStop9+

onScrollStop(event: () => void)

滚动停止时触发。手拖动Scroll或拖动Scroll的滚动条触发的滚动，手离开屏幕并且滚动停止时会触发该事件。使用Scroller滚动控制器触发的带动画的滚动，动画停止时会触发该事件。

触发该事件的条件 ：

1、滚动组件触发滚动后停止，支持键鼠操作等其他触发滚动的输入设置。
2、通过滚动控制器API接口调用后开始，带过渡动效。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

onReachStart11+

onReachStart(event: () => void)

Scroll到达起始位置时触发。

Scroll初始化时会触发一次，滚动到起始位置时触发一次。Scroll边缘效果为弹簧效果时，划动经过起始位置时触发一次，回弹回起始位置时再触发一次。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

onReachEnd11+

onReachEnd(event: () => void)

Scroll到达末尾位置时触发。

Scroll边缘效果为弹簧效果时，划动经过末尾位置时触发一次，回弹回末尾位置时再触发一次。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

Scroller

可滚动容器组件的控制器，可以将此组件绑定至容器组件，然后通过它控制容器组件的滚动，同一个控制器不可以控制多个容器组件，目前支持绑定到List、Scroll、ScrollBar、Grid、WaterFlow上。

导入对象

scroller: Scroller = new Scroller()

scrollTo

scrollTo(value: { xOffset: number | string, yOffset: number | string, animation?: { duration?: number, curve?: Curve | ICurve } | boolean })

滑动到指定位置。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

参数：

参数名参数类型必填参数描述
xOffsetnumber | string是水平滑动偏移。
说明：
该参数值不支持设置百分比。
当值小于0时，不带动画的滚动，按0处理。带动画的滚动，默认滚动到起始位置后停止，可通过设置animation参数，使滚动在越界时启动回弹动画。
仅滚动轴为x轴时生效。
yOffsetnumber | string是垂直滑动偏移。
说明：
该参数值不支持设置百分比。
当值小于0时，不带动画的滚动，按0处理。带动画的滚动，默认滚动到起始位置后停止，可通过设置animation参数，使滚动在越界时启动回弹动画。
仅滚动轴为y轴时生效。
animationScrollAnimationOptions12+ | boolean10+否动画配置。
- ScrollAnimationOptions:  自定义滚动动效。
- boolean: 使能默认弹簧动效。
默认值：
ScrollAnimationOptions: { duration: 1000, curve: Curve.Ease, canOverScroll: false }
boolean: false
说明：
当前List、Scroll、Grid、WaterFlow均支持boolean类型和ICurve曲线。
于API12将原来的 {duration?: number, curve?: Curve | ICurve10+ } 抽象为了ScrollAnimationOptions接口，并在其中添加了一个参数canOverScroll。

scrollEdge

scrollEdge(value: Edge, options?: ScrollEdgeOptions)

滚动到容器边缘，不区分滚动轴方向，Edge.Top和Edge.Start表现相同，Edge.Bottom和Edge.End表现相同。 Scroll组件默认有动画，Grid、List、WaterFlow组件默认无动画。

参数：

参数名参数类型必填参数描述
valueEdge是滚动到的边缘位置。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
options12+ ScrollEdgeOptions否设置滚动到边缘位置的模式。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

fling12+

fling(velocity: number)

滚动类组件开启按传入的初始速度进行惯性滚动。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

参数：

参数名参数类型必填参数描述
velocitynumber是惯性滚动的初始速度值。单位：vp/s
说明：
velocity值设置为0，视为异常值，本次滚动不生效。如果值为正数，则向下滚动；如果值为负数，则向上滚动。

错误码：

以下错误码详细介绍

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3. Parameter verification failed.
100004Controller not bound to component.

scrollPage9+

scrollPage(value: { next: boolean }): void

滚动到下一页或者上一页。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

参数：

参数名参数类型必填参数描述
nextboolean是是否向下翻页。true表示向下翻页，false表示向上翻页。

scrollPage(deprecated)

scrollPage(value: { next: boolean, direction?: Axis })

滚动到下一页或者上一页。从API version 9开始, 该接口不再维护，推荐使用 scrollPage9+ 。

参数：

参数名参数类型必填参数描述
nextboolean是是否向下翻页。true表示向下翻页，false表示向上翻页。
directionAxis否设置滚动方向为水平或竖直方向。

currentOffset

currentOffset(): OffsetResult

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

类型描述
OffsetResult11+返回当前的滚动偏移量。
说明：
当scroller控制器未绑定容器组件或者容器组件被异常释放时，currentOffset的返回值为空。

scrollToIndex

scrollToIndex(value: number, smooth?: boolean, align?: ScrollAlign, options?: ScrollToIndexOptions)

滑动到指定Index，支持设置滑动额外偏移量。

开启smooth动效时，会对经过的所有item进行加载和布局计算，当大量加载item时会导致性能问题。

说明：

仅支持Grid、List、WaterFlow组件。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

参数：

参数名参数类型必填参数描述
valuenumber是要滑动到的目标元素在当前容器中的索引值。
说明：
value值设置成负值或者大于当前容器子组件的最大索引值，视为异常值，本次跳转不生效。
smoothboolean否设置滑动到列表项在列表中的索引值时是否有动效，true表示有动效，false表示没有动效。
默认值：false。
alignScrollAlign否指定滑动到的元素与当前容器的对齐方式。
List中的默认值为：ScrollAlign.START。Grid中默认值为：ScrollAlign.AUTO。WaterFlow中的默认值为：ScrollAlign.START。
说明：
仅List、Grid、WaterFlow组件支持该参数。
options12+ScrollToIndexOptions否设置滑动到指定Index的选项，如额外偏移量。

scrollBy9+

scrollBy(dx: Length, dy: Length)

滑动指定距离。

说明：

支持Scroll、List、Grid、WaterFlow组件。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

参数：

参数名参数类型必填参数描述
dxLength是水平方向滚动距离，不支持百分比形式。
dyLength是竖直方向滚动距离，不支持百分比形式。

isAtEnd10+

isAtEnd(): boolean

查询组件是否滚动到底部。

说明：

支持Scroll、List、Grid、WaterFlow组件。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

返回值

类型描述
booleantrue表示组件已经滚动到底部，false表示组件还没滚动到底部。

getItemRect11+

getItemRect(index: number): RectResult

获取子组件的大小位置。

说明：

支持Scroll、List、Grid、WaterFlow组件。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

参数：

参数名参数类型必填参数描述
indexnumber是子组件的索引值。

说明：

  • index必须是当前显示区域显示的子组件的索引值，否则视为非法值。
  • 非法值返回的大小和位置均为0。

返回值：

类型说明
RectResult子组件的大小和相对于组件的位置。
单位：vp。

错误码：

以下错误码详细介绍。

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3. Parameter verification failed.
100004Controller not bound to component.

OffsetResult11+

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

名称类型描述
xOffsetnumber水平滑动偏移;
返回值单位为vp。
yOffsetnumber竖直滑动偏移。
返回值单位为vp。

ScrollAnimationOptions12+

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

参数名参数类型必填参数描述
durationnumber否设置滚动时长。
默认值：1000。
说明：
设置为小于0的值时，按默认值显示。
curveCurve | ICurve10+否设置滚动曲线。
默认值：Curve.Ease。
canOverScrollboolean否设置滚动是否可越界。
默认值：false。
说明：
仅在设置为true，且组件的edgeEffect设置为EdgeEffect.Spring时，滚动能够越界，并在越界时启动回弹动画。

ScrollAlign10+枚举说明

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

名称描述
START首部对齐。指定item首部与List首部对齐。
CENTER居中对齐。指定item主轴方向居中对齐于List。
END尾部对齐。指定item尾部与List尾部对齐。
AUTO自动对齐。
若指定item完全处于显示区，不做调整。否则依照滑动距离最短的原则，将指定item首部对齐或尾部对齐于List,使指定item完全处于显示区。

ScrollToIndexOptions12+对象说明

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

名称类型必填描述
extraOffsetLengthMetrics否滑动到指定Index的额外偏移量。

NestedScrollOptions10+对象说明

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

名称类型必填描述
scrollForwardNestedScrollMode是可滚动组件往末尾端滚动时的嵌套滚动选项。
scrollBackwardNestedScrollMode是可滚动组件往起始端滚动时的嵌套滚动选项。

NestedScrollMode10+枚举说明

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

名称描述
SELF_ONLY只自身滚动，不与父组件联动。
SELF_FIRST自身先滚动，自身滚动到边缘以后父组件滚动。父组件滚动到边缘以后，如果父组件有边缘效果，则父组件触发边缘效果，否则子组件触发边缘效果。
PARENT_FIRST父组件先滚动，父组件滚动到边缘以后自身滚动。自身滚动到边缘后，如果有边缘效果，会触发自身的边缘效果，否则触发父组件的边缘效果。
PARALLEL自身和父组件同时滚动，自身和父组件都到达边缘以后，如果自身有边缘效果，则自身触发边缘效果，否则父组件触发边缘效果。

EdgeEffectOptions11+对象说明

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

参数名类型必填描述
alwaysEnabledboolean是组件内容大小小于组件自身时，设置是否开启滑动效果

OffsetOptions12+对象说明

参数名类型必填描述
xOffsetDimension否水平滑动偏移
默认值：0
yOffsetDimension否垂直滑动偏移
默认值：0

ScrollEdgeOptions12+对象说明

参数名参数类型必填参数描述
velocitynumber否设置滚动到容器边缘的固定速度。如果设置小于等于0的值，参数不生效。
单位： vp/s

示例

示例1

// xxx.ets
import Curves from '@ohos.curves'

@Entry
@Component
struct ScrollExample {
  scroller: Scroller = new Scroller()
  private arr: number[] = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

  build() {
    Stack({ alignContent: Alignment.TopStart }) {
      Scroll(this.scroller) {
        Column() {
          ForEach(this.arr, (item: number) => {
            Text(item.toString())
              .width('90%')
              .height(150)
              .backgroundColor(0xFFFFFF)
              .borderRadius(15)
              .fontSize(16)
              .textAlign(TextAlign.Center)
              .margin({ top: 10 })
          }, (item: string) => item)
        }.width('100%')
      }
      .scrollable(ScrollDirection.Vertical) // 滚动方向纵向
      .scrollBar(BarState.On) // 滚动条常驻显示
      .scrollBarColor(Color.Gray) // 滚动条颜色
      .scrollBarWidth(10) // 滚动条宽度
      .friction(0.6)
      .edgeEffect(EdgeEffect.None)
      .onWillScroll((xOffset: number, yOffset: number, scrollState: ScrollState) => {
        console.info(xOffset + ' ' + yOffset)
      })
      .onScrollEdge((side: Edge) => {
        console.info('To the edge')
      })
      .onScrollStop(() => {
        console.info('Scroll Stop')
      })

      Button('scroll 150')
        .height('5%')
        .onClick(() => { // 点击后下滑指定距离150.0vp
          this.scroller.scrollBy(0, 150)
        })
        .margin({ top: 10, left: 20 })
      Button('scroll 100')
        .height('5%')
        .onClick(() => { // 点击后滑动到指定位置，即下滑100.0vp的距离
          const yOffset: number = this.scroller.currentOffset().yOffset;
          this.scroller.scrollTo({ xOffset: 0, yOffset: yOffset + 100 })
        })
        .margin({ top: 60, left: 20 })
      Button('scroll 100')
        .height('5%')
        .onClick(() => { // 点击后滑动到指定位置，即下滑100.0vp的距离，滑动过程配置有动画
          let curve = Curves.interpolatingSpring(10, 1, 228, 30) //创建一个阶梯曲线
          const yOffset: number = this.scroller.currentOffset().yOffset;
          this.scroller.scrollTo({ xOffset: 0, yOffset: yOffset + 100, animation: { duration: 1000, curve: curve } })
        })
        .margin({ top: 110, left: 20 })
      Button('back top')
        .height('5%')
        .onClick(() => { // 点击后回到顶部
          this.scroller.scrollEdge(Edge.Top)
        })
        .margin({ top: 160, left: 20 })
      Button('next page')
        .height('5%')
        .onClick(() => { // 点击后滑到下一页
          this.scroller.scrollPage({ next: true })
        })
        .margin({ top: 210, left: 20 })
    }.width('100%').height('100%').backgroundColor(0xDCDCDC)
  }
}
ts

示例2

@Entry
@Component
struct NestedScroll {
  @State listPosition: number = 0; // 0代表滚动到List顶部，1代表中间值，2代表滚动到List底部。
  private arr: number[] = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
  private scrollerForScroll: Scroller = new Scroller()
  private scrollerForList: Scroller = new Scroller()

  build() {
    Flex() {
      Scroll(this.scrollerForScroll) {
        Column() {
          Text("Scroll Area")
            .width("100%")
            .height("40%")
            .backgroundColor(0X330000FF)
            .fontSize(16)
            .textAlign(TextAlign.Center)
            .onClick(() => {
              this.scrollerForList.scrollToIndex(5)
            })

          List({ space: 20, scroller: this.scrollerForList }) {
            ForEach(this.arr, (item: number) => {
              ListItem() {
                Text("ListItem" + item)
                  .width("100%")
                  .height("100%")
                  .borderRadius(15)
                  .fontSize(16)
                  .textAlign(TextAlign.Center)
                  .backgroundColor(Color.White)
              }.width("100%").height(100)
            }, (item: string) => item)
          }
          .width("100%")
          .height("50%")
          .edgeEffect(EdgeEffect.None)
          .friction(0.6)
          .onReachStart(() => {
            this.listPosition = 0
          })
          .onReachEnd(() => {
            this.listPosition = 2
          })
          .onScrollFrameBegin((offset: number) => {
            if ((this.listPosition == 0 && offset <= 0) || (this.listPosition == 2 && offset >= 0)) {
              this.scrollerForScroll.scrollBy(0, offset)
              return { offsetRemain: 0 }
            }
            this.listPosition = 1
            return { offsetRemain: offset };
          })

          Text("Scroll Area")
            .width("100%")
            .height("40%")
            .backgroundColor(0X330000FF)
            .fontSize(16)
            .textAlign(TextAlign.Center)
        }
      }
      .width("100%").height("100%")
    }.width('100%').height('100%').backgroundColor(0xDCDCDC).padding(20)
  }
}

示例3

@Entry
@Component
struct StickyNestedScroll {
  @State arr: number[] = []

  @Styles
  listCard() {
    .backgroundColor(Color.White)
    .height(72)
    .width("100%")
    .borderRadius(12)
  }

  build() {
    Scroll() {
      Column() {
        Text("Scroll Area")
          .width("100%")
          .height("40%")
          .backgroundColor('#0080DC')
          .textAlign(TextAlign.Center)
        Tabs({ barPosition: BarPosition.Start }) {
          TabContent() {
            List({ space: 10 }) {
              ForEach(this.arr, (item: number) => {
                ListItem() {
                  Text("item" + item)
                    .fontSize(16)
                }.listCard()
              }, (item: string) => item)
            }.width("100%")
            .edgeEffect(EdgeEffect.Spring)
            .nestedScroll({
              scrollForward: NestedScrollMode.PARENT_FIRST,
              scrollBackward: NestedScrollMode.SELF_FIRST
            })
          }.tabBar("Tab1")

          TabContent() {
          }.tabBar("Tab2")
        }
        .vertical(false)
        .height("100%")
      }.width("100%")
    }
    .edgeEffect(EdgeEffect.Spring)
    .friction(0.6)
    .backgroundColor('#DCDCDC')
    .scrollBar(BarState.Off)
    .width('100%')
    .height('100%')
  }

  aboutToAppear() {
    for (let i = 0; i < 30; i++) {
      this.arr.push(i)
    }
  }
}

示例4

@Entry
@Component
struct Index {
  scroller: Scroller = new Scroller;
  private arr: number[] = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
  build() {
    Scroll(this.scroller) {
      Column() {
        ForEach(this.arr, (item: number) => {
          Text(item.toString())
            .width('90%')
            .height(200)
            .backgroundColor(0xFFFFFF)
            .borderWidth(1)
            .borderColor(Color.Black)
            .borderRadius(15)
            .fontSize(16)
            .textAlign(TextAlign.Center)
        }, (item: string) => item)
      }.width('100%').backgroundColor(0xDCDCDC)
    }
    .backgroundColor(Color.Yellow)
    .height('100%')
    .edgeEffect(EdgeEffect.Spring)
    .scrollSnap({snapAlign:ScrollSnapAlign.START, snapPagination:400, enableSnapToStart:true, enableSnapToEnd:true})
  }
}

示例5

@Entry
@Component
//滚动控制器新增按给定速度执行惯性滚动的函数fling
struct ListExample {
  private arr: number[] = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]
  scrollerForList: Scroller = new Scroller()
  build() {
    Column() {
      Button('Fling-1000')
        .height('5%')
        .onClick(() => {
          this.scrollerForList.fling(-1000)
        })
      Button('Fling3000')
        .height('5%')
        .onClick(() => {
          this.scrollerForList.fling(3000)
        })
      List({ space: 20, initialIndex: 0, scroller: this.scrollerForList }) {
        ForEach(this.arr, (item: number) => {
          ListItem() {
            Text('' + item)
              .width('100%').height(100).fontSize(16)
              .textAlign(TextAlign.Center).borderRadius(10).backgroundColor(0xFFFFFF)
          }
        }, (item: string) => item)
      }
      .listDirection(Axis.Vertical) // 排列方向
      .scrollBar(BarState.Off)
      .friction(0.9)
      .divider({ strokeWidth: 2, color: 0xFFFFFF, startMargin: 20, endMargin: 20 }) // 每行之间的分界线
      .edgeEffect(EdgeEffect.Spring) // 边缘效果设置为Spring
      .width('90%')
    }
    .width('100%')
    .height('100%')
    .backgroundColor(0xDCDCDC)
    .padding({ top: 5 })
  }
}

示例6

该示例实现了按速度700vp/s向Scroll下边缘滚动。

// xxx.ets
import Curves from '@ohos.curves'

@Entry
@Component
struct ScrollExample {
  scroller: Scroller = new Scroller()
  private arr: number[] = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

  build() {
    Stack({ alignContent: Alignment.TopStart }) {
      Scroll(this.scroller) {
        Column() {
          ForEach(this.arr, (item: number) => {
            Text(item.toString())
              .width('90%')
              .height(150)
              .backgroundColor(0xFFFFFF)
              .borderRadius(15)
              .fontSize(16)
              .textAlign(TextAlign.Center)
              .margin({ top: 10 })
          }, (item: string) => item)
        }.width('100%')
      }
      .scrollable(ScrollDirection.Vertical) // 滚动方向纵向
      .scrollBar(BarState.On) // 滚动条常驻显示
      .scrollBarColor(Color.Gray) // 滚动条颜色
      .scrollBarWidth(10) // 滚动条宽度
      .friction(0.6)
      .edgeEffect(EdgeEffect.None)
      .onWillScroll((xOffset: number, yOffset: number, scrollState: ScrollState) => {
        console.info(xOffset + ' ' + yOffset)
      })
      .onScrollEdge((side: Edge) => {
        console.info('To the edge')
      })
      .onScrollStop(() => {
        console.info('Scroll Stop')
      })

      Button('scroll to bottom 700')
        .height('5%')
        .onClick(() => { // 点击后滑到下边缘，速度值是700vp/s
          this.scroller.scrollEdge(Edge.Bottom, { velocity: 700 })
        })
        .margin({ top: 100, left: 20 })
    }.width('100%').height('100%').backgroundColor(0xDCDCDC)
  }
}

星星不闪包退1
关注
专栏目录
Harmony Scroll嵌套容器组件冲突解决
海阔天空
08-12 174
Harmony Scroll嵌套容器组件冲突解决
鸿蒙（HarmonyOS）项目方舟框架（ArkUI）之Scroll容器组件
zy0412326的专栏
03-05 1418
鸿蒙（HarmonyOS）项目方舟框架（ArkUI）之Scroll容器组件。
鸿蒙开发 - Scroll组件
SSY_1992的博客
12-12 3673
是指在不同尺寸设备下，当页面的内容超出屏幕大小而无法完全显示时，可以通过滚动条进行拖动展示。这种方法适用于线性布局中内容无法一屏展示的场景。通常有以下两种实现方式。1.在List中添加滚动条：当List子项过多一屏放不下时，可以将每一项子元素放置在不同的组件中，通过滚动条进行拖动展示。可以通过scrollBar属性设置滚动条的常驻状态，edgeEffect属性设置拖动到内容最末端的回弹效果。2.使用Scroll组件：在线性布局中，开发者可以进行垂直方向或者水平方向的布局。当一屏无法完全显示时，可以在。
鸿蒙HarmonyOS开发：Scroll组件结合属性动画实现导航背景色切换效果
在这里，我乐于倾囊相授，分享我的技术心得、项目实战经验、技术技巧。希望能够惠及更多的开发者，助力大家在技术的海洋中扬帆远航。
05-21 1634
支持的属性包括width、height、backgroundColor、opacity、scale、rotate、translate等。可滚动容器组件的控制器，可以将此组件绑定至容器组件，然后通过它控制容器组件的滚动，同一个控制器不可以控制多个容器组件，目前支持绑定到List、Scroll、ScrollBar、Grid、WaterFlow上。可滚动的容器组件，当子组件的布局尺寸超过父组件的尺寸时，内容可以滚动。1、滚动组件触发滚动时触发，支持键鼠操作等其他触发滚动的输入设置。
鸿蒙Harmony应用开发—ArkTS声明式开发（容器组件：Scroll）
m0_64420071的博客
03-16 5013
ArkTS声明式开发（容器组件：Scroll）
关于鸿蒙开发中滚动容器Scroll的介绍
最新发布
qq_45569925的博客
08-17 1325
当子组件的布局尺寸超过Scroll的尺寸时，内容可以滚动。
鸿蒙Harmony应用开发—ArkTS声明式开发（容器组件：List）
m0_64420071的博客
03-15 2488
ArkTS声明式开发（容器组件：List）
鸿蒙Harmony应用开发—ArkTS声明式开发（容器组件：Grid）
m0_64420071的博客
03-15 1907
ArkTS声明式开发（容器组件：Grid）
鸿蒙Harmony应用开发—ArkTS声明式开发（容器组件：WaterFlow）
m0_64420071的博客
03-16 1205
ArkTS声明式开发（容器组件：WaterFlow）
鸿蒙Harmony应用开发—ArkTS声明式开发（通用属性：焦点控制）
m0_64420071的博客
03-04 1522
ArkTS声明式开发（通用属性：焦点控制）
HarmonyOS ArkUI滚动类组件-Scroll、Scroller
1
04-22 3975
(scroller?scroller：给Scroll绑定一个滚动控制器，该控制器可以控制子组件的各种滚动能力，Scroller目前只支持绑定到Scroll和List。Scroll() {Text('Text1')// 子组件的高度小于Scroll高度，不会触发滚动scrollable：设置Scroll的滚动方向，提供了以下 3 种滚动方向：Vertical（默认值）：仅支持竖直方向滚动。Scroll() {// Scroll没有设置滚动方向，默认竖直方向滚动Column() {
【鸿蒙开发】系统组件Scroll
d312697510的博客
04-07 700
鸿蒙开发arkui组件，scroll组件
HarmonyOS应用开发：Scroll（容器组件）
situnanQAQ的博客
06-18 1565
可滚动的容器组件，当子组件的布局尺寸超过父组件的尺寸时，内容可以滚动。
HarmonyOS ArkUI滚动类组件-List、ListItem
1
04-22 2880
List 是很常用的滚动类容器组件之一，它按照水平或者竖直方向线性排列子组件， List 的子组件必须是 ListItem ，它的宽度默认充满 List 的宽度。
鸿蒙OS应用开发之——Java UI框架-常用组件ScrollView
我的博客
01-07 1051
一 概述 ScrollView是一种带滚动功能的组件，它采用滑动的方式在有限的区域内显示更多的内容。 创建ScrollView 设置ScrollView 二 创建ScrollView 2.1 XML创建ScrollView <?xml version="1.0" encoding="utf-8"?> <DirectionalLayout xmlns:ohos="http://schemas.huawei.com/res/ohos" ohos:height="match
鸿蒙两个Scroll互相监听彼此的滑动-卡顿问题
坚果的博客
09-22 5386
flag=false 代表手指在滑动 Scroll2，不用再用 scroller2.scrollBy 滑动 Scroll2 了；flag=true 代表手指在滑动 Scroll1，不用再用 scroller1.scrollBy 滑动 Scroll1 了；③调用 scroller2.scrollBy 滑动 Scroll2。⑤调用 scroller1.scrollBy 滑动 Scroll1。②触发 Scroll1 的 onScroll。④触发 Scroll2 的 onScroll。①手指滑动 Scroll1。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值