FlatList

一个用于渲染基础扁平列表的高性能接口，支持最实用的功能：

完全跨平台。
可选的水平模式。
可配置的可见性回调。
支持头部。
支持尾部。
支持分隔线。
下拉刷新。
滚动加载。
支持 ScrollToIndex。
支持多列。

如果你需要分组支持，请使用 <SectionList>。

示例

TypeScript
JavaScript

要渲染多列，请使用 numColumns 属性。使用这种方式而不是 flexWrap 布局，可以避免与条目高度逻辑产生冲突。

下面是一个更复杂、可选择的示例。

通过向 FlatList 传递 extraData={selectedId}，我们可以确保当状态变化时 FlatList 本身会重新渲染。如果不设置这个属性，FlatList 不会知道它需要重新渲染任何条目，因为它是一个 PureComponent，而属性比较不会显示任何变化。
keyExtractor 会告诉列表使用 id 作为 react key，而不是默认的 key 属性。

TypeScript
JavaScript

这是对 <VirtualizedList> 的一个便捷封装，因此它继承了这里未明确列出的其属性（以及 <ScrollView> 的属性），并附带以下注意事项：

当内容滚出渲染窗口时，内部状态不会被保留。请确保所有数据都已捕获在条目数据中，或像 Flux、Redux、Relay 这样的外部存储中。
这是一个 PureComponent，这意味着如果 props 保持浅层相等，它不会重新渲染。请确保 renderItem 函数依赖的所有内容都作为一个不会在更新后仍然 === 的属性（例如 extraData）传入，否则你的界面可能不会在变化时更新。这也包括 data 属性和父组件状态。
为了限制内存并实现平滑滚动，内容会在屏幕外异步渲染。这意味着滚动速度可能快于填充速率，并且会短暂看到空白内容。这是一个权衡，可以根据每个应用的需求进行调整，我们也在幕后努力改进它。
默认情况下，列表会查找每个条目的 key 属性，并将其用作 React key。或者，你可以提供一个自定义的 keyExtractor 属性。

参考

属性

VirtualizedList Props

继承 VirtualizedList Props。

必需
`renderItem`

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

从 data 中取出一个条目并将其渲染到列表中。

它提供了额外的元数据，例如你需要时可以使用的 index，以及一个更通用的 separators.updateProps 函数，允许你设置任何想要的属性，以改变前导分隔线或尾随分隔线的渲染方式，以防更常见的 highlight 和 unhighlight（它们会设置 highlighted: boolean 属性）无法满足你的用例。

类型
function

item (Object)：正在渲染的 data 中的条目。
index (number)：该条目在 data 数组中的对应索引。
separators (Object)
- highlight (Function)
- unhighlight (Function)
- updateProps (Function)
  - select (enum('leading', 'trailing'))
  - newProps (Object)

示例用法：

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

必需
`data`

要渲染的条目数组（或类数组列表）。其他数据类型可以通过直接使用 VirtualizedList 来支持。

类型
ArrayLike

`ItemSeparatorComponent`

渲染在每个条目之间，但不在顶部或底部。默认提供 highlighted 和 leadingItem 属性。renderItem 会提供 separators.highlight/unhighlight，它们会更新 highlighted 属性，但你也可以通过 separators.updateProps 添加自定义属性。可以是 React 组件（例如 SomeComponent），也可以是 React 元素（例如 <SomeComponent />）。

类型
component, function, element

`ListEmptyComponent`

列表为空时渲染。可以是 React 组件（例如 SomeComponent），也可以是 React 元素（例如 <SomeComponent />）。

类型
component, element

`ListFooterComponent`

在所有条目的底部渲染。可以是 React 组件（例如 SomeComponent），也可以是 React 元素（例如 <SomeComponent />）。

类型
component, element

`ListFooterComponentStyle`

用于 ListFooterComponent 内部 View 的样式。

类型
View Style

`ListHeaderComponent`

在所有条目的顶部渲染。可以是 React 组件（例如 SomeComponent），也可以是 React 元素（例如 <SomeComponent />）。

类型
component, element

`ListHeaderComponentStyle`

用于 ListHeaderComponent 内部 View 的样式。

类型
View Style

`columnWrapperStyle`

当 numColumns > 1 时，为生成的多条目行提供可选的自定义样式。

类型
View Style

`extraData`

用于告诉列表重新渲染的标记属性（因为它实现了 PureComponent）。如果你的 renderItem、Header、Footer 等函数依赖于 data 属性之外的任何内容，就把它放在这里，并以不可变方式对待它。

