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 totrue
in theonRefresh
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
Androidβ
Progress view top offset.
Type | Default |
---|---|
number | 0 |
size
Androidβ
Size of the refresh indicator.
Type | Default |
---|---|
RefreshControl.SIZE | RefreshLayoutConsts.SIZE.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 |
Type Definitionsβ
RefreshLayoutConsts.SIZEβ
The SwipeRefreshLayout Android component constants. The actual component size may vary between devices. You can read more about the native component in the Android documentation.
Type |
---|
enum |
Constants:
Name | Type | Value | Description |
---|---|---|---|
DEFAULT | int | 1 | Default RefreshControl size |
LARGE | int | 0 | Large RefreshControl size |