Refresh


Refresh

可以进行页面下拉操作并显示刷新动效的容器组件。

说明:

该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

子组件

支持单个子组件。

接口

Refresh(value: { refreshing: boolean, offset?: number | string , friction?: number | string })

参数:

参数 参数名 必填 参数描述
refreshing boolean 当前组件是否正在刷新。
该参数支持$$双向绑定变量。
offset string | number 刷新组件静止时距离父组件顶部的距离。
默认值:16,单位vp
friction number | string 下拉摩擦系数,取值范围为0到100。
默认值:62
- 0表示下拉刷新容器不跟随手势下拉而下拉。
- 100表示下拉刷新容器紧紧跟随手势下拉而下拉。
- 数值越大,下拉刷新容器跟随手势下拉的反应越灵敏。

事件

名称 描述
onStateChange(callback: (state: RefreshStatus) => void) 当前刷新状态变更时,触发回调。
- state:刷新状态。
onRefreshing(callback: () => void) 进入刷新状态时触发回调。

RefreshStatus枚举说明

名称 描述
Inactive 默认未下拉状态。
Drag 下拉中,下拉距离小于刷新距离。
OverDrag 下拉中,下拉距离超过刷新距离。
Refresh 下拉结束,回弹至刷新距离,进入刷新状态。
Done 刷新结束,返回初始状态(顶部)。

示例

// xxx.ets
@Entry
@Component
struct RefreshExample {
  @State isRefreshing: boolean = false
  @State counter: number = 0

  build() {
    Column() {
      Refresh({ refreshing: $$this.isRefreshing, offset: 120, friction: 100 }) {
        Text('Pull Down and refresh: ' + this.counter)
          .fontSize(30)
          .margin(10)
      }
      .onStateChange((refreshStatus: RefreshStatus) => {
        console.info('Refresh onStatueChange state is ' + refreshStatus)
      })
      .onRefreshing(() => {
        setTimeout(() => {
          this.counter++
          this.isRefreshing = false
        }, 1000)
        console.log('onRefreshing test')
      })
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27