滾動(dòng)的容器組件

子組件

支持單個(gè)子組件。

接口

Scroll(scroller?: Scroller)

參數(shù)：

屬性

除支持通用屬性外，還支持以下屬性：

ScrollDirection枚舉說(shuō)明

事件

Scroller

可滾動(dòng)容器組件的控制器，可以將此組件綁定至容器組件，然后通過(guò)它控制容器組件的滾動(dòng)，同一個(gè)控制器不可以控制多個(gè)容器組件，目前支持綁定到List、Scroll、ScrollBar、Grid、WaterFlow上。

導(dǎo)入對(duì)象

scroller: Scroller = new Scroller()

scrollTo

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

滑動(dòng)到指定位置。

參數(shù)：

scrollEdge

scrollEdge(value: Edge): void

滾動(dòng)到容器邊緣，不區(qū)分滾動(dòng)軸方向，Edge.Top和Edge.Start表現(xiàn)相同，Edge.Bottom和Edge.End表現(xiàn)相同。

參數(shù)：

scrollPage

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

滾動(dòng)到下一頁(yè)或者上一頁(yè)。

參數(shù)：

currentOffset

currentOffset(): { xOffset: number, yOffset: number }

返回當(dāng)前的滾動(dòng)偏移量。

返回值

scrollToIndex

scrollToIndex(value: number): void

滑動(dòng)到指定Index。

參數(shù)：

scrollBy9+

scrollBy(dx: Length, dy: Length): void

滑動(dòng)指定距離。

參數(shù)：

示例

示例1

// xxx.ets
@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) => {
            Text(item.toString())
              .width('90%')
              .height(150)
              .backgroundColor(0xFFFFFF)
              .borderRadius(15)
              .fontSize(16)
              .textAlign(TextAlign.Center)
              .margin({ top: 10 })
          }, item => item)
        }.width('100%')
      }
      .scrollable(ScrollDirection.Vertical)  // 滾動(dòng)方向縱向
      .scrollBar(BarState.On)  // 滾動(dòng)條常駐顯示
      .scrollBarColor(Color.Gray)  // 滾動(dòng)條顏色
      .scrollBarWidth(10) // 滾動(dòng)條寬度
      .edgeEffect(EdgeEffect.None)
      .onScroll((xOffset: number, yOffset: number) => {
        console.info(xOffset + ' ' + yOffset)
      })
      .onScrollEdge((side: Edge) => {
        console.info('To the edge')
      })
      .onScrollEnd(() => {
        console.info('Scroll Stop')
      })

      Button('scroll 150')
        .onClick(() => { // 點(diǎn)擊后下滑指定距離150.0vp
          this.scroller.scrollBy(0,150)
        })
        .margin({ top: 10, left: 20 })
      Button('scroll 100')
        .onClick(() => { // 點(diǎn)擊后滑動(dòng)到指定位置，即下滑100.0vp的距離
          this.scroller.scrollTo({ xOffset: 0, yOffset: this.scroller.currentOffset().yOffset + 100 })
        })
        .margin({ top: 60, left: 20 })
      Button('back top')
        .onClick(() => { // 點(diǎn)擊后回到頂部
          this.scroller.scrollEdge(Edge.Top)
        })
        .margin({ top: 110, left: 20 })
      Button('next page')
        .onClick(() => { // 點(diǎn)擊后滑到下一頁(yè)
          this.scroller.scrollPage({ next: true })
        })
        .margin({ top: 170, left: 20 })
    }.width('100%').height('100%').backgroundColor(0xDCDCDC)
  }
}

示例2

@Entry
@Component
struct NestedScroll {
  @State listPosition: number = 0; // 0代表滾動(dòng)到List頂部，1代表中間值，2代表滾動(dòng)到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) => {
              ListItem() {
                Text("ListItem" + item)
                  .width("100%").height("100%").borderRadius(15)
                  .fontSize(16).textAlign(TextAlign.Center).backgroundColor(Color.White)
              }.width("100%").height(100)
            }, item => item)
          }
          .width("100%")
          .height("50%")
          .edgeEffect(EdgeEffect.None)
          .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)
  }
}