类型
any

`getItemLayout`

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

getItemLayout 是一个可选的优化，如果你提前知道条目的尺寸（高度或宽度），它可以跳过动态内容的测量。如果你的条目尺寸固定，getItemLayout 会很高效，例如：

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

如果你指定了 ItemSeparatorComponent，请记得在计算 offset 时包含分隔线长度（高度或宽度）。为列表中的几百个条目添加 getItemLayout 可以显著提升性能。

类型
function

`horizontal`

如果为 true，则水平而不是垂直地并排渲染条目。

类型
boolean

`initialNumToRender`

初始批次中要渲染多少条目。这应该足以填满屏幕，但不要多得太多。请注意，为了提升滚动回到顶部时的感知性能，这些条目将永远不会作为窗口化渲染的一部分被卸载。

类型	默认值
number	`10`

`initialScrollIndex`

不要从顶部的第一个条目开始，而是从 initialScrollIndex 开始。这会禁用“滚动到顶部”优化，该优化会让前 initialNumToRender 个条目始终保持渲染，并立即渲染从这个初始索引开始的条目。需要实现 getItemLayout。

类型
number

`inverted`

反转滚动方向。使用 -1 的缩放变换。

类型
boolean

`keyExtractor`

React TSX
(item: ItemT, index: number) => string;

用于为指定索引处的给定条目提取唯一 key。key 用于缓存以及作为 react key 来跟踪条目重排序。默认提取器会先检查 item.key，然后是 item.id，最后像 React 一样回退到使用索引。

类型
function

`numColumns`

多列只能在 horizontal={false} 时渲染，并且会像 flexWrap 布局那样呈锯齿形排列。条目应保持相同高度——不支持 masonry 布局。

类型
number

`onRefresh`

React TSX
() => void;

如果提供，会添加一个标准的 RefreshControl 来实现“下拉刷新”功能。请确保同时正确设置 refreshing 属性。

类型
function

`onViewableItemsChanged`

当行的可见性变化时调用，如 viewabilityConfig 属性所定义。

类型
`(callback: {changed: ViewToken[], viewableItems: ViewToken[]} => void;`

`progressViewOffset`

当需要偏移量才能正确显示加载指示器时设置此项。

类型
number

`refreshing`

在等待刷新后的新数据时将此项设为 true。

类型
boolean

`removeClippedSubviews`

注意

使用此属性在某些情况下可能会导致 bug（内容缺失）——请自行承担风险。

当为 true 时，屏幕外的子视图在离开屏幕时会从其原生宿主视图中移除。这可能会提升大型列表的滚动性能。在 Android 上，默认值为 true。

类型
boolean

`viewabilityConfig`

有关 flow 类型和进一步文档，请参见 ViewabilityHelper.js。

类型
ViewabilityConfig

viewabilityConfig 接收一个类型为 ViewabilityConfig 的对象，包含以下属性

属性	类型
minimumViewTime	number
viewAreaCoveragePercentThreshold	number
itemVisiblePercentThreshold	number
waitForInteraction	boolean

viewAreaCoveragePercentThreshold 或 itemVisiblePercentThreshold 至少需要设置一个。这需要在 constructor 中完成，以避免以下错误（参考）：

  Error: Changing viewabilityConfig on the fly is not supported

