FlatList

一个用于渲染基本、扁平列表的高性能接口，支持最便捷的功能

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

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

示例

TypeScript
JavaScript

要渲染多列，请使用numColumns属性。使用此方法而不是flexWrap布局可以避免与项目高度逻辑冲突。

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

通过将extraData={selectedId}传递给FlatList，我们确保当状态改变时FlatList本身会重新渲染。如果不设置此属性，FlatList将不知道需要重新渲染任何项，因为它是一个PureComponent，并且属性比较不会显示任何更改。
keyExtractor告诉列表使用id作为React的键，而不是默认的key属性。

TypeScript
JavaScript

这是<VirtualizedList>的便捷包装器，因此继承了它的属性（以及<ScrollView>的属性），这些属性未在此处明确列出，并附带以下注意事项：

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

参考

属性

VirtualizedList 属性

继承VirtualizedList 属性。

必需
`renderItem`

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属性）不足以满足你的用例。

类型
函数

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

用法示例

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 />）。

类型
组件、函数、元素

`ListEmptyComponent`

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

类型
组件、元素

`ListFooterComponent`

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

类型
组件、元素

`ListFooterComponentStyle`

ListFooterComponent内部View的样式。

类型
视图样式

`ListHeaderComponent`

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

类型
组件、元素

`ListHeaderComponentStyle`

ListHeaderComponent内部View的样式。

类型
视图样式

`columnWrapperStyle`

当numColumns > 1时生成的、多项行的可选自定义样式。

类型
视图样式

`extraData`

一个标记属性，用于通知列表重新渲染（因为它实现了PureComponent）。如果你的renderItem、Header、Footer等函数依赖于data属性之外的任何内容，请将其放在此处并以不可变的方式处理它。

类型
任何

`getItemLayout`

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

getItemLayout是一个可选的优化，如果你提前知道项的大小（高度或宽度），则可以跳过动态内容的测量。如果你有固定大小的项，例如，getItemLayout是高效的。

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

添加getItemLayout可以极大地提升数百项列表的性能。如果指定了ItemSeparatorComponent，请记住在偏移量计算中包含分隔符长度（高度或宽度）。

类型
函数

`horizontal`

如果为true，则水平渲染项，而不是垂直堆叠。

类型
布尔值

`initialNumToRender`

初始批次中渲染的项数。这应该足以填满屏幕，但不要太多。请注意，这些项作为窗口化渲染的一部分，永远不会被卸载，以提高滚动到顶部操作的感知性能。

类型	默认
数字	`10`

`initialScrollIndex`

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

类型
数字

`inverted`

反转滚动方向。使用-1的比例变换。

类型
布尔值

`keyExtractor`

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

用于为指定索引处的给定项提取唯一键。键用于缓存和作为React键来跟踪项的重新排序。默认提取器检查item.key，然后是item.id，然后回退到使用索引，就像React一样。

类型
函数

`numColumns`

多列只能在horizontal={false}下渲染，并且会像flexWrap布局一样之字形排列。所有项的高度应相同——不支持砌体布局。

类型
数字

`onRefresh`

tsx
() => void;

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

类型
函数

`onViewableItemsChanged`

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

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

`progressViewOffset`

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

类型
数字

`refreshing`

在等待刷新新数据时，将其设置为true。

类型
布尔值

`removeClippedSubviews`

这可能会提高大型列表的滚动性能。在Android上，默认值为true。

注意：在某些情况下可能存在错误（内容缺失）——请自行承担风险。

类型
布尔值

`viewabilityConfig`

有关流类型和更多文档，请参阅ViewabilityHelper.js。

类型
ViewabilityConfig

viewabilityConfig接受一个类型为ViewabilityConfig的对象，该对象具有以下属性：

属性	类型
minimumViewTime	数字
viewAreaCoveragePercentThreshold	数字
itemVisiblePercentThreshold	数字
waitForInteraction	布尔值

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

  Error: Changing viewabilityConfig on the fly is not supported

tsx
constructor (props) {
  super(props)

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

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

minimumViewTime

项在可见性回调触发之前必须实际可见的最短时间量（以毫秒为单位）。较高的数字意味着不停止地滚动内容不会将内容标记为可见。

viewAreaCoveragePercentThreshold

部分遮挡的项被视为“可见”时，必须覆盖视口百分比，范围为0-100。完全可见的项始终被视为可见。值为0表示视口中的单个像素使该项可见，值为100表示该项必须完全可见或覆盖整个视口才能被视为可见。

itemVisiblePercentThreshold

类似于viewAreaCoveragePercentThreshold，但考虑的是项可见的百分比，而不是它覆盖的可见区域的比例。

waitForInteraction

在用户滚动或渲染后调用recordInteraction之前，没有任何内容被视为可见。

`viewabilityConfigCallbackPairs`

ViewabilityConfig/onViewableItemsChanged对的列表。当相应的ViewabilityConfig的条件满足时，将调用特定的onViewableItemsChanged。有关流类型和更多文档，请参阅ViewabilityHelper.js。

类型
ViewabilityConfigCallbackPair数组

方法

`flashScrollIndicators()`

tsx
flashScrollIndicators();

暂时显示滚动指示器。

`getNativeScrollRef()`

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

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

`getScrollResponder()`

tsx
getScrollResponder(): ScrollResponderMixin;

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

`getScrollableNode()`

tsx
getScrollableNode(): any;

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

`scrollToEnd()`

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

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

参数

名称	类型
params	对象

有效的params键是：

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

`scrollToIndex()`

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

滚动到指定索引处的项，使其位于可见区域，其中viewPosition为0表示顶部，1表示底部，0.5表示中间。

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

参数

名称	类型
params 必需	对象

有效的params键是：

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

`scrollToItem()`

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

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

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

参数

名称	类型
params 必需	对象

有效的params键是：

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

`scrollToOffset()`

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

滚动到列表中特定的内容像素偏移量。

参数

名称	类型
params 必需	对象

有效的params键是：

'offset' (number) - 要滚动的偏移量。如果horizontal为true，则偏移量为x值，否则为y值。必需。
'animated' (boolean) - 列表滚动时是否进行动画。默认为true。

示例​

参考

属性​

VirtualizedList 属性​

必需 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 属性

必需
`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()`