renderItem({
  item: ItemT,
  index: number,
  separators: {
    highlight: () => void;
    unhighlight: () => void;
    updateProps: (select: 'leading' | 'trailing', newProps: any) => void;
  }
}): JSX.Element;

• 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)

Example usage:

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

Required

data​

An array (or array-like list) of items to render. Other data types can be used by targeting VirtualizedList directly.

ItemSeparatorComponent​

Rendered in between each item, but not at the top or bottom. By default, highlighted and leadingItem props are provided. renderItem provides separators.highlight/unhighlight which will update the highlighted prop, but you can also add custom props with separators.updateProps. Can be a React Component (e.g. SomeComponent), or a React element (e.g. <SomeComponent />).

ListEmptyComponent​

Rendered when the list is empty. Can be a React Component (e.g. SomeComponent), or a React element (e.g. <SomeComponent />).

ListFooterComponent​

Rendered at the bottom of all the items. Can be a React Component (e.g. SomeComponent), or a React element (e.g. <SomeComponent />).

ListFooterComponentStyle​

Styling for internal View for ListFooterComponent.

ListHeaderComponent​

Rendered at the top of all the items. Can be a React Component (e.g. SomeComponent), or a React element (e.g. <SomeComponent />).

ListHeaderComponentStyle​

Styling for internal View for ListHeaderComponent.

columnWrapperStyle​

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

extraData​

A marker property for telling the list to re-render (since it implements PureComponent). If any of your renderItem, Header, Footer, etc. functions depend on anything outside of the data prop, stick it here and treat it immutably.

getItemLayout​

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

getItemLayout is an optional optimization that allows skipping the measurement of dynamic content if you know the size (height or width) of items ahead of time. getItemLayout is efficient if you have fixed size items, for example:

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

Adding getItemLayout can be a great performance boost for lists of several hundred items. Remember to include separator length (height or width) in your offset calculation if you specify ItemSeparatorComponent.

horizontal​

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

initialNumToRender​

How many items to render in the initial batch. This should be enough to fill the screen but not much more. Note these items will never be unmounted as part of the windowed rendering in order to improve perceived performance of scroll-to-top actions.

initialScrollIndex​

Instead of starting at the top with the first item, start at initialScrollIndex. This disables the "scroll to top" optimization that keeps the first initialNumToRender items always rendered and immediately renders the items starting at this initial index. Requires getItemLayout to be implemented.

inverted​

Reverses the direction of scroll. Uses scale transforms of -1.

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 item.id, and then falls back to using the index, like React does.

numColumns​

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

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​

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

progressViewOffset​

Set this when offset is needed for the loading indicator to show correctly.

refreshing​

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

removeClippedSubviews​

When true, offscreen child views are removed from their native backing superview when offscreen. This may improve scroll performance for large lists. On Android the default value is true.

viewabilityConfig​

See ViewabilityHelper.js for flow type and further documentation.

viewabilityConfig takes a type ViewabilityConfig an object with following properties

At least one of the viewAreaCoveragePercentThreshold or itemVisiblePercentThreshold is required. This needs to be done in the constructor to avoid following error (ref):

  Error: Changing viewabilityConfig on the fly is not supported

constructor (props) {
  super(props)

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

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

minimumViewTime​

Minimum amount of time (in milliseconds) that an item must be physically viewable before the viewability callback will be fired. A high number means that scrolling through content without stopping will not mark the content as viewable.

viewAreaCoveragePercentThreshold​

Percent of viewport that must be covered for a partially occluded item to count as "viewable", 0-100. Fully visible items are always considered viewable. A value of 0 means that a single pixel in the viewport makes the item viewable, and a value of 100 means that an item must be either entirely visible or cover the entire viewport to count as viewable.

itemVisiblePercentThreshold​

Similar to viewAreaCoveragePercentThreshold, but considers the percent of the item that is visible, rather than the fraction of the viewable area it covers.

waitForInteraction​

Nothing is considered viewable until the user scrolls or recordInteraction is called after render.

viewabilityConfigCallbackPairs​

List of ViewabilityConfig/onViewableItemsChanged pairs. A specific onViewableItemsChanged will be called when its corresponding ViewabilityConfig's conditions are met. See ViewabilityHelper.js for flow type and further documentation.

Methods​

flashScrollIndicators()​

flashScrollIndicators();

Displays the scroll indicators momentarily.

getNativeScrollRef()​

getNativeScrollRef(): React.ElementRef<typeof ScrollViewComponent>;

Provides a reference to the underlying scroll component

getScrollResponder()​

getScrollResponder(): ScrollResponderMixin;

Provides a handle to the underlying scroll responder.

getScrollableNode()​

getScrollableNode(): any;

Provides a handle to the underlying scroll node.

scrollToEnd()​

scrollToEnd(params?: {animated?: boolean});

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

Parameters:

Valid params keys are:

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

scrollToIndex()​

scrollToIndex: (params: {
  index: number;
  animated?: boolean;
  viewOffset?: number;
  viewPosition?: number;
});

Scrolls to the item at 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.

Parameters:

Valid params keys are:

• '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.
• '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: {
  animated?: ?boolean,
  item: Item,
  viewPosition?: number,
});

Requires linear scan through data - use scrollToIndex instead if possible.

Parameters:

Valid params keys are:

• '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;
  animated?: boolean;
});

Scroll to a specific content pixel offset in the list.

Parameters:

Valid params keys are:

• '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.