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β
Note: 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β
Inherits View Props.
refreshing
β
Whether the view should be indicating an active refresh.
Type | Required |
---|---|
bool | Yes |
onRefresh
β
Called when the view starts refreshing.
Type | Required |
---|---|
function | No |
colors
β
The colors (at least one) that will be used to draw the refresh indicator.
Type | Required | Platform |
---|---|---|
array of color | No | Android |
enabled
β
Whether the pull to refresh functionality is enabled.
Type | Required | Platform |
---|---|---|
bool | No | Android |
progressBackgroundColor
β
The background color of the refresh indicator.
Type | Required | Platform |
---|---|---|
color | No | Android |
progressViewOffset
β
Progress view top offset
Type | Required | Platform |
---|---|---|
number | No | Android |
size
β
Size of the refresh indicator, see RefreshControl.SIZE.
Type | Required | Platform |
---|---|---|
enum(RefreshLayoutConsts.SIZE.DEFAULT, RefreshLayoutConsts.SIZE.LARGE) | No | Android |
tintColor
β
The color of the refresh indicator.
Type | Required | Platform |
---|---|---|
color | No | iOS |
title
β
The title displayed under the refresh indicator.
Type | Required | Platform |
---|---|---|
string | No | iOS |
titleColor
β
Title color.
Type | Required | Platform |
---|---|---|
color | No | iOS |