FlatList #

A performant interface for rendering simple, flat lists, supporting the most handy features:

  • Fully cross-platform.
  • Optional horizontal mode.
  • Configurable viewability callbacks.
  • Header support.
  • Footer support.
  • Separator support.
  • Pull to Refresh.
  • Scroll loading.

If you need section support, use <SectionList>.

Minimal Example:

<FlatList data={[{key: 'a'}, {key: 'b'}]} renderItem={({item}) => <Text>{item.key}</Text>} />

This is a convenience wrapper around <VirtualizedList>, and thus inherits the following caveats:

  • Internal state is not preserved when content scrolls out of the render window. Make sure all your data is captured in the item data or external stores like Flux, Redux, or Relay.
  • This is a PureComponent which means that it will not re-render if props remain shallow- equal. Make sure that everything your renderItem function depends on is passed as a prop that is not === after updates, otherwise your UI may not update on changes. This includes the data prop and parent component state.
  • In order to constrain memory and enable smooth scrolling, content is rendered asynchronously offscreen. This means it's possible to scroll faster than the fill rate ands momentarily see blank content. This is a tradeoff that can be adjusted to suit the needs of each application, and we are working on improving it behind the scenes.
  • By default, the list looks for a key prop on each item and uses that for the React key. Alternatively, you can provide a custom keyExtractor prop.

Props #

ItemSeparatorComponent?: ?ReactClass<any> #

Rendered in between each item, but not at the top or bottom.

ListFooterComponent?: ?ReactClass<any> #

Rendered at the bottom of all the items.

ListHeaderComponent?: ?ReactClass<any> #

Rendered at the top of all the items.

columnWrapperStyle?: StyleObj #

Optional custom style for multi-item rows generated when numColumns > 1

data: ?Array<ItemT> #

For simplicity, data is just a plain array. If you want to use something else, like an immutable list, use the underlying VirtualizedList directly.

getItem?: #

getItemCount?: #

getItemLayout?: (data: ?Array<ItemT>, index: number) => {length: number, offset: number, index: number} #

getItemLayout is an optional optimizations that let us skip measurement of dynamic content if you know the height of items a priori. getItemLayout is the most efficient, and is easy to use if you have fixed height items, for example:

getItemLayout={(data, index) => ( {length: ITEM_HEIGHT, offset: ITEM_HEIGHT * index, index} )}

Remember to include separator length (height or width) in your offset calculation if you specify ItemSeparatorComponent.

horizontal?: ?boolean #

If true, renders items next to each other horizontally instead of stacked vertically.

keyExtractor: (item: ItemT, index: number) => string #

Used to extract a unique key for a given item at the specified index. Key is used for caching and as the react key to track item re-ordering. The default extractor checks item.key, then falls back to using the index, like React does.

legacyImplementation?: ?boolean #

numColumns: number #

