@ohos.arkui.advanced.SwipeRefresher (Swipe Refresher)
The swipe refresher is a component used to obtain and load content, typically with a pull-down gesture.
NOTE
This component and its child components are supported since API version 10. Updates will be marked with a superscript to indicate their earliest API version.
Modules to Import
import { SwipeRefresher } from '@ohos.arkui.advanced.SwipeRefresher'
Child Components
Not supported
Attributes
The universal attributes are supported.
SwipeRefresher
SwipeRefresher ({content?: string, isLoading: boolean})
Decorator: @Component
System capability: SystemCapability.ArkUI.ArkUI.Full
Parameters
Name | Type | Mandatory | Decorator | Description |
---|---|---|---|---|
content | string | No | @Prop | Text displayed when the content is loaded. |
isLoading | boolean | If yes, | @Prop | Whether content is being loaded. The value true means that content is being loaded, and false means the opposite. |
Events
The universal events are supported.
Example
import { SwipeRefresher } from '@ohos.arkui.advanced.SwipeRefresher';
@Entry
@Component
struct Index {
build() {
Column() {
SwipeRefresher({
content: 'Loading',
isLoading: true
})
SwipeRefresher({
content: '',
isLoading: true
})
SwipeRefresher({
content: 'Loading',
isLoading: false
})
}
}
}