Skip to main content
Version: 0.62

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.

TypeRequired
boolYes

onRefreshโ€‹

Called when the view starts refreshing.

TypeRequired
functionNo

colorsโ€‹

The colors (at least one) that will be used to draw the refresh indicator.

TypeRequiredPlatform
array of colorNoAndroid

enabledโ€‹

Whether the pull to refresh functionality is enabled.

TypeRequiredPlatform
boolNoAndroid

progressBackgroundColorโ€‹

The background color of the refresh indicator.

TypeRequiredPlatform
colorNoAndroid

progressViewOffsetโ€‹

Progress view top offset

TypeRequiredPlatform
numberNoAndroid

sizeโ€‹

Size of the refresh indicator, see RefreshControl.SIZE.

TypeRequiredPlatform
enum(RefreshLayoutConsts.SIZE.DEFAULT, RefreshLayoutConsts.SIZE.LARGE)NoAndroid

tintColorโ€‹

The color of the refresh indicator.

TypeRequiredPlatform
colorNoiOS

titleโ€‹

The title displayed under the refresh indicator.

TypeRequiredPlatform
stringNoiOS

titleColorโ€‹

Title color.

TypeRequiredPlatform
colorNoiOS