Scroll

可滾動的容器組件，當(dāng)子組件的布局尺寸超過父組件的尺寸時(shí)，內(nèi)容可以滾動。

說明：
開發(fā)前請熟悉鴻蒙開發(fā)指導(dǎo)文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

• 該組件從API version 7開始支持。后續(xù)版本如有新增內(nèi)容，則采用上角標(biāo)單獨(dú)標(biāo)記該內(nèi)容的起始版本。
• 該組件嵌套List子組件滾動時(shí)，若List不設(shè)置寬高，則默認(rèn)全部加載，在對性能有要求的場景下建議指定List的寬高。
• 該組件滾動的前提是主軸方向大小小于內(nèi)容大小。
• 該組件回彈的前提是要有滾動。內(nèi)容小于一屏?xí)r，沒有回彈效果。

子組件

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

接口

Scroll(scroller?: Scroller)

參數(shù)：

屬性

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

ScrollDirection枚舉說明

事件

說明：

若通過onScrollFrameBegin事件和scrollBy方法實(shí)現(xiàn)容器嵌套滾動，需設(shè)置子滾動節(jié)點(diǎn)的EdgeEffect為None。如Scroll嵌套List滾動時(shí)，List組件的edgeEffect屬性需設(shè)置為EdgeEffect.None。

Scroller

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

導(dǎo)入對象

scroller: Scroller = new Scroller()

scrollTo

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

滑動到指定位置。

參數(shù)：

scrollEdge

scrollEdge(value: Edge): void

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

參數(shù)：

scrollPage

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

滾動到下一頁或者上一頁。

參數(shù)：

currentOffset

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

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

返回值

scrollToIndex

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

滑動到指定Index。

開啟smooth動效時(shí)，會對經(jīng)過的所有item進(jìn)行加載和布局計(jì)算，當(dāng)大量加載item時(shí)會導(dǎo)致性能問題。

說明：

僅支持Grid、List、WaterFlow組件。

參數(shù)：

scrollBy9+

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

滑動指定距離。

說明：

僅支持Scroll、ScrollBar、Grid、List組件。

參數(shù)：

isAtEnd10+

isAtEnd(): boolean

查詢組件是否滾動到底部。

說明：

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

返回值

ScrollAlign枚舉說明10+

示例

示例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)
      .onScroll((xOffset: number, yOffset: number) = > {
        console.info(xOffset + ' ' + yOffset)
      })
      .onScrollEdge((side: Edge) = > {
        console.info('To the edge')
      })

      Button('scroll 150')
        .height('5%')
        .onClick(() = > { // 點(diǎn)擊后下滑指定距離150.0vp
          this.scroller.scrollBy(0,150)
        })
        .margin({ top: 10, left: 20 })
      Button('scroll 100')
        .height('5%')
        .onClick(() = > { // 點(diǎn)擊后滑動到指定位置，即下滑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(() = > { // 點(diǎn)擊后滑動到指定位置，即下滑100.0vp的距離，滑動過程配置有動畫
          let curve = Curves.interpolatingSpring(100, 1, 228, 30) //創(chuàng)建一個(gè)階梯曲線
          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(() = > { // 點(diǎn)擊后回到頂部
          this.scroller.scrollEdge(Edge.Top)
        })
        .margin({ top: 160, left: 20 })
      Button('next page')
        .height('5%')
        .onClick(() = > { // 點(diǎn)擊后滑到下一頁
          this.scroller.scrollPage({ next: true })
        })
        .margin({ top: 210, left: 20 })
    }.width('100%').height('100%').backgroundColor(0xDCDCDC)
  }
}

示例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)
  }
}

審核編輯 黃宇