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.
class RefreshableList extends Component {
constructor(props) {
super(props);
this.state = {
refreshing: false,
};
}
_onRefresh = () => {
this.setState({refreshing: true});
fetchData().then(() => {
this.setState({refreshing: false});
});
}
render() {
return (
<ScrollView
refreshControl={
<RefreshControl
refreshing={this.state.refreshing}
onRefresh={this._onRefresh}
/>
}
...
/>
);
}
...
}
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
Whether the view should be indicating an active refresh.
Called when the view starts refreshing.
The colors (at least one) that will be used to draw the refresh indicator.
| Type | Required | Platform |
|---|
| array of color | No | Android |
Whether the pull to refresh functionality is enabled.
| Type | Required | Platform |
|---|
| bool | No | Android |
The background color of the refresh indicator.
| Type | Required | Platform |
|---|
| color | No | Android |
Progress view top offset
| Type | Required | Platform |
|---|
| number | No | Android |
Size of the refresh indicator, see RefreshControl.SIZE.
| Type | Required | Platform |
|---|
| enum(RefreshLayoutConsts.SIZE.DEFAULT, RefreshLayoutConsts.SIZE.LARGE) | No | Android |
The color of the refresh indicator.
| Type | Required | Platform |
|---|
| color | No | iOS |
The title displayed under the refresh indicator.
| Type | Required | Platform |
|---|
| string | No | iOS |
Title color.
| Type | Required | Platform |
|---|
| color | No | iOS |