A performant interface for rendering sectioned lists, supporting the most handy features:
If you don't need section support and want a simpler interface, use
This is a convenience wrapper around
and thus inherits it's props (as well as those of
ScrollView) that aren't explicitly listed
here, along with the following caveats:
PureComponentwhich means that it will not re-render if
propsremain shallow- equal. Make sure that everything your
renderItemfunction 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
dataprop and parent component state.
keyprop on each item and uses that for the React key. Alternatively, you can provide a custom
Rendered in between each item, but not at the top or bottom. By default,
[leading/trailing][Item/Separator] props are provided.
unhighlight which will update the
highlighted prop, but you can also
add custom props with
Rendered when the list is empty. Can be a React Component Class, a render function, or a rendered element.
Rendered at the very end of the list. Can be a React Component Class, a render function, or a rendered element.
Rendered at the very beginning of the list. Can be a React Component Class, a render function, or a rendered element.
Rendered at the top and bottom of each section (note this is different from
ItemSeparatorComponent which is only rendered between items). These are intended to separate
sections from the headers above and below and typically have the same highlight response as
ItemSeparatorComponent. Also receives
and any custom props from
A marker property for telling the list to re-render (since it implements
any of your
renderItem, Header, Footer, etc. functions depend on anything outside of the
data prop, stick it here and treat it immutably.
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.
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.
Called once when the scroll position gets within
onEndReachedThreshold of the rendered
How 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
Thus a value of 0.5 will trigger
onEndReached when the end of the content is
within half the visible length of the list.
If provided, a standard RefreshControl will be added for "Pull to Refresh" functionality. Make
sure to also set the
refreshing prop correctly.
Called when the viewability of rows changes, as defined by the
Set this true while waiting for new data from a refresh.
Note: may have bugs (missing content) in some circumstances - use at your own risk.
This may improve scroll performance for large lists.
Default renderer for every item in every section. Can be over-ridden on a per-section basis.
Rendered at the bottom of each section.
Rendered at the top of each section. These stick to the top of the
ScrollView by default on
The actual data to render, akin to the
data prop in
Makes section headers stick to the top of the screen until the next one pushes it off. Only enabled by default on iOS because that is the platform standard there.
Scrolls to the item at the specified
itemIndex (within the section)
positioned in the viewable area such that
viewPosition 0 places it at the top (and may be
covered by a sticky header), 1 at the bottom, and 0.5 centered in the middle.
viewOffset is a
fixed number of pixels to offset the final target position, e.g. to compensate for sticky
Note: cannot scroll to locations outside the render window without specifying the
Tells the list an interaction has occured, which should trigger viewability calculations, e.g.
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!