Refresh
可以进行页面下拉操作并显示刷新动效的容器组件。
说明:
开发前请熟悉鸿蒙开发指导文档:gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md
点击或者复制转到。
该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。当设置自定义组件时,自定义组件的高度限制在64vp之内。
子组件
支持单个子组件。
接口
Refresh(value: { refreshing: boolean, offset?: number | string , friction?: number | string, builder?: Custombuilder})
参数:
参数 | 参数名 | 必填 | 参数描述 |
---|---|---|---|
refreshing | boolean | 是 | 当前组件是否正在刷新。 该参数支持[$$]双向绑定变量。 |
offset | string | number | 否 |
friction | number | string | 否 |
builder | [CustomBuilder]10+ | 否 | 下拉时,自定义刷新样式的组件。 |
属性
支持[通用属性]。
事件
除支持[通用事件]外,还支持以下事件:
名称 | 描述 |
---|---|
onStateChange(callback: (state: [RefreshStatus]) => void) | 当前刷新状态变更时,触发回调。 - state:刷新状态。 |
onRefreshing(callback: () => void) | 进入刷新状态时触发回调。 HarmonyOS与OpenHarmony鸿蒙文档籽料:mau123789是v直接拿 |
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')
})
}
}
}