滚动组件通用属性和事件目前只支持[List]、[Grid]、[Scroll]和[WaterFlow]组件。
说明
本模块从API version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
属性
scrollBar11+
scrollBar(barState: BarState): T
设置滚动条状态。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
barState | [BarState] | 是 | 滚动条状态。默认值:List、Grid、Scroll组件默认BarState.Auto,WaterFlow组件默认BarState.Off。 |
scrollBarColor11+
scrollBarColor(color: Color | number | string): T
设置滚动条的颜色。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
color | string | number | [Color] |
scrollBarWidth11+
scrollBarWidth(value: number | string): T
设置滚动条的宽度,不支持百分比设置。宽度设置后,滚动条正常状态和按压状态宽度均为滚动条的宽度值。如果滚动条的宽度超过滚动组件主轴方向的高度,则滚动条的宽度会变为默认值。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
value | string | number | 是 |
edgeEffect11+
edgeEffect(edgeEffect: EdgeEffect, options?: EdgeEffectOptions): T
设置边缘滑动效果。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
edgeEffect | [EdgeEffect] | 是 | 滚动组件的边缘滑动效果,支持弹簧效果和阴影效果。默认值:Grid、Scroll、WaterFlow组件默认EdgeEffect.None,List组件默认EdgeEffect.Spring。 |
options | [EdgeEffectOptions] | 否 | 组件内容大小小于组件自身时,是否开启滑动效果。设置为{ alwaysEnabled: true }会开启滑动效果,{ alwaysEnabled: false }不开启。默认值:List、Grid、WaterFlow组件默认{ alwaysEnabled: false },Scroll组件默认{ alwaysEnabled: true } |
nestedScroll11+
nestedScroll(value: NestedScrollOptions): T
设置向前向后两个方向上的嵌套滚动模式,实现与父组件的滚动联动。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
value | [NestedScrollOptions] | 是 | 嵌套滚动选项。 |
enableScrollInteraction11+
enableScrollInteraction(value: boolean): T
设置是否支持滚动手势,当设置为false时,无法通过手指或者鼠标滚动,但不影响控制器的滚动接口。
元服务API: 从