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

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

• By binding the onPressItem handler, the props will remain === and PureComponent will prevent wasteful re-renders unless the actual id, selected, or title props change, even if the components rendered in MyListItem did not have such optimizations.
• By passing extraData={this.state} to FlatList we make sure FlatList itself will re-render when the state.selected changes. Without setting this prop, FlatList would not know it needs to re-render any items because it is also a PureComponent and the prop comparison will not show any changes.
• keyExtractor tells the list to use the ids for the react keys instead of the default key property.

class MyListItem extends React.PureComponent {
  _onPress = () => {
    this.props.onPressItem(this.props.id);
  };

  render() {
    const textColor = this.props.selected ? 'red' : 'black';
    return (
      <TouchableOpacity onPress={this._onPress}>
        <View>
          <Text style={{color: textColor}}>{this.props.title}</Text>
        </View>
      </TouchableOpacity>
    );
  }
}

class MultiSelectList extends React.PureComponent {
  state = {selected: (new Map(): Map<string, boolean>)};

  _keyExtractor = (item, index) => item.id;

  _onPressItem = (id: string) => {
    // updater functions are preferred for transactional updates
    this.setState((state) => {
      // copy the map rather than modifying state.
      const selected = new Map(state.selected);
      selected.set(id, !selected.get(id)); // toggle
      return {selected};
    });
  };

  _renderItem = ({item}) => (
    <MyListItem
      id={item.id}
      onPressItem={this._onPressItem}
      selected={!!this.state.selected.get(item.id)}
      title={item.title}
    />
  );

  render() {
    return (
      <FlatList
        data={this.props.data}
        extraData={this.state}
        keyExtractor={this._keyExtractor}
        renderItem={this._renderItem}
      />
    );
  }
}

• 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 (e.g. extraData) 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 and 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

• columnWrapperStyle
• data
• extraData
• getItemLayout
• horizontal
• initialNumToRender
• initialScrollIndex
• inverted
• ItemSeparatorComponent
• keyExtractor
• legacyImplementation
• ListEmptyComponent
• ListFooterComponent
• ListFooterComponentStyle
• ListHeaderComponent
• ListHeaderComponentStyle
• numColumns
• onEndReached
• onEndReachedThreshold
• onRefresh
• onViewableItemsChanged
• progressViewOffset
• refreshing
• renderItem
• removeClippedSubviews
• ScrollView props...
• viewabilityConfig
• viewabilityConfigCallbackPairs
• VirtualizedList props...

Methods

• flashScrollIndicators
• getScrollResponder
• getScrollableNode
• scrollToEnd
• scrollToIndex
• scrollToItem
• scrollToOffset
• recordInteraction

Reference

Props

renderItem

renderItem({item, index, separators});

• item (Object): The item from data being rendered.
• index (number): The index corresponding to this item in the data array.
• separators (Object)

  • highlight (Function)
  • unhighlight (Function)
  • updateProps (Function)

    • select (enum('leading', 'trailing'))
    • newProps (Object)

<FlatList
  ItemSeparatorComponent={Platform.OS !== 'android' && ({highlighted}) => (
    <View style={[style.separator, highlighted && {marginLeft: 0}]} />
  )}
  data={[{title: 'Title Text', key: 'item1'}]}
  renderItem={({item, index, separators}) => (
    <TouchableHighlight
      onPress={() => this._onPress(item)}
      onShowUnderlay={separators.highlight}
      onHideUnderlay={separators.unhighlight}>
      <View style={{backgroundColor: 'white'}}>
        <Text>{item.title}</Text>
      </View>
    </TouchableHighlight>
  )}
/>

data

ItemSeparatorComponent

ListEmptyComponent

ListFooterComponent

ListFooterComponentStyle

ListHeaderComponent

ListHeaderComponentStyle

columnWrapperStyle

extraData

getItemLayout

(data, index) => {length: number, offset: number, index: number}

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

horizontal

initialNumToRender

initialScrollIndex

inverted

keyExtractor

(item: object, index: number) => string;

numColumns

onEndReached

(info: {distanceFromEnd: number}) => void

onEndReachedThreshold

onRefresh

() => void

onViewableItemsChanged

(info: {
    viewableItems: array,
    changed: array,
  }) => void

progressViewOffset

legacyImplementation

refreshing

removeClippedSubviews

Note: May have bugs (missing content) in some circumstances - use at your own risk.

viewabilityConfig

  Error: Changing viewabilityConfig on the fly is not supported`

constructor (props) {
  super(props)

  this.viewabilityConfig = {
      waitForInteraction: true,
      viewAreaCoveragePercentThreshold: 95
  }
}

<FlatList
    viewabilityConfig={this.viewabilityConfig}
  ...

minimumViewTime

viewAreaCoveragePercentThreshold

itemVisiblePercentThreshold

waitForInteraction

viewabilityConfigCallbackPairs

Methods

scrollToEnd()

scrollToEnd([params]);

• 'animated' (boolean) - Whether the list should do an animation while scrolling. Defaults to true.

scrollToIndex()

scrollToIndex(params);

Note: Cannot scroll to locations outside the render window without specifying the getItemLayout prop.

• 'animated' (boolean) - Whether the list should do an animation while scrolling. Defaults to true.
• 'index' (number) - The index to scroll to. Required.
• 'viewOffset' (number) - A fixed number of pixels to offset the final target position. Required.
• 'viewPosition' (number) - A value of 0 places the item specified by index at the top, 1 at the bottom, and 0.5 centered in the middle.

scrollToItem()

scrollToItem(params);

Note: Cannot scroll to locations outside the render window without specifying the getItemLayout prop.

• 'animated' (boolean) - Whether the list should do an animation while scrolling. Defaults to true.
• 'item' (object) - The item to scroll to. Required.
• 'viewPosition' (number)

scrollToOffset()

scrollToOffset(params);

• 'offset' (number) - The offset to scroll to. In case of horizontal being true, the offset is the x-value, in any other case the offset is the y-value. Required.
• 'animated' (boolean) - Whether the list should do an animation while scrolling. Defaults to true.

recordInteraction()

recordInteraction();

flashScrollIndicators()

flashScrollIndicators();

getScrollResponder()

getScrollResponder();

getScrollableNode()

getScrollableNode();