mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Website Deployment Script
53 lines
95 KiB
HTML
53 lines
95 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<meta name="generator" content="Docusaurus v2.0.0-alpha.70">
|
|
<link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="React Native Blog RSS Feed">
|
|
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="React Native Blog Atom Feed">
|
|
<link rel="preconnect" href="https://www.google-analytics.com">
|
|
<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-41298772-2","auto"),ga("send","pageview")</script>
|
|
<script async src="https://www.google-analytics.com/analytics.js"></script>
|
|
<link rel="preconnect" href="https://www.google-analytics.com">
|
|
<link rel="preconnect" href="https://www.googletagmanager.com">
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-41298772-2"></script>
|
|
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","UA-41298772-2",{})</script>
|
|
<link rel="search" type="application/opensearchdescription+xml" title="React Native" href="/opensearch.xml">
|
|
<link rel="icon" href="/img/pwa/manifest-icon-512.png">
|
|
<link rel="manifest" href="/manifest.json">
|
|
<meta name="theme-color" content="#20232a">
|
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
|
<meta name="apple-mobile-web-app-status-bar-style" content="#20232a">
|
|
<link rel="apple-touch-icon" href="/img/pwa/manifest-icon-512.png">
|
|
<link rel="mask-icon" href="/img/pwa/manifest-icon-512.png" color="#06bcee">
|
|
<meta name="msapplication-TileImage" href="/img/pwa/manifest-icon-512.png">
|
|
<meta name="msapplication-TileColor" content="#20232a">
|
|
<script src="https://cdn.jsdelivr.net/npm/focus-visible@5.2.0/dist/focus-visible.min.js" defer="defer"></script>
|
|
<script src="https://snack.expo.io/embed.js" defer="defer"></script><title data-react-helmet="true">FlatList · React Native</title><meta data-react-helmet="true" name="twitter:image:alt" content="Image for React Native"><meta data-react-helmet="true" name="docsearch:language" content="en"><meta data-react-helmet="true" name="docsearch:version" content="current"><meta data-react-helmet="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:image" content="https://reactnative.dev/img/logo-og.png"><meta data-react-helmet="true" name="twitter:card" content="summary"><meta data-react-helmet="true" name="twitter:image" content="https://reactnative.dev/img/logo-og.png"><meta data-react-helmet="true" property="og:title" content="FlatList · React Native"><meta data-react-helmet="true" name="description" content="A performant interface for rendering basic, flat lists, supporting the most handy features:"><meta data-react-helmet="true" property="og:description" content="A performant interface for rendering basic, flat lists, supporting the most handy features:"><meta data-react-helmet="true" property="og:url" content="https://reactnative.dev/docs/next/flatlist"><link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.ico"><link data-react-helmet="true" rel="preconnect" href="https://BH4D9OD16A-dsn.algolia.net" crossorigin="anonymous"><link data-react-helmet="true" rel="canonical" href="https://reactnative.dev/docs/next/flatlist"><link rel="stylesheet" href="/styles.f56da522.css">
|
|
<link rel="stylesheet" href="/main.3de2b5ef.css">
|
|
<link rel="preload" href="/styles.dfe3b9eb.js" as="script">
|
|
<link rel="preload" href="/runtime~main.5916a0a4.js" as="script">
|
|
<link rel="preload" href="/main.6094b97f.js" as="script">
|
|
<link rel="preload" href="/1.8c647f8e.js" as="script">
|
|
<link rel="preload" href="/2.e133592c.js" as="script">
|
|
<link rel="preload" href="/931.624ff15d.js" as="script">
|
|
<link rel="preload" href="/935f2afb.abc3c679.js" as="script">
|
|
<link rel="preload" href="/17896441.1e68c5df.js" as="script">
|
|
<link rel="preload" href="/e532ff9a.cb1660b3.js" as="script">
|
|
</head>
|
|
<body>
|
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
|
|
<nav aria-label="Skip navigation links"><button type="button" tabindex="0" class="skipToContent_3aLp">Skip to main content</button></nav><nav class="navbar navbar--fixed-top navbar--dark"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg aria-label="Menu" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a class="navbar__brand" href="/"><img src="/img/header_logo.svg" alt="React Native" class="themedImage_phiS themedImage--light_VJaY navbar__logo"><img src="/img/header_logo.svg" alt="React Native" class="themedImage_phiS themedImage--dark_1NF3 navbar__logo"><strong class="navbar__title">React Native</strong></a><div class="navbar__item dropdown dropdown--hoverable dropdown--left"><a class="navbar__item navbar__link" href="/docs/next/getting-started">Next</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/next/flatlist">Next</a></li><li><a class="dropdown__link" href="/docs/flatlist">0.63</a></li><li><a class="dropdown__link" href="/docs/0.62/flatlist">0.62</a></li><li><a class="dropdown__link" href="/docs/0.61/flatlist">0.61</a></li><li><a class="dropdown__link" href="/docs/0.60/flatlist">0.60</a></li><li><a class="dropdown__link" href="/versions">All versions</a></li></ul></div></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link" href="/docs/next/getting-started">Docs</a><a class="navbar__item navbar__link navbar__link--active" href="/docs/next/components-and-apis">Components</a><a class="navbar__item navbar__link" href="/docs/next/accessibilityinfo">API</a><a class="navbar__item navbar__link" href="/help">Community</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a href="https://github.com/facebook/react-native" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link navbar-github-link" aria-label="GitHub repository"></a><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_Bh6k"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_1UDy">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_1UDy">🌞</span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span></button></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/"><img src="/img/header_logo.svg" alt="React Native" class="themedImage_phiS themedImage--light_VJaY navbar__logo"><img src="/img/header_logo.svg" alt="React Native" class="themedImage_phiS themedImage--dark_1NF3 navbar__logo"><strong class="navbar__title">React Native</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/next/getting-started">Docs</a></li><li class="menu__list-item"><a class="menu__link navbar__link--active" href="/docs/next/components-and-apis">Components</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/next/accessibilityinfo">API</a></li><li class="menu__list-item"><a class="menu__link" href="/help">Community</a></li><li class="menu__list-item"><a class="menu__link" href="/blog">Blog</a></li><li class="menu__list-item"><a role="button" class="menu__link menu__link--sublist">Versions</a><ul class="menu__list"><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active" href="/docs/next/flatlist">Next</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/flatlist">0.63</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/0.62/flatlist">0.62</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/0.61/flatlist">0.61</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/0.60/flatlist">0.60</a></li><li class="menu__list-item"><a class="menu__link" href="/versions">All versions</a></li></ul></li><li class="menu__list-item"><a href="https://github.com/facebook/react-native" target="_blank" rel="noopener noreferrer" class="menu__link navbar-github-link" aria-label="GitHub repository"></a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_1mVJ"><div class="docSidebarContainer_uPTz" role="complementary"><div class="sidebar_M-Lc"><div class="menu menu--responsive thin-scrollbar menu_tgpy"><button aria-label="Open Menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg aria-label="Menu" class="sidebarMenuIcon_1e05" width="24" height="24" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">Core Components</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/components-and-apis">Core Components and APIs</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/activityindicator">ActivityIndicator</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/button">Button</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/docs/next/flatlist">FlatList</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/image">Image</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/imagebackground">ImageBackground</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/keyboardavoidingview">KeyboardAvoidingView</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/modal">Modal</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/pressable">Pressable</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/refreshcontrol">RefreshControl</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/scrollview">ScrollView</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/sectionlist">SectionList</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/statusbar">StatusBar</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/switch">Switch</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/text">Text</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/textinput">TextInput</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/touchablehighlight">TouchableHighlight</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/touchableopacity">TouchableOpacity</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/touchablewithoutfeedback">TouchableWithoutFeedback</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/view">View</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/virtualizedlist">VirtualizedList</a></li><li class="menu__list-item"><a class="menu__link menu__link--sublist" href="#!" tabindex="0">Android Components</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/drawerlayoutandroid">DrawerLayoutAndroid</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/touchablenativefeedback">TouchableNativeFeedback</a></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist" href="#!" tabindex="0">iOS Components</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/inputaccessoryview">InputAccessoryView</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/safeareaview">SafeAreaView</a></li></ul></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Props</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/next/image-style-props">Image Style Props</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/next/layout-props">Layout Props</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/next/shadow-props">Shadow Props</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/next/text-style-props">Text Style Props</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/next/view-style-props">View Style Props</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Object Types</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/next/layoutevent">LayoutEvent Object Type</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/next/pressevent">PressEvent Object Type</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/next/react-node">React Node Object Type</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/next/rect">Rect Object Type</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/next/viewtoken">ViewToken Object Type</a></li></ul></li></ul></div></div></div><main class="docMainContainer_1zi2"><div class="container padding-vert--lg docItemWrapper_1hMI"><div class="row"><div class="col docItemCol_2AGf"><div class="alert alert--warning margin-bottom--md" role="alert"><div>This is unreleased documentation for React Native <strong>Next</strong> version.</div><div class="margin-top--md">For up-to-date documentation, see the <strong><a href="/docs/flatlist">latest version</a></strong> (0.63).</div></div><div class="docItemContainer_1tAC"><article><div><span class="badge badge--secondary">Version: Next</span></div><header><h1 class="docTitle_cWlf">FlatList</h1></header><div class="markdown"><p>A performant interface for rendering basic, flat lists, supporting the most handy features:</p><ul><li>Fully cross-platform.</li><li>Optional horizontal mode.</li><li>Configurable viewability callbacks.</li><li>Header support.</li><li>Footer support.</li><li>Separator support.</li><li>Pull to Refresh.</li><li>Scroll loading.</li><li>ScrollToIndex support.</li><li>Multiple column support.</li></ul><p>If you need section support, use <a href="/docs/next/sectionlist"><code><SectionList></code></a>.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="example"></a>Example<a class="hash-link" href="#example" title="Direct link to heading">#</a></h2><div class="snack-player" data-snack-name="flatlist-simple" data-snack-description="Example usage" data-snack-code="import%20React%20from%20'react'%3B%0Aimport%20%7B%20SafeAreaView%2C%20View%2C%20FlatList%2C%20StyleSheet%2C%20Text%2C%20StatusBar%20%7D%20from%20'react-native'%3B%0A%0Aconst%20DATA%20%3D%20%5B%0A%20%20%7B%0A%20%20%20%20id%3A%20'bd7acbea-c1b1-46c2-aed5-3ad53abb28ba'%2C%0A%20%20%20%20title%3A%20'First%20Item'%2C%0A%20%20%7D%2C%0A%20%20%7B%0A%20%20%20%20id%3A%20'3ac68afc-c605-48d3-a4f8-fbd91aa97f63'%2C%0A%20%20%20%20title%3A%20'Second%20Item'%2C%0A%20%20%7D%2C%0A%20%20%7B%0A%20%20%20%20id%3A%20'58694a0f-3da1-471f-bd96-145571e29d72'%2C%0A%20%20%20%20title%3A%20'Third%20Item'%2C%0A%20%20%7D%2C%0A%5D%3B%0A%0Aconst%20Item%20%3D%20(%7B%20title%20%7D)%20%3D%3E%20(%0A%20%20%3CView%20style%3D%7Bstyles.item%7D%3E%0A%20%20%20%20%3CText%20style%3D%7Bstyles.title%7D%3E%7Btitle%7D%3C%2FText%3E%0A%20%20%3C%2FView%3E%0A)%3B%0A%0Aconst%20App%20%3D%20()%20%3D%3E%20%7B%0A%20%20const%20renderItem%20%3D%20(%7B%20item%20%7D)%20%3D%3E%20(%0A%20%20%20%20%3CItem%20title%3D%7Bitem.title%7D%20%2F%3E%0A%20%20)%3B%0A%0A%20%20return%20(%0A%20%20%20%20%3CSafeAreaView%20style%3D%7Bstyles.container%7D%3E%0A%20%20%20%20%20%20%3CFlatList%0A%20%20%20%20%20%20%20%20data%3D%7BDATA%7D%0A%20%20%20%20%20%20%20%20renderItem%3D%7BrenderItem%7D%0A%20%20%20%20%20%20%20%20keyExtractor%3D%7Bitem%20%3D%3E%20item.id%7D%0A%20%20%20%20%20%20%2F%3E%0A%20%20%20%20%3C%2FSafeAreaView%3E%0A%20%20)%3B%0A%7D%0A%0Aconst%20styles%20%3D%20StyleSheet.create(%7B%0A%20%20container%3A%20%7B%0A%20%20%20%20flex%3A%201%2C%0A%20%20%20%20marginTop%3A%20StatusBar.currentHeight%20%7C%7C%200%2C%0A%20%20%7D%2C%0A%20%20item%3A%20%7B%0A%20%20%20%20backgroundColor%3A%20'%23f9c2ff'%2C%0A%20%20%20%20padding%3A%2020%2C%0A%20%20%20%20marginVertical%3A%208%2C%0A%20%20%20%20marginHorizontal%3A%2016%2C%0A%20%20%7D%2C%0A%20%20title%3A%20%7B%0A%20%20%20%20fontSize%3A%2032%2C%0A%20%20%7D%2C%0A%7D)%3B%0A%0Aexport%20default%20App%3B" data-snack-dependencies="" data-snack-platform="web" data-snack-supported-platforms="ios,android,web" data-snack-theme="light" data-snack-preview="true" data-snack-loading="lazy"></div><p>To render multiple columns, use the <a href="/docs/next/flatlist#numcolumns"><code>numColumns</code></a> prop. Using this approach instead of a <code>flexWrap</code> layout can prevent conflicts with the item height logic.</p><p>More complex, selectable example below.</p><ul><li>By passing <code>extraData={selectedId}</code> to <code>FlatList</code> we make sure <code>FlatList</code> itself will re-render when the state changes. Without setting this prop, <code>FlatList</code> would not know it needs to re-render any items because it is a <code>PureComponent</code> and the prop comparison will not show any changes.</li><li><code>keyExtractor</code> tells the list to use the <code>id</code>s for the react keys instead of the default <code>key</code> property.</li></ul><div class="snack-player" data-snack-name="flatlist-selectable" data-snack-description="Example usage" data-snack-code="import%20React%2C%20%7B%20useState%20%7D%20from%20%22react%22%3B%0Aimport%20%7B%20FlatList%2C%20SafeAreaView%2C%20StatusBar%2C%20StyleSheet%2C%20Text%2C%20TouchableOpacity%20%7D%20from%20%22react-native%22%3B%0A%0Aconst%20DATA%20%3D%20%5B%0A%20%20%7B%0A%20%20%20%20id%3A%20%22bd7acbea-c1b1-46c2-aed5-3ad53abb28ba%22%2C%0A%20%20%20%20title%3A%20%22First%20Item%22%2C%0A%20%20%7D%2C%0A%20%20%7B%0A%20%20%20%20id%3A%20%223ac68afc-c605-48d3-a4f8-fbd91aa97f63%22%2C%0A%20%20%20%20title%3A%20%22Second%20Item%22%2C%0A%20%20%7D%2C%0A%20%20%7B%0A%20%20%20%20id%3A%20%2258694a0f-3da1-471f-bd96-145571e29d72%22%2C%0A%20%20%20%20title%3A%20%22Third%20Item%22%2C%0A%20%20%7D%2C%0A%5D%3B%0A%0Aconst%20Item%20%3D%20(%7B%20item%2C%20onPress%2C%20style%20%7D)%20%3D%3E%20(%0A%20%20%3CTouchableOpacity%20onPress%3D%7BonPress%7D%20style%3D%7B%5Bstyles.item%2C%20style%5D%7D%3E%0A%20%20%20%20%3CText%20style%3D%7Bstyles.title%7D%3E%7Bitem.title%7D%3C%2FText%3E%0A%20%20%3C%2FTouchableOpacity%3E%0A)%3B%0A%0Aconst%20App%20%3D%20()%20%3D%3E%20%7B%0A%20%20const%20%5BselectedId%2C%20setSelectedId%5D%20%3D%20useState(null)%3B%0A%0A%20%20const%20renderItem%20%3D%20(%7B%20item%20%7D)%20%3D%3E%20%7B%0A%20%20%20%20const%20backgroundColor%20%3D%20item.id%20%3D%3D%3D%20selectedId%20%3F%20%22%236e3b6e%22%20%3A%20%22%23f9c2ff%22%3B%0A%0A%20%20%20%20return%20(%0A%20%20%20%20%20%20%3CItem%0A%20%20%20%20%20%20%20%20item%3D%7Bitem%7D%0A%20%20%20%20%20%20%20%20onPress%3D%7B()%20%3D%3E%20setSelectedId(item.id)%7D%0A%20%20%20%20%20%20%20%20style%3D%7B%7B%20backgroundColor%20%7D%7D%0A%20%20%20%20%20%20%2F%3E%0A%20%20%20%20)%3B%0A%20%20%7D%3B%0A%0A%20%20return%20(%0A%20%20%20%20%3CSafeAreaView%20style%3D%7Bstyles.container%7D%3E%0A%20%20%20%20%20%20%3CFlatList%0A%20%20%20%20%20%20%20%20data%3D%7BDATA%7D%0A%20%20%20%20%20%20%20%20renderItem%3D%7BrenderItem%7D%0A%20%20%20%20%20%20%20%20keyExtractor%3D%7B(item)%20%3D%3E%20item.id%7D%0A%20%20%20%20%20%20%20%20extraData%3D%7BselectedId%7D%0A%20%20%20%20%20%20%2F%3E%0A%20%20%20%20%3C%2FSafeAreaView%3E%0A%20%20)%3B%0A%7D%3B%0A%0Aconst%20styles%20%3D%20StyleSheet.create(%7B%0A%20%20container%3A%20%7B%0A%20%20%20%20flex%3A%201%2C%0A%20%20%20%20marginTop%3A%20StatusBar.currentHeight%20%7C%7C%200%2C%0A%20%20%7D%2C%0A%20%20item%3A%20%7B%0A%20%20%20%20padding%3A%2020%2C%0A%20%20%20%20marginVertical%3A%208%2C%0A%20%20%20%20marginHorizontal%3A%2016%2C%0A%20%20%7D%2C%0A%20%20title%3A%20%7B%0A%20%20%20%20fontSize%3A%2032%2C%0A%20%20%7D%2C%0A%7D)%3B%0A%0Aexport%20default%20App%3B" data-snack-dependencies="" data-snack-platform="web" data-snack-supported-platforms="ios,android,web" data-snack-theme="light" data-snack-preview="true" data-snack-loading="lazy"></div><p>This is a convenience wrapper around <a href="/docs/next/virtualizedlist"><code><VirtualizedList></code></a>, and thus inherits its props (as well as those of <a href="/docs/next/scrollview"><code><ScrollView></code></a>) that aren't explicitly listed here, along with the following caveats:</p><ul><li>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.</li><li>This is a <code>PureComponent</code> which means that it will not re-render if <code>props</code> remain shallow-equal. Make sure that everything your <code>renderItem</code> function depends on is passed as a prop (e.g. <code>extraData</code>) that is not <code>===</code> after updates, otherwise your UI may not update on changes. This includes the <code>data</code> prop and parent component state.</li><li>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.</li><li>By default, the list looks for a <code>key</code> prop on each item and uses that for the React key. Alternatively, you can provide a custom <code>keyExtractor</code> prop.</li></ul><hr><h1><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="reference"></a>Reference<a class="hash-link" href="#reference" title="Direct link to heading">#</a></h1><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="props"></a>Props<a class="hash-link" href="#props" title="Direct link to heading">#</a></h2><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="scrollview-props"></a><a href="/docs/next/scrollview#props">ScrollView Props</a><a class="hash-link" href="#scrollview-props" title="Direct link to heading">#</a></h3><p>Inherits <a href="/docs/next/scrollview#props">ScrollView Props</a>, unless it is nested in another FlatList of same orientation.</p><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="required-renderitem"></a><div class="label required basic">Required</div> <strong><code>renderItem</code></strong><a class="hash-link" href="#required-renderitem" title="Direct link to heading">#</a></h3><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token function" style="color:#79b6f2">renderItem</span><span class="token punctuation" style="color:#657b83">(</span><span class="token punctuation" style="color:#657b83">{</span><span class="token plain"> item</span><span class="token punctuation" style="color:#657b83">,</span><span class="token plain"> index</span><span class="token punctuation" style="color:#657b83">,</span><span class="token plain"> separators </span><span class="token punctuation" style="color:#657b83">}</span><span class="token punctuation" style="color:#657b83">)</span><span class="token punctuation" style="color:#657b83">;</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><p>Takes an item from <code>data</code> and renders it into the list.</p><p>Provides additional metadata like <code>index</code> if you need it, as well as a more generic <code>separators.updateProps</code> function which let you set whatever props you want to change the rendering of either the leading separator or trailing separator in case the more common <code>highlight</code> and <code>unhighlight</code> (which set the <code>highlighted: boolean</code> prop) are insufficient for your use case.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>function</td></tr></tbody></table><ul><li><code>item</code> (Object): The item from <code>data</code> being rendered.</li><li><code>index</code> (number): The index corresponding to this item in the <code>data</code> array.</li><li><code>separators</code> (Object)<ul><li><code>highlight</code> (Function)</li><li><code>unhighlight</code> (Function)</li><li><code>updateProps</code> (Function)<ul><li><code>select</code> (enum('leading', 'trailing'))</li><li><code>newProps</code> (Object)</li></ul></li></ul></li></ul><p>Example usage:</p><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag punctuation" style="color:#657b83"><</span><span class="token tag class-name" style="color:#fac863">FlatList</span><span class="token tag" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag" style="color:#fc929e"> </span><span class="token tag attr-name" style="color:#c5a5c5">ItemSeparatorComponent</span><span class="token tag script language-javascript script-punctuation punctuation" style="color:#657b83">=</span><span class="token tag script language-javascript punctuation" style="color:#657b83">{</span><span class="token tag script language-javascript" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript" style="color:#fc929e"> Platform</span><span class="token tag script language-javascript punctuation" style="color:#657b83">.</span><span class="token tag script language-javascript constant" style="color:#5a9bcf">OS</span><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript operator" style="color:#fc929e">!==</span><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript string" style="color:#8dc891">'android'</span><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript operator" style="color:#fc929e">&&</span><span class="token tag script language-javascript" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript punctuation" style="color:#657b83">(</span><span class="token tag script language-javascript punctuation" style="color:#657b83">(</span><span class="token tag script language-javascript parameter punctuation" style="color:#657b83">{</span><span class="token tag script language-javascript parameter" style="color:#fc929e"> highlighted </span><span class="token tag script language-javascript parameter punctuation" style="color:#657b83">}</span><span class="token tag script language-javascript punctuation" style="color:#657b83">)</span><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript operator" style="color:#fc929e">=></span><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript punctuation" style="color:#657b83">(</span><span class="token tag script language-javascript" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript tag punctuation" style="color:#657b83"><</span><span class="token tag script language-javascript tag class-name" style="color:#fac863">View</span><span class="token tag script language-javascript tag" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript tag" style="color:#fc929e"> </span><span class="token tag script language-javascript tag attr-name" style="color:#c5a5c5">style</span><span class="token tag script language-javascript tag script language-javascript script-punctuation punctuation" style="color:#657b83">=</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">{</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">[</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e"> style</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">.</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e">separator</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">,</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e"> highlighted </span><span class="token tag script language-javascript tag script language-javascript operator" style="color:#fc929e">&&</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">{</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e"> marginLeft</span><span class="token tag script language-javascript tag script language-javascript operator" style="color:#fc929e">:</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript tag script language-javascript number" style="color:#5a9bcf">0</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">}</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">]</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">}</span><span class="token tag script language-javascript tag" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript tag" style="color:#fc929e"> </span><span class="token tag script language-javascript tag punctuation" style="color:#657b83">/></span><span class="token tag script language-javascript" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript punctuation" style="color:#657b83">)</span><span class="token tag script language-javascript punctuation" style="color:#657b83">)</span><span class="token tag script language-javascript" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript punctuation" style="color:#657b83">}</span><span class="token tag" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag" style="color:#fc929e"> </span><span class="token tag attr-name" style="color:#c5a5c5">data</span><span class="token tag script language-javascript script-punctuation punctuation" style="color:#657b83">=</span><span class="token tag script language-javascript punctuation" style="color:#657b83">{</span><span class="token tag script language-javascript punctuation" style="color:#657b83">[</span><span class="token tag script language-javascript punctuation" style="color:#657b83">{</span><span class="token tag script language-javascript" style="color:#fc929e"> title</span><span class="token tag script language-javascript operator" style="color:#fc929e">:</span><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript string" style="color:#8dc891">'Title Text'</span><span class="token tag script language-javascript punctuation" style="color:#657b83">,</span><span class="token tag script language-javascript" style="color:#fc929e"> key</span><span class="token tag script language-javascript operator" style="color:#fc929e">:</span><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript string" style="color:#8dc891">'item1'</span><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript punctuation" style="color:#657b83">}</span><span class="token tag script language-javascript punctuation" style="color:#657b83">]</span><span class="token tag script language-javascript punctuation" style="color:#657b83">}</span><span class="token tag" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag" style="color:#fc929e"> </span><span class="token tag attr-name" style="color:#c5a5c5">renderItem</span><span class="token tag script language-javascript script-punctuation punctuation" style="color:#657b83">=</span><span class="token tag script language-javascript punctuation" style="color:#657b83">{</span><span class="token tag script language-javascript punctuation" style="color:#657b83">(</span><span class="token tag script language-javascript parameter punctuation" style="color:#657b83">{</span><span class="token tag script language-javascript parameter" style="color:#fc929e"> item</span><span class="token tag script language-javascript parameter punctuation" style="color:#657b83">,</span><span class="token tag script language-javascript parameter" style="color:#fc929e"> index</span><span class="token tag script language-javascript parameter punctuation" style="color:#657b83">,</span><span class="token tag script language-javascript parameter" style="color:#fc929e"> separators </span><span class="token tag script language-javascript parameter punctuation" style="color:#657b83">}</span><span class="token tag script language-javascript punctuation" style="color:#657b83">)</span><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript operator" style="color:#fc929e">=></span><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript punctuation" style="color:#657b83">(</span><span class="token tag script language-javascript" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript tag punctuation" style="color:#657b83"><</span><span class="token tag script language-javascript tag class-name" style="color:#fac863">TouchableHighlight</span><span class="token tag script language-javascript tag" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript tag" style="color:#fc929e"> </span><span class="token tag script language-javascript tag attr-name" style="color:#c5a5c5">key</span><span class="token tag script language-javascript tag script language-javascript script-punctuation punctuation" style="color:#657b83">=</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">{</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e">item</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">.</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e">key</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">}</span><span class="token tag script language-javascript tag" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript tag" style="color:#fc929e"> </span><span class="token tag script language-javascript tag attr-name" style="color:#c5a5c5">onPress</span><span class="token tag script language-javascript tag script language-javascript script-punctuation punctuation" style="color:#657b83">=</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">{</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">(</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">)</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript tag script language-javascript operator" style="color:#fc929e">=></span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript tag script language-javascript keyword" style="color:#c5a5c5">this</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">.</span><span class="token tag script language-javascript tag script language-javascript function" style="color:#79b6f2">_onPress</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">(</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e">item</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">)</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">}</span><span class="token tag script language-javascript tag" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript tag" style="color:#fc929e"> </span><span class="token tag script language-javascript tag attr-name" style="color:#c5a5c5">onShowUnderlay</span><span class="token tag script language-javascript tag script language-javascript script-punctuation punctuation" style="color:#657b83">=</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">{</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e">separators</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">.</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e">highlight</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">}</span><span class="token tag script language-javascript tag" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript tag" style="color:#fc929e"> </span><span class="token tag script language-javascript tag attr-name" style="color:#c5a5c5">onHideUnderlay</span><span class="token tag script language-javascript tag script language-javascript script-punctuation punctuation" style="color:#657b83">=</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">{</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e">separators</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">.</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e">unhighlight</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">}</span><span class="token tag script language-javascript tag punctuation" style="color:#657b83">></span><span class="token tag script language-javascript" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript tag punctuation" style="color:#657b83"><</span><span class="token tag script language-javascript tag class-name" style="color:#fac863">View</span><span class="token tag script language-javascript tag" style="color:#fc929e"> </span><span class="token tag script language-javascript tag attr-name" style="color:#c5a5c5">style</span><span class="token tag script language-javascript tag script language-javascript script-punctuation punctuation" style="color:#657b83">=</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">{</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">{</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e"> backgroundColor</span><span class="token tag script language-javascript tag script language-javascript operator" style="color:#fc929e">:</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript tag script language-javascript string" style="color:#8dc891">'white'</span><span class="token tag script language-javascript tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">}</span><span class="token tag script language-javascript tag script language-javascript punctuation" style="color:#657b83">}</span><span class="token tag script language-javascript tag punctuation" style="color:#657b83">></span><span class="token tag script language-javascript" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript tag punctuation" style="color:#657b83"><</span><span class="token tag script language-javascript tag class-name" style="color:#fac863">Text</span><span class="token tag script language-javascript tag punctuation" style="color:#657b83">></span><span class="token tag script language-javascript punctuation" style="color:#657b83">{</span><span class="token tag script language-javascript" style="color:#fc929e">item</span><span class="token tag script language-javascript punctuation" style="color:#657b83">.</span><span class="token tag script language-javascript" style="color:#fc929e">title</span><span class="token tag script language-javascript punctuation" style="color:#657b83">}</span><span class="token tag script language-javascript tag punctuation" style="color:#657b83"></</span><span class="token tag script language-javascript tag class-name" style="color:#fac863">Text</span><span class="token tag script language-javascript tag punctuation" style="color:#657b83">></span><span class="token tag script language-javascript" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript tag punctuation" style="color:#657b83"></</span><span class="token tag script language-javascript tag class-name" style="color:#fac863">View</span><span class="token tag script language-javascript tag punctuation" style="color:#657b83">></span><span class="token tag script language-javascript" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript tag punctuation" style="color:#657b83"></</span><span class="token tag script language-javascript tag class-name" style="color:#fac863">TouchableHighlight</span><span class="token tag script language-javascript tag punctuation" style="color:#657b83">></span><span class="token tag script language-javascript" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag script language-javascript" style="color:#fc929e"> </span><span class="token tag script language-javascript punctuation" style="color:#657b83">)</span><span class="token tag script language-javascript punctuation" style="color:#657b83">}</span><span class="token tag" style="color:#fc929e"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token tag" style="color:#fc929e"></span><span class="token tag punctuation" style="color:#657b83">/></span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="required-data"></a><div class="label required basic">Required</div> <strong><code>data</code></strong><a class="hash-link" href="#required-data" title="Direct link to heading">#</a></h3><p>For simplicity, data is a plain array. If you want to use something else, like an immutable list, use the underlying <a href="/docs/next/virtualizedlist"><code>VirtualizedList</code></a> directly.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>array</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="itemseparatorcomponent"></a><code>ItemSeparatorComponent</code><a class="hash-link" href="#itemseparatorcomponent" title="Direct link to heading">#</a></h3><p>Rendered in between each item, but not at the top or bottom. By default, <code>highlighted</code> and <code>leadingItem</code> props are provided. <code>renderItem</code> provides <code>separators.highlight</code>/<code>unhighlight</code> which will update the <code>highlighted</code> prop, but you can also add custom props with <code>separators.updateProps</code>.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>component</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="listemptycomponent"></a><code>ListEmptyComponent</code><a class="hash-link" href="#listemptycomponent" title="Direct link to heading">#</a></h3><p>Rendered when the list is empty. Can be a React Component (e.g. <code>SomeComponent</code>), or a React element (e.g. <code><SomeComponent /></code>).</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>component, element</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="listfootercomponent"></a><code>ListFooterComponent</code><a class="hash-link" href="#listfootercomponent" title="Direct link to heading">#</a></h3><p>Rendered at the bottom of all the items. Can be a React Component (e.g. <code>SomeComponent</code>), or a React element (e.g. <code><SomeComponent /></code>).</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>component, element</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="listfootercomponentstyle"></a><code>ListFooterComponentStyle</code><a class="hash-link" href="#listfootercomponentstyle" title="Direct link to heading">#</a></h3><p>Styling for internal View for <code>ListFooterComponent</code>.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td><a href="/docs/next/view-style-props">View Style</a></td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="listheadercomponent"></a><code>ListHeaderComponent</code><a class="hash-link" href="#listheadercomponent" title="Direct link to heading">#</a></h3><p>Rendered at the top of all the items. Can be a React Component (e.g. <code>SomeComponent</code>), or a React element (e.g. <code><SomeComponent /></code>).</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>component, element</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="listheadercomponentstyle"></a><code>ListHeaderComponentStyle</code><a class="hash-link" href="#listheadercomponentstyle" title="Direct link to heading">#</a></h3><p>Styling for internal View for <code>ListHeaderComponent</code>.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td><a href="/docs/next/view-style-props">View Style</a></td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="columnwrapperstyle"></a><code>columnWrapperStyle</code><a class="hash-link" href="#columnwrapperstyle" title="Direct link to heading">#</a></h3><p>Optional custom style for multi-item rows generated when <code>numColumns > 1</code>.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td><a href="/docs/next/view-style-props">View Style</a></td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="extradata"></a><code>extraData</code><a class="hash-link" href="#extradata" title="Direct link to heading">#</a></h3><p>A marker property for telling the list to re-render (since it implements <code>PureComponent</code>). If any of your <code>renderItem</code>, Header, Footer, etc. functions depend on anything outside of the <code>data</code> prop, stick it here and treat it immutably.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>any</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="getitemlayout"></a><code>getItemLayout</code><a class="hash-link" href="#getitemlayout" title="Direct link to heading">#</a></h3><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token punctuation" style="color:#657b83">(</span><span class="token parameter">data</span><span class="token parameter punctuation" style="color:#657b83">,</span><span class="token parameter"> index</span><span class="token punctuation" style="color:#657b83">)</span><span class="token plain"> </span><span class="token operator" style="color:#fc929e">=></span><span class="token plain"> </span><span class="token punctuation" style="color:#657b83">{</span><span class="token plain">length</span><span class="token operator" style="color:#fc929e">:</span><span class="token plain"> number</span><span class="token punctuation" style="color:#657b83">,</span><span class="token plain"> offset</span><span class="token operator" style="color:#fc929e">:</span><span class="token plain"> number</span><span class="token punctuation" style="color:#657b83">,</span><span class="token plain"> index</span><span class="token operator" style="color:#fc929e">:</span><span class="token plain"> number</span><span class="token punctuation" style="color:#657b83">}</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><p><code>getItemLayout</code> 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. <code>getItemLayout</code> is efficient if you have fixed size items, for example:</p><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token plain"> getItemLayout</span><span class="token operator" style="color:#fc929e">=</span><span class="token punctuation" style="color:#657b83">{</span><span class="token punctuation" style="color:#657b83">(</span><span class="token parameter">data</span><span class="token parameter punctuation" style="color:#657b83">,</span><span class="token parameter"> index</span><span class="token punctuation" style="color:#657b83">)</span><span class="token plain"> </span><span class="token operator" style="color:#fc929e">=></span><span class="token plain"> </span><span class="token punctuation" style="color:#657b83">(</span><span class="token plain"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token plain"> </span><span class="token punctuation" style="color:#657b83">{</span><span class="token plain">length</span><span class="token operator" style="color:#fc929e">:</span><span class="token plain"> </span><span class="token constant" style="color:#5a9bcf">ITEM_HEIGHT</span><span class="token punctuation" style="color:#657b83">,</span><span class="token plain"> offset</span><span class="token operator" style="color:#fc929e">:</span><span class="token plain"> </span><span class="token constant" style="color:#5a9bcf">ITEM_HEIGHT</span><span class="token plain"> </span><span class="token operator" style="color:#fc929e">*</span><span class="token plain"> index</span><span class="token punctuation" style="color:#657b83">,</span><span class="token plain"> index</span><span class="token punctuation" style="color:#657b83">}</span><span class="token plain"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token plain"> </span><span class="token punctuation" style="color:#657b83">)</span><span class="token punctuation" style="color:#657b83">}</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><p>Adding <code>getItemLayout</code> 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 <code>ItemSeparatorComponent</code>.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>function</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="horizontal"></a><code>horizontal</code><a class="hash-link" href="#horizontal" title="Direct link to heading">#</a></h3><p>If <code>true</code>, renders items next to each other horizontally instead of stacked vertically.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>boolean</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="initialnumtorender"></a><code>initialNumToRender</code><a class="hash-link" href="#initialnumtorender" title="Direct link to heading">#</a></h3><p>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.</p><table><thead><tr><th>Type</th><th>Default</th></tr></thead><tbody><tr><td>number</td><td><code>10</code></td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="initialscrollindex"></a><code>initialScrollIndex</code><a class="hash-link" href="#initialscrollindex" title="Direct link to heading">#</a></h3><p>Instead of starting at the top with the first item, start at <code>initialScrollIndex</code>. This disables the "scroll to top" optimization that keeps the first <code>initialNumToRender</code> items always rendered and immediately renders the items starting at this initial index. Requires <code>getItemLayout</code> to be implemented.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>number</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="inverted"></a><code>inverted</code><a class="hash-link" href="#inverted" title="Direct link to heading">#</a></h3><p>Reverses the direction of scroll. Uses scale transforms of <code>-1</code>.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>boolean</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="keyextractor"></a><code>keyExtractor</code><a class="hash-link" href="#keyextractor" title="Direct link to heading">#</a></h3><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token punctuation" style="color:#657b83">(</span><span class="token parameter">item</span><span class="token parameter operator" style="color:#fc929e">:</span><span class="token parameter"> object</span><span class="token parameter punctuation" style="color:#657b83">,</span><span class="token parameter"> index</span><span class="token parameter operator" style="color:#fc929e">:</span><span class="token parameter"> number</span><span class="token punctuation" style="color:#657b83">)</span><span class="token plain"> </span><span class="token operator" style="color:#fc929e">=></span><span class="token plain"> string</span><span class="token punctuation" style="color:#657b83">;</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><p>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 <code>item.key</code>, then <code>item.id</code>, and then falls back to using the index, like React does.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>function</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="numcolumns"></a><code>numColumns</code><a class="hash-link" href="#numcolumns" title="Direct link to heading">#</a></h3><p>Multiple columns can only be rendered with <code>horizontal={false}</code> and will zig-zag like a <code>flexWrap</code> layout. Items should all be the same height - masonry layouts are not supported.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>number</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="onendreached"></a><code>onEndReached</code><a class="hash-link" href="#onendreached" title="Direct link to heading">#</a></h3><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token punctuation" style="color:#657b83">(</span><span class="token parameter">info</span><span class="token parameter operator" style="color:#fc929e">:</span><span class="token parameter"> </span><span class="token parameter punctuation" style="color:#657b83">{</span><span class="token parameter">distanceFromEnd</span><span class="token parameter operator" style="color:#fc929e">:</span><span class="token parameter"> number</span><span class="token parameter punctuation" style="color:#657b83">}</span><span class="token punctuation" style="color:#657b83">)</span><span class="token plain"> </span><span class="token operator" style="color:#fc929e">=></span><span class="token plain"> </span><span class="token keyword" style="color:#c5a5c5">void</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><p>Called once when the scroll position gets within <code>onEndReachedThreshold</code> of the rendered content.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>function</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="onendreachedthreshold"></a><code>onEndReachedThreshold</code><a class="hash-link" href="#onendreachedthreshold" title="Direct link to heading">#</a></h3><p>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 <code>onEndReached</code> callback. Thus a value of 0.5 will trigger <code>onEndReached</code> when the end of the content is within half the visible length of the list.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>number</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="onrefresh"></a><code>onRefresh</code><a class="hash-link" href="#onrefresh" title="Direct link to heading">#</a></h3><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token punctuation" style="color:#657b83">(</span><span class="token punctuation" style="color:#657b83">)</span><span class="token plain"> </span><span class="token operator" style="color:#fc929e">=></span><span class="token plain"> </span><span class="token keyword" style="color:#c5a5c5">void</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><p>If provided, a standard RefreshControl will be added for "Pull to Refresh" functionality. Make sure to also set the <code>refreshing</code> prop correctly.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>function</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="onviewableitemschanged"></a><code>onViewableItemsChanged</code><a class="hash-link" href="#onviewableitemschanged" title="Direct link to heading">#</a></h3><p>Called when the viewability of rows changes, as defined by the <code>viewabilityConfig</code> prop.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>(callback: { changed: array of <a href="/docs/next/viewtoken">ViewToken</a>s, viewableItems: array of <a href="/docs/next/viewtoken">ViewToken</a>s }) => void</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="progressviewoffset-android"></a><code>progressViewOffset</code> <div class="label android">Android</div><a class="hash-link" href="#progressviewoffset-android" title="Direct link to heading">#</a></h3><p>Set this when offset is needed for the loading indicator to show correctly.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>number</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="refreshing"></a><code>refreshing</code><a class="hash-link" href="#refreshing" title="Direct link to heading">#</a></h3><p>Set this true while waiting for new data from a refresh.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>boolean</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="removeclippedsubviews"></a><code>removeClippedSubviews</code><a class="hash-link" href="#removeclippedsubviews" title="Direct link to heading">#</a></h3><p>This may improve scroll performance for large lists. On Android the default value is <code>true</code>.</p><blockquote><p>Note: May have bugs (missing content) in some circumstances - use at your own risk.</p></blockquote><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>boolean</td></tr></tbody></table><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="viewabilityconfig"></a><code>viewabilityConfig</code><a class="hash-link" href="#viewabilityconfig" title="Direct link to heading">#</a></h3><p>See <a href="https://github.com/facebook/react-native/blob/master/Libraries/Lists/ViewabilityHelper.js" target="_blank" rel="noopener noreferrer"><code>ViewabilityHelper.js</code></a> for flow type and further documentation.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>ViewabilityConfig</td></tr></tbody></table><p><code>viewabilityConfig</code> takes a type <code>ViewabilityConfig</code> an object with following properties</p><table><thead><tr><th>Property</th><th>Type</th></tr></thead><tbody><tr><td>minimumViewTime</td><td>number</td></tr><tr><td>viewAreaCoveragePercentThreshold</td><td>number</td></tr><tr><td>itemVisiblePercentThreshold</td><td>number</td></tr><tr><td>waitForInteraction</td><td>boolean</td></tr></tbody></table><p>At least one of the <code>viewAreaCoveragePercentThreshold</code> or <code>itemVisiblePercentThreshold</code> is required. This needs to be done in the <code>constructor</code> to avoid following error (<a href="https://github.com/facebook/react-native/issues/17408" target="_blank" rel="noopener noreferrer">ref</a>):</p><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token plain"> Error</span><span class="token operator" style="color:#fc929e">:</span><span class="token plain"> Changing viewabilityConfig on the fly is not supported</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token function" style="color:#79b6f2">constructor</span><span class="token plain"> </span><span class="token punctuation" style="color:#657b83">(</span><span class="token parameter">props</span><span class="token punctuation" style="color:#657b83">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#657b83">{</span><span class="token plain"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token plain"> </span><span class="token keyword" style="color:#c5a5c5">super</span><span class="token punctuation" style="color:#657b83">(</span><span class="token plain">props</span><span class="token punctuation" style="color:#657b83">)</span><span class="token plain"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token plain"> </span><span class="token keyword" style="color:#c5a5c5">this</span><span class="token punctuation" style="color:#657b83">.</span><span class="token plain">viewabilityConfig </span><span class="token operator" style="color:#fc929e">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#657b83">{</span><span class="token plain"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token plain"> waitForInteraction</span><span class="token operator" style="color:#fc929e">:</span><span class="token plain"> </span><span class="token boolean" style="color:#ff8b50">true</span><span class="token punctuation" style="color:#657b83">,</span><span class="token plain"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token plain"> viewAreaCoveragePercentThreshold</span><span class="token operator" style="color:#fc929e">:</span><span class="token plain"> </span><span class="token number" style="color:#5a9bcf">95</span><span class="token plain"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token plain"> </span><span class="token punctuation" style="color:#657b83">}</span><span class="token plain"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token plain"></span><span class="token punctuation" style="color:#657b83">}</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token operator" style="color:#fc929e"><</span><span class="token plain">FlatList</span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token plain"> viewabilityConfig</span><span class="token operator" style="color:#fc929e">=</span><span class="token punctuation" style="color:#657b83">{</span><span class="token keyword" style="color:#c5a5c5">this</span><span class="token punctuation" style="color:#657b83">.</span><span class="token plain">viewabilityConfig</span><span class="token punctuation" style="color:#657b83">}</span><span class="token plain"></span></div><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token plain"> </span><span class="token operator" style="color:#fc929e">...</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><h4><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="minimumviewtime"></a>minimumViewTime<a class="hash-link" href="#minimumviewtime" title="Direct link to heading">#</a></h4><p>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.</p><h4><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="viewareacoveragepercentthreshold"></a>viewAreaCoveragePercentThreshold<a class="hash-link" href="#viewareacoveragepercentthreshold" title="Direct link to heading">#</a></h4><p>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.</p><h4><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="itemvisiblepercentthreshold"></a>itemVisiblePercentThreshold<a class="hash-link" href="#itemvisiblepercentthreshold" title="Direct link to heading">#</a></h4><p>Similar to <code>viewAreaCoveragePercentThreshold</code>, but considers the percent of the item that is visible, rather than the fraction of the viewable area it covers.</p><h4><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="waitforinteraction"></a>waitForInteraction<a class="hash-link" href="#waitforinteraction" title="Direct link to heading">#</a></h4><p>Nothing is considered viewable until the user scrolls or <code>recordInteraction</code> is called after render.</p><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="viewabilityconfigcallbackpairs"></a><code>viewabilityConfigCallbackPairs</code><a class="hash-link" href="#viewabilityconfigcallbackpairs" title="Direct link to heading">#</a></h3><p>List of <code>ViewabilityConfig</code>/<code>onViewableItemsChanged</code> pairs. A specific <code>onViewableItemsChanged</code> will be called when its corresponding <code>ViewabilityConfig</code>'s conditions are met. See <code>ViewabilityHelper.js</code> for flow type and further documentation.</p><table><thead><tr><th>Type</th></tr></thead><tbody><tr><td>array of ViewabilityConfigCallbackPair</td></tr></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="methods"></a>Methods<a class="hash-link" href="#methods" title="Direct link to heading">#</a></h2><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="flashscrollindicators"></a><code>flashScrollIndicators()</code><a class="hash-link" href="#flashscrollindicators" title="Direct link to heading">#</a></h3><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token function" style="color:#79b6f2">flashScrollIndicators</span><span class="token punctuation" style="color:#657b83">(</span><span class="token punctuation" style="color:#657b83">)</span><span class="token punctuation" style="color:#657b83">;</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><p>Displays the scroll indicators momentarily.</p><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="getnativescrollref"></a><code>getNativeScrollRef()</code><a class="hash-link" href="#getnativescrollref" title="Direct link to heading">#</a></h3><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token function" style="color:#79b6f2">getNativeScrollRef</span><span class="token punctuation" style="color:#657b83">(</span><span class="token punctuation" style="color:#657b83">)</span><span class="token punctuation" style="color:#657b83">;</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><p>Provides a reference to the underlying scroll component</p><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="getscrollresponder"></a><code>getScrollResponder()</code><a class="hash-link" href="#getscrollresponder" title="Direct link to heading">#</a></h3><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token function" style="color:#79b6f2">getScrollResponder</span><span class="token punctuation" style="color:#657b83">(</span><span class="token punctuation" style="color:#657b83">)</span><span class="token punctuation" style="color:#657b83">;</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><p>Provides a handle to the underlying scroll responder.</p><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="getscrollablenode"></a><code>getScrollableNode()</code><a class="hash-link" href="#getscrollablenode" title="Direct link to heading">#</a></h3><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token function" style="color:#79b6f2">getScrollableNode</span><span class="token punctuation" style="color:#657b83">(</span><span class="token punctuation" style="color:#657b83">)</span><span class="token punctuation" style="color:#657b83">;</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><p>Provides a handle to the underlying scroll node.</p><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="recordinteraction"></a><code>recordInteraction()</code><a class="hash-link" href="#recordinteraction" title="Direct link to heading">#</a></h3><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token function" style="color:#79b6f2">recordInteraction</span><span class="token punctuation" style="color:#657b83">(</span><span class="token punctuation" style="color:#657b83">)</span><span class="token punctuation" style="color:#657b83">;</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><p>Tells the list an interaction has occurred, which should trigger viewability calculations, e.g. if <code>waitForInteractions</code> is true and the user has not scrolled. This is typically called by taps on items or by navigation actions.</p><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="scrolltoend"></a><code>scrollToEnd()</code><a class="hash-link" href="#scrolltoend" title="Direct link to heading">#</a></h3><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token function" style="color:#79b6f2">scrollToEnd</span><span class="token punctuation" style="color:#657b83">(</span><span class="token plain">params</span><span class="token punctuation" style="color:#657b83">)</span><span class="token punctuation" style="color:#657b83">;</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><p>Scrolls to the end of the content. May be janky without <code>getItemLayout</code> prop.</p><p><strong>Parameters:</strong></p><table><thead><tr><th>Name</th><th>Type</th></tr></thead><tbody><tr><td>params</td><td>object</td></tr></tbody></table><p>Valid <code>params</code> keys are:</p><ul><li>'animated' (boolean) - Whether the list should do an animation while scrolling. Defaults to <code>true</code>.</li></ul><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="scrolltoindex"></a><code>scrollToIndex()</code><a class="hash-link" href="#scrolltoindex" title="Direct link to heading">#</a></h3><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token function" style="color:#79b6f2">scrollToIndex</span><span class="token punctuation" style="color:#657b83">(</span><span class="token plain">params</span><span class="token punctuation" style="color:#657b83">)</span><span class="token punctuation" style="color:#657b83">;</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><p>Scrolls to the item at the specified index such that it is positioned in the viewable area such that <code>viewPosition</code> 0 places it at the top, 1 at the bottom, and 0.5 centered in the middle.</p><blockquote><p>Note: Cannot scroll to locations outside the render window without specifying the <code>getItemLayout</code> prop.</p></blockquote><p><strong>Parameters:</strong></p><table><thead><tr><th>Name</th><th>Type</th></tr></thead><tbody><tr><td>params <div class="label basic required">Required</div></td><td>object</td></tr></tbody></table><p>Valid <code>params</code> keys are:</p><ul><li>'animated' (boolean) - Whether the list should do an animation while scrolling. Defaults to <code>true</code>.</li><li>'index' (number) - The index to scroll to. Required.</li><li>'viewOffset' (number) - A fixed number of pixels to offset the final target position.</li><li>'viewPosition' (number) - A value of <code>0</code> places the item specified by index at the top, <code>1</code> at the bottom, and <code>0.5</code> centered in the middle.</li></ul><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="scrolltoitem"></a><code>scrollToItem()</code><a class="hash-link" href="#scrolltoitem" title="Direct link to heading">#</a></h3><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token function" style="color:#79b6f2">scrollToItem</span><span class="token punctuation" style="color:#657b83">(</span><span class="token plain">params</span><span class="token punctuation" style="color:#657b83">)</span><span class="token punctuation" style="color:#657b83">;</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><p>Requires linear scan through data - use <code>scrollToIndex</code> instead if possible.</p><blockquote><p>Note: Cannot scroll to locations outside the render window without specifying the <code>getItemLayout</code> prop.</p></blockquote><p><strong>Parameters:</strong></p><table><thead><tr><th>Name</th><th>Type</th></tr></thead><tbody><tr><td>params <div class="label basic required">Required</div></td><td>object</td></tr></tbody></table><p>Valid <code>params</code> keys are:</p><ul><li>'animated' (boolean) - Whether the list should do an animation while scrolling. Defaults to <code>true</code>.</li><li>'item' (object) - The item to scroll to. Required.</li><li>'viewPosition' (number)</li></ul><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_E4oP" id="scrolltooffset"></a><code>scrollToOffset()</code><a class="hash-link" href="#scrolltooffset" title="Direct link to heading">#</a></h3><div class="mdxCodeBlock_1daz"><div class="codeBlockContent_2es_"><div tabindex="0" class="prism-code language-jsx codeBlock_27aQ thin-scrollbar"><div class="codeBlockLines_2rCb" style="color:#FFFFFF;background:#282C34"><div class="token-line" style="color:#FFFFFF;background:#282C34"><span class="token function" style="color:#79b6f2">scrollToOffset</span><span class="token punctuation" style="color:#657b83">(</span><span class="token plain">params</span><span class="token punctuation" style="color:#657b83">)</span><span class="token punctuation" style="color:#657b83">;</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2bml">Copy</button></div></div><p>Scroll to a specific content pixel offset in the list.</p><p><strong>Parameters:</strong></p><table><thead><tr><th>Name</th><th>Type</th></tr></thead><tbody><tr><td>params <div class="label basic required">Required</div></td><td>object</td></tr></tbody></table><p>Valid <code>params</code> keys are:</p><ul><li>'offset' (number) - The offset to scroll to. In case of <code>horizontal</code> being true, the offset is the x-value, in any other case the offset is the y-value. Required.</li><li>'animated' (boolean) - Whether the list should do an animation while scrolling. Defaults to <code>true</code>.</li></ul></div></article><div class="docMetadata margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/facebook/react-native-website/blob/master/website/../docs/flatlist.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" role="img" viewBox="0 0 40 40" class="iconEdit_2Hwv"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col text--right"><em><small class="docMetadata-updated">Last updated on <time datetime="2021-02-11T16:33:49.000Z" class="docLastUpdatedAt_1gIo">2/11/2021</time></small></em></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav" aria-label="Blog list page navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/next/button"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« Button</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/next/image"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Image »</div></a></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_1zTD thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#example" class="table-of-contents__link">Example</a></li><li><a href="#props" class="table-of-contents__link">Props</a><ul><li><a href="#scrollview-props" class="table-of-contents__link">ScrollView Props</a></li><li><a href="#required-renderitem" class="table-of-contents__link"><div class="label required basic">Required</div> <strong><code>renderItem</code></strong></a></li><li><a href="#required-data" class="table-of-contents__link"><div class="label required basic">Required</div> <strong><code>data</code></strong></a></li><li><a href="#itemseparatorcomponent" class="table-of-contents__link"><code>ItemSeparatorComponent</code></a></li><li><a href="#listemptycomponent" class="table-of-contents__link"><code>ListEmptyComponent</code></a></li><li><a href="#listfootercomponent" class="table-of-contents__link"><code>ListFooterComponent</code></a></li><li><a href="#listfootercomponentstyle" class="table-of-contents__link"><code>ListFooterComponentStyle</code></a></li><li><a href="#listheadercomponent" class="table-of-contents__link"><code>ListHeaderComponent</code></a></li><li><a href="#listheadercomponentstyle" class="table-of-contents__link"><code>ListHeaderComponentStyle</code></a></li><li><a href="#columnwrapperstyle" class="table-of-contents__link"><code>columnWrapperStyle</code></a></li><li><a href="#extradata" class="table-of-contents__link"><code>extraData</code></a></li><li><a href="#getitemlayout" class="table-of-contents__link"><code>getItemLayout</code></a></li><li><a href="#horizontal" class="table-of-contents__link"><code>horizontal</code></a></li><li><a href="#initialnumtorender" class="table-of-contents__link"><code>initialNumToRender</code></a></li><li><a href="#initialscrollindex" class="table-of-contents__link"><code>initialScrollIndex</code></a></li><li><a href="#inverted" class="table-of-contents__link"><code>inverted</code></a></li><li><a href="#keyextractor" class="table-of-contents__link"><code>keyExtractor</code></a></li><li><a href="#numcolumns" class="table-of-contents__link"><code>numColumns</code></a></li><li><a href="#onendreached" class="table-of-contents__link"><code>onEndReached</code></a></li><li><a href="#onendreachedthreshold" class="table-of-contents__link"><code>onEndReachedThreshold</code></a></li><li><a href="#onrefresh" class="table-of-contents__link"><code>onRefresh</code></a></li><li><a href="#onviewableitemschanged" class="table-of-contents__link"><code>onViewableItemsChanged</code></a></li><li><a href="#progressviewoffset-android" class="table-of-contents__link"><code>progressViewOffset</code> <div class="label android">Android</div></a></li><li><a href="#refreshing" class="table-of-contents__link"><code>refreshing</code></a></li><li><a href="#removeclippedsubviews" class="table-of-contents__link"><code>removeClippedSubviews</code></a></li><li><a href="#viewabilityconfig" class="table-of-contents__link"><code>viewabilityConfig</code></a></li><li><a href="#viewabilityconfigcallbackpairs" class="table-of-contents__link"><code>viewabilityConfigCallbackPairs</code></a></li></ul></li><li><a href="#methods" class="table-of-contents__link">Methods</a><ul><li><a href="#flashscrollindicators" class="table-of-contents__link"><code>flashScrollIndicators()</code></a></li><li><a href="#getnativescrollref" class="table-of-contents__link"><code>getNativeScrollRef()</code></a></li><li><a href="#getscrollresponder" class="table-of-contents__link"><code>getScrollResponder()</code></a></li><li><a href="#getscrollablenode" class="table-of-contents__link"><code>getScrollableNode()</code></a></li><li><a href="#recordinteraction" class="table-of-contents__link"><code>recordInteraction()</code></a></li><li><a href="#scrolltoend" class="table-of-contents__link"><code>scrollToEnd()</code></a></li><li><a href="#scrolltoindex" class="table-of-contents__link"><code>scrollToIndex()</code></a></li><li><a href="#scrolltoitem" class="table-of-contents__link"><code>scrollToItem()</code></a></li><li><a href="#scrolltooffset" class="table-of-contents__link"><code>scrollToOffset()</code></a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><h4 class="footer__title">Docs</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/getting-started">Getting Started</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/tutorial">Tutorial</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/components-and-apis">Components and APIs</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/more-resources">More Resources</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">Community</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/help">The React Native Community</a></li><li class="footer__item"><a class="footer__link-item" href="/showcase">Who's using React Native?</a></li><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/react-native" target="_blank" rel="noopener noreferrer" class="footer__link-item">Ask Questions on Stack Overflow</a></li><li class="footer__item"><a href="https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md" target="_blank" rel="noopener noreferrer" class="footer__link-item">Contributor Guide</a></li><li class="footer__item"><a href="https://dev.to/t/reactnative" target="_blank" rel="noopener noreferrer" class="footer__link-item">DEV Community</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">Find us</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li><li class="footer__item"><a href="https://twitter.com/reactnative" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter</a></li><li class="footer__item"><a href="https://github.com/facebook/react-native" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">More</h4><ul class="footer__items"><li class="footer__item"><a href="https://reactjs.org/" target="_blank" rel="noopener noreferrer" class="footer__link-item">React</a></li><li class="footer__item"><a href="https://opensource.facebook.com/legal/privacy" target="_blank" rel="noopener noreferrer" class="footer__link-item">Privacy Policy</a></li><li class="footer__item"><a href="https://opensource.facebook.com/legal/terms" target="_blank" rel="noopener noreferrer" class="footer__link-item">Terms of Service</a></li></ul></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><a href="https://opensource.facebook.com" target="_blank" rel="noopener noreferrer" class="footerLogoLink_3cAK"><img class="footer__logo" alt="Facebook Open Source Logo" src="/img/oss_logo.png"></a></div><div class="footer__copyright">Copyright © 2021 Facebook, Inc.</div></div></div></footer></div>
|
|
<script src="/styles.dfe3b9eb.js"></script>
|
|
<script src="/runtime~main.5916a0a4.js"></script>
|
|
<script src="/main.6094b97f.js"></script>
|
|
<script src="/1.8c647f8e.js"></script>
|
|
<script src="/2.e133592c.js"></script>
|
|
<script src="/931.624ff15d.js"></script>
|
|
<script src="/935f2afb.abc3c679.js"></script>
|
|
<script src="/17896441.1e68c5df.js"></script>
|
|
<script src="/e532ff9a.cb1660b3.js"></script>
|
|
</body>
|
|
</html> |