2.1.0 • Published 5 years ago

@foundcareers/react-native-infinite-flatlist v2.1.0

Weekly downloads
6
License
ISC
Repository
github
Last release
5 years ago

InfiniteFlatList

Installation

npm install --save @foundcareers/react-native-infinite-flatlist

Usage

import InfiniteFlatList from 'react-native-infinite-flatlist';


class Items extends React.Component {

    componentDidMount() {
      this._fetchFirstPage();
    }

    ...

    render() {
        ...
        return (
            <InfiniteFlatList
              data={items}
              renderItem={this._renderItem}
              loading={loading}
              refreshing={refreshing}
              onRefresh={this._refreshPage}
              onEndReached={this._fetchNextPage}
              emptyText="No Items"
            />
        );
    }
}

Props

NameTypeDefaultDescription
dataArray An array of data to display.
renderItemFunctionnoopA function that takes an item from data and renders it into the list.
loadingBooleanfalseSet this true while waiting for new data from a page request.
refreshingBooleanfalseSet this true while waiting for new data from a refresh.
onRefreshFunctionnoopA function that is called on Pull to Refresh.
onEndReachedFunctionnoopA function that is called when the end of the list is reached.
onEndReachedThresholdNumber0.75How far from the end (in units of visible length of the list) the bottom edge of the list must be from the end of the content to trigger the onEndReached callback.
emptyTextStringNo dataWhen there is no data this is displayed.
keyExtractorFunction(obj) => obj.idUsed to extract a unique key for a given item at the specified index.
removeClippedSubviewsBooleanfalseThis may improve scroll performance for large lists.

Caveats

The initial data size must be large enough to reach the bottom of the screen, otherwise scroll events won't trigger.