鸿蒙ArkTS容器组件:【Scroll】

Scroll

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

说明:
开发前请熟悉鸿蒙开发指导文档gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md点击或者复制转到。

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

子组件

支持单个子组件。

接口

Scroll(scroller?: Scroller)

参数:

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

属性

除支持[通用属性]外,还支持以下属性:

名称 参数类型 描述
scrollable [ScrollDirection] 设置滚动方向。 默认值:ScrollDirection.Vertical
scrollBar [BarState] 设置滚动条状态。 默认值:BarState.Auto 说明: 如果容器组件无法滚动,则滚动条不显示。如果容器组件的子组件大小为无穷大,则滚动条不支持拖动和伴随滚动。
scrollBarColor string number
scrollBarWidth string number
edgeEffect [EdgeEffect] 设置滑动效果,目前支持的滑动效果参见EdgeEffect的枚举说明。 默认值:EdgeEffect.None
enableScrollInteraction10+ boolean 设置是否支持滚动手势,当设置为false时,无法通过手指或者鼠标滚动,但不影响控制器的滚动接口。 默认值:true
friction10+ number [Resource]

ScrollDirection枚举说明

名称 描述
Horizontal 仅支持水平方向滚动。
Vertical 仅支持竖直方向滚动。
None 不可滚动。

事件

名称 功能描述
onScrollFrameBegin9+(event: (offset: number, state: ScrollState) => { offsetRemain }) 每帧开始滚动时触发,事件参数传入即将发生的滚动量,事件处理函数中可根据应用场景计算实际需要的滚动量并作为事件处理函数的返回值返回,Scroll将按照返回值的实际滚动量进行滚动。 - offset:即将发生的滚动量。 - state:当前滚动状态。 - offsetRemain:实际滚动量。 触发该事件的条件 : 1、滚动组件触发滚动时触发,包括键鼠操作等其他触发滚动的输入设置。 2、调用控制器接口时不触发。 3、越界回弹不触发。 说明: 支持offsetRemain为负值。 若通过onScrollFrameBegine事件和scrollBy方法实现容器嵌套滚动,需设置子滚动节点的EdgeEffect为None。如Scroll嵌套List滚动时,List组件的edgeE

你可能感兴趣的:(鸿蒙开发,harmonyos,鸿蒙,鸿蒙开发,OpenHarmony,组件,arkts,程序员)