Multiple columns can only be rendered with horizontal={false}`` and will zig-zag like aflexWrap` layout. Items should all be the same height - masonry layouts are not supported.

onEndReached?: ?(info: {distanceFromEnd: number}) => void #

Called once when the scroll position gets within onEndReachedThreshold of the rendered content.

onEndReachedThreshold?: ?number #

onRefresh?: ?() => void #

If provided, a standard RefreshControl will be added for "Pull to Refresh" functionality. Make sure to also set the refreshing prop correctly.

onViewableItemsChanged?: ?(info: {viewableItems: Array<ViewToken>, changed: Array<ViewToken>}) => void #

Called when the viewability of rows changes, as defined by the viewablePercentThreshold prop.

refreshing?: ?boolean #

Set this true while waiting for new data from a refresh.

renderItem: (info: {item: ItemT, index: number}) => ?React.Element<any> #

Takes an item from data and renders it into the list. Typical usage:

_renderItem = ({item}) => ( <TouchableOpacity onPress={() => this._onPress(item)}> <Text>{item.title}}</Text> </TouchableOpacity> ); ... <FlatList data={[{title: 'Title Text', key: 'item1'}]} renderItem={this._renderItem} />

Provides additional metadata like index if you need it.

viewabilityConfig?: ViewabilityConfig #

See ViewabilityHelper for flow type and further documentation.

Methods #

scrollToEnd(params?: object) #

Scrolls to the end of the content. May be janky without getItemLayout prop.

scrollToIndex(params: object) #

Scrolls to the item at a the specified index such that it is positioned in the viewable area such that viewPosition 0 places it at the top, 1 at the bottom, and 0.5 centered in the middle.

May be janky without getItemLayout prop.

scrollToItem(params: object) #

Requires linear scan through data - use scrollToIndex instead if possible. May be janky without getItemLayout prop.

scrollToOffset(params: object) #

Scroll to a specific content pixel offset, like a normal ScrollView.

recordInteraction() #

Tells the list an interaction has occured, which should trigger viewability calculations, e.g. if waitForInteractions is true and the user has not scrolled. This is typically called by taps on items or by navigation actions.

You can edit the content above on GitHub and send us a pull request!

Examples #

Edit on GitHub
'use strict'; const React = require('react'); const ReactNative = require('react-native'); const { Animated, FlatList, StyleSheet, View, } = ReactNative; const UIExplorerPage = require('./UIExplorerPage'); const infoLog = require('infoLog'); const { FooterComponent, HeaderComponent, ItemComponent, PlainInput, SeparatorComponent, genItemData, getItemLayout, pressItem, renderSmallSwitchOption, } = require('./ListExampleShared'); const AnimatedFlatList = Animated.createAnimatedComponent(FlatList); const VIEWABILITY_CONFIG = { minimumViewTime: 3000, viewAreaCoveragePercentThreshold: 100, waitForInteraction: true, }; class FlatListExample extends React.PureComponent { static title = '<FlatList>'; static description = 'Performant, scrollable list of data.'; state = { data: genItemData(1000), debug: false, horizontal: false, filterText: '', fixedHeight: true, logViewable: false, virtualized: true, }; _onChangeFilterText = (filterText) => { this.setState({filterText}); }; _onChangeScrollToIndex = (text) => { this._listRef.getNode().scrollToIndex({viewPosition: 0.5, index: Number(text)}); }; _scrollPos = new Animated.Value(0); _scrollSinkX = Animated.event( [{nativeEvent: { contentOffset: { x: this._scrollPos } }}], {useNativeDriver: true}, ); _scrollSinkY = Animated.event( [{nativeEvent: { contentOffset: { y: this._scrollPos } }}], {useNativeDriver: true}, ); componentDidUpdate() { this._listRef.getNode().recordInteraction(); // e.g. flipping logViewable switch } render() { const filterRegex = new RegExp(String(this.state.filterText), 'i'); const filter = (item) => ( filterRegex.test(item.text) || filterRegex.test(item.title) ); const filteredData = this.state.data.filter(filter); return ( <UIExplorerPage noSpacer={true} noScroll={true}> <View style={styles.searchRow}> <View style={styles.options}> <PlainInput onChangeText={this._onChangeFilterText} placeholder="Search..." value={this.state.filterText} /> <PlainInput onChangeText={this._onChangeScrollToIndex} placeholder="scrollToIndex..." /> </View> <View style={styles.options}> {renderSmallSwitchOption(this, 'virtualized')} {renderSmallSwitchOption(this, 'horizontal')} {renderSmallSwitchOption(this, 'fixedHeight')} {renderSmallSwitchOption(this, 'logViewable')} {renderSmallSwitchOption(this, 'debug')} <Animated.View style={[styles.spindicator, { transform: [ {rotate: this._scrollPos.interpolate({ inputRange: [0, 5000], outputRange: ['0deg', '360deg'], extrapolate: 'extend', })} ] }]} /> </View> </View> <SeparatorComponent /> <AnimatedFlatList ItemSeparatorComponent={SeparatorComponent} ListHeaderComponent={HeaderComponent} ListFooterComponent={FooterComponent} data={filteredData} debug={this.state.debug} disableVirtualization={!this.state.virtualized} getItemLayout={this.state.fixedHeight ? this._getItemLayout : undefined } horizontal={this.state.horizontal} key={(this.state.horizontal ? 'h' : 'v') + (this.state.fixedHeight ? 'f' : 'd') } legacyImplementation={false} numColumns={1} onRefresh={this._onRefresh} onScroll={this.state.horizontal ? this._scrollSinkX : this._scrollSinkY} onViewableItemsChanged={this._onViewableItemsChanged} ref={this._captureRef} refreshing={false} renderItem={this._renderItemComponent} shouldItemUpdate={this._shouldItemUpdate} viewabilityConfig={VIEWABILITY_CONFIG} /> </UIExplorerPage> ); } _captureRef = (ref) => { this._listRef = ref; }; _getItemLayout = (data: any, index: number) => { return getItemLayout(data, index, this.state.horizontal); }; _onRefresh = () => alert('onRefresh: nothing to refresh :P'); _renderItemComponent = ({item}) => { return ( <ItemComponent item={item} horizontal={this.state.horizontal} fixedHeight={this.state.fixedHeight} onPress={this._pressItem} /> ); }; _shouldItemUpdate(prev, next) { /** * Note that this does not check state.horizontal or state.fixedheight * because we blow away the whole list by changing the key in those cases. * Make sure that you do the same in your code, or incorporate all relevant * data into the item data, or skip this optimization entirely. */ return prev.item !== next.item; } // This is called when items change viewability by scrolling into or out of // the viewable area. _onViewableItemsChanged = (info: { changed: Array<{ key: string, isViewable: boolean, item: any, index: ?number, section?: any, }> } ) => { // Impressions can be logged here if (this.state.logViewable) { infoLog( 'onViewableItemsChanged: ', info.changed.map((v) => ({...v, item: '...'})), ); } }; _pressItem = (key: number) => { this._listRef.getNode().recordInteraction(); pressItem(this, key); }; _listRef: FlatList<*>; } const styles = StyleSheet.create({ options: { flexDirection: 'row', flexWrap: 'wrap', alignItems: 'center', }, searchRow: { paddingHorizontal: 10, }, spindicator: { marginLeft: 'auto', width: 2, height: 16, backgroundColor: 'darkgray', }, }); module.exports = FlatListExample;