Scroll
作为可滚动的容器类组件,它最多包含一个子组件,当子组件的布局尺寸在指定的滚动方向上超过 Scroll
的视图窗口时,子组件可以滚动, Scroll
滚动方向只支持水平滚动和竖直滚动。 Scroller
作为滚动组件的控制器,它可以控制滚动组件的一些行为,比如滚动到特定位置,滚动到边界等。
Scroll定义介绍
代码语言:ts复制interface ScrollInterface {
(scroller?: Scroller): ScrollAttribute;
}
- scroller:给
Scroll
绑定一个滚动控制器,该控制器可以控制子组件的各种滚动能力,Scroller
目前只支持绑定到Scroll
和List
。
简单样例如下所示:
代码语言:ts复制Scroll() {
Text('Text1')// 子组件的高度小于Scroll高度,不会触发滚动
.fontSize(26)
.size({width: 180, height: 40})
.backgroundColor('#aabbcc')
}
.width('100%')
.height(100)
.backgroundColor(Color.Pink)
Scroll属性介绍
代码语言:ts复制declare class ScrollAttribute<T> extends CommonMethod<T> {
scrollable(value: ScrollDirection): T;
scrollBar(barState: BarState): T;
scrollBarColor(color: Color | number | string): T;
scrollBarWidth(value: number | string): T;
edgeEffect(edgeEffect: EdgeEffect): T;
}
- scrollable:设置
Scroll
的滚动方向,ScrollDirection
提供了以下 3 种滚动方向:- Vertical(默认值):仅支持竖直方向滚动。
Scroll() {// Scroll没有设置滚动方向,默认竖直方向滚动
Column() {
Text('Text1')
.fontSize(26)
.size({width: 180, height: 90})
.backgroundColor('#aabbcc')
Text('Text2')
.fontSize(26)
.size({width: 180, height: 90})
.backgroundColor('#bbccaa')
Text('Text3')
.fontSize(26)
.size({width: 180, height: 90})
.backgroundColor('#ccaabb')
Text('Text4')
.fontSize(26)
.size({width: 180, height: 90})
.backgroundColor('#abcabc')
}
.width('100%')
}
.width(230)
.height(200)
.backgroundColor(Color.Pink)
- Horizontal:仅支持水平方向滚动。
Scroll() {
Row() {
Text('Text1')
.fontSize(26)
.size({width: 180, height: 90})
.backgroundColor('#aabbcc')
Text('Text2')
.fontSize(26)
.size({width: 180, height: 90})
.backgroundColor('#bbccaa')
Text('Text3')
.fontSize(26)
.size({width: 180, height: 90})
.backgroundColor('#ccaabb')
Text('Text4')
.fontSize(26)
.size({width: 180, height: 90})
.backgroundColor('#abcabc')
}
.height("100%")
}
.scrollable(ScrollDirection.Horizontal)// 设置滚动条水平方向滚动
.width(230)
.height(170)
.backgroundColor(Color.Pink)
- None:不可滚动。子组件即使超界了,也不能滚动。
- scrollBar:设置滚动条状态,
BarState
定义了以下 3 种状态:- Off:不显示滚动条。
- On:一直显示滚动条。
- Auto:按需显示(触摸时显示,2s后消失)。
- scrollBarColor、scrollBarWidth:设置滚动条的颜色和宽度,
简单样例如下所示:
代码语言:ts复制 Scroll() {
Column() {
Text('Text1')
.fontSize(26)
.size({width: 180, height: 90})
.backgroundColor('#aabbcc')
Text('Text2')
.fontSize(26)
.size({width: 180, height: 90})
.backgroundColor('#bbccaa')
Text('Text3')
.fontSize(26)
.size({width: 180, height: 90})
.backgroundColor('#ccaabb')
Text('Text4')
.fontSize(26)
.size({width: 180, height: 90})
.backgroundColor('#abcabc')
}
}
.scrollable(ScrollDirection.Vertical) // 竖直滚动
.scrollBarColor(Color.Green) // 设置滚动条颜色
.scrollBarWidth(20) // 设置滚动条宽度
.scrollBar(BarState.On) // 设置滚动条永久显示
.width(230)
.height(170)
.backgroundColor(Color.Pink)
Scroll事件介绍
代码语言:ts复制declare class ScrollAttribute<T> extends CommonMethod<T> {
onScroll(event: (xOffset: number, yOffset: number) => void): T;
onScrollEdge(event: (side: Edge) => void): T;
onScrollEnd(event: () => void): T;
}
- onScroll:滚动事件回调, 返回滚动时水平、竖直方向的偏移量。
- onScrollEdge:滚动到边缘事件回调。
- onScrollEnd:滚动停止事件回调。
Scroller简单介绍
Scroller
作为滚动容器组件的控制器,它提供了滚动子组件的各种能力,比如设置子组件滚动指定位置、滚动到底部以及滚动到下一页上一页等能力。目前 Scrolller
只支持绑定到 Scroll
和 List
上。
Scroller
定义如下:
export declare class Scroller {
scrollTo(value: {
xOffset: number | string, yOffset: number | string, animation?: { duration: number, curve: Curve }
});
scrollEdge(value: Edge);
scrollPage(value: { next: boolean, direction?: Axis });
currentOffset();
scrollToIndex(value: number);
}
- scrollTo:设置子组件滚动到指定位置,在滚动的时候还可以根据
animation
参数设置动画。 - scrollEdge:滚动到边界,
Edge
提供了多种类型,读者可自行查阅。 - scrollPage:滚动到上一页或者下一页。
- currentOffset:获取当前滚动的偏移量。
- scrollToIndex:滚动到指定下标,目前只支持
List
。
完整样例
Scroll
结合 Scrollerr
完整样例如下所示:
@Entry @Component struct ComponentTest {
private scroller: Scroller = new Scroller(); // 创建一个滚动控制器
private scrollDistance: number = 0;
private items: number[] = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
build() {
Column() {
Scroll(this.scroller) { // 绑定滚动控制器
Column() {
ForEach(this.items, (item) => { // ForEach语法循环创建子组件
Text("index: " item)
.fontSize(26)
.width('90%')
.height(120)
.borderRadius(10)
.backgroundColor(Color.White)
.margin({top: 10})
})
}
.width("100%")
}
.scrollable(ScrollDirection.Vertical) // 设置竖直方向滚动
.scrollBarColor(Color.Green) // 设置滚动条颜色
.scrollBarWidth(20) // 设置滚动条宽度
.scrollBar(BarState.On) // 设置滚动条永久显示
.width('100%')
.height(220)
.padding({top: 10, bottom: 10})
.backgroundColor(Color.Pink)
Flex({direction: FlexDirection.Row, wrap: FlexWrap.NoWrap, justifyContent: FlexAlign.SpaceBetween}) {
Button('scrollTo')
.onClick(() => {
this.scrollDistance = this.scrollDistance == 0 ? 280 : 0;
this.scroller.scrollTo({ // 调用scrollTo滚动到具体位置
xOffset: 180, // 竖直方向滚动,该值不起作用
yOffset: this.scrollDistance, // 滚动距离
animation: { // 滚动动画
duration: 1500,
curve: Curve.Smooth
}
})
})
Button('scrollEdge')
.onClick(() => {
this.scroller.scrollEdge(Edge.End) // 滚动到底部
})
Button('scrollPage')
.onClick(() => {
this.scroller.scrollPage({ // 滚动到下一页
next: true,
direction: Axis.Vertical
})
})
}
.width('100%')
.margin({top: 10})
}
.alignItems(HorizontalAlign.Center)
.width('100%')
.height(('100%'))
.padding(20)
}
}
写在最后
如果你觉得这篇内容对你还蛮有帮助,我想邀请你帮我三个小忙:
- 点赞,转发,有你们的 『点赞和评论』,才是我创造的动力;
- 关注小编,同时可以期待后续文章ing