React TSX
constructor (props) {
  super(props)

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

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

minimumViewTime

条目在视图中实际可见之前，视图可见性回调被触发所需的最短时间（毫秒）。数值较高意味着在不停止的情况下滚动内容不会将内容标记为可见。

viewAreaCoveragePercentThreshold

视口被部分遮挡的条目要被计为“可见”所需的覆盖百分比，范围为 0-100。完全可见的条目始终被视为可见。值为 0 表示视口中的一个像素就会使条目可见，值为 100 表示条目必须完全可见或覆盖整个视口才会被计为可见。

itemVisiblePercentThreshold

与 viewAreaCoveragePercentThreshold 类似，但考虑的是条目本身可见的百分比，而不是它所覆盖的可见区域比例。

waitForInteraction

在用户滚动或渲染后调用 recordInteraction 之前，不会将任何内容视为可见。

`viewabilityConfigCallbackPairs`

ViewabilityConfig/onViewableItemsChanged 配对列表。当某个 ViewabilityConfig 的条件满足时，会调用其对应的 onViewableItemsChanged。有关 flow 类型和进一步文档，请参见 ViewabilityHelper.js。

类型
ViewabilityConfigCallbackPair 数组

方法

`flashScrollIndicators()`

React TSX
flashScrollIndicators();

短暂显示滚动指示器。

`getNativeScrollRef()`

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

提供对底层滚动组件的引用

`getScrollResponder()`

React TSX
getScrollResponder(): ScrollResponderMixin;

提供对底层滚动响应器的句柄。

`getScrollableNode()`

React TSX
getScrollableNode(): any;

提供对底层可滚动节点的句柄。

`scrollToEnd()`

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

滚动到内容末尾。如果没有 getItemLayout 属性，可能会出现卡顿。

参数：

名称	类型
params	object

有效的 params 键如下：

'animated' (boolean) - 滚动时列表是否执行动画。默认值为 true。

`scrollToIndex()`

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

滚动到指定索引的项目，使其位于可视区域内，其中 viewPosition 为 0 时放在顶部，1 时放在底部，0.5 时居中。

备注

如果不指定 getItemLayout 属性，则无法滚动到渲染窗口之外的位置。

参数：

名称	类型
params 必需	object

有效的 params 键如下：

'animated' (boolean) - 滚动时列表是否执行动画。默认值为 true。
'index' (number) - 要滚动到的索引。必需。
'viewOffset' (number) - 用于偏移最终目标位置的固定像素值。
'viewPosition' (number) - 值为 0 时将索引指定的项目放在顶部，1 时放在底部，0.5 时居中。

`scrollToItem()`

React TSX
scrollToItem(params: {
  animated?: ?boolean,
  item: Item,
  viewPosition?: number,
});

需要对数据进行线性扫描——如果可能，请改用 scrollToIndex。

备注

如果不指定 getItemLayout 属性，则无法滚动到渲染窗口之外的位置。

参数：

名称	类型
params 必需	object

有效的 params 键如下：

'animated' (boolean) - 滚动时列表是否执行动画。默认值为 true。
'item' (object) - 要滚动到的项目。必需。
'viewPosition' (number)

`scrollToOffset()`

React TSX
scrollToOffset(params: {
  offset: number;
  animated?: boolean;
});

滚动到列表中指定的内容像素偏移位置。

参数：

名称	类型
params 必需	object

有效的 params 键如下：

'offset' (number) - 要滚动到的偏移量。如果 horizontal 为 true，则偏移量是 x 值；在其他情况下，偏移量是 y 值。必需。
'animated' (boolean) - 滚动时列表是否执行动画。默认值为 true。

示例​

参考

属性​

VirtualizedList Props​

必需 renderItem​

必需 data​

ItemSeparatorComponent​

ListEmptyComponent​

ListFooterComponent​

ListFooterComponentStyle​

ListHeaderComponent​

ListHeaderComponentStyle​

columnWrapperStyle​

extraData​

getItemLayout​

horizontal​

initialNumToRender​

initialScrollIndex​

inverted​

keyExtractor​

numColumns​

onRefresh​

onViewableItemsChanged​

progressViewOffset​

refreshing​

removeClippedSubviews​

viewabilityConfig​

minimumViewTime​

viewAreaCoveragePercentThreshold​

itemVisiblePercentThreshold​

waitForInteraction​

viewabilityConfigCallbackPairs​

方法​

flashScrollIndicators()​

getNativeScrollRef()​

getScrollResponder()​

getScrollableNode()​

scrollToEnd()​

scrollToIndex()​

scrollToItem()​

scrollToOffset()​

示例

属性

VirtualizedList Props

必需
`renderItem`

必需
`data`

`ItemSeparatorComponent`

`ListEmptyComponent`

`ListFooterComponent`

`ListFooterComponentStyle`

`ListHeaderComponent`

`ListHeaderComponentStyle`

`columnWrapperStyle`

`extraData`

`getItemLayout`

`horizontal`

`initialNumToRender`

`initialScrollIndex`

`inverted`

`keyExtractor`

`numColumns`

`onRefresh`

`onViewableItemsChanged`

`progressViewOffset`

`refreshing`

`removeClippedSubviews`

`viewabilityConfig`

minimumViewTime

viewAreaCoveragePercentThreshold

itemVisiblePercentThreshold

waitForInteraction

`viewabilityConfigCallbackPairs`

方法

`flashScrollIndicators()`

`getNativeScrollRef()`

`getScrollResponder()`

`getScrollableNode()`

`scrollToEnd()`

`scrollToIndex()`

`scrollToItem()`

`scrollToOffset()`