RefreshControl
This component is used inside a ScrollView or ListView to add pull to refresh functionality. When the ScrollView is at scrollY: 0, swiping down triggers an onRefresh event.
Exampleβ
refreshing is a controlled prop, this is why it needs to be set to true in the onRefresh function otherwise the refresh indicator will stop immediately.
Reference
Propsβ
View Props β
Inherits View Props.
Requiredrefreshingβ
Whether the view should be indicating an active refresh.
| Type |
|---|
| boolean |
colors Androidβ
The colors (at least one) that will be used to draw the refresh indicator.
| Type |
|---|
| array of colors |
enabled Androidβ
Whether the pull to refresh functionality is enabled.
| Type | Default |
|---|---|
| boolean | true |
onRefreshβ
Called when the view starts refreshing.
| Type |
|---|
| function |
progressBackgroundColor Androidβ
The background color of the refresh indicator.
| Type |
|---|
| color |
progressViewOffsetβ
Progress view top offset.
| Type | Default |
|---|---|
| number | 0 |
size Androidβ
Size of the refresh indicator.
| Type | Default |
|---|---|
enum('default', 'large') | 'default' |
tintColor iOSβ
The color of the refresh indicator.
| Type |
|---|
| color |
title iOSβ
The title displayed under the refresh indicator.
| Type |
|---|
| string |
titleColor iOSβ
The color of the refresh indicator title.
| Type |
|---|
| color |