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 |