FlatList

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

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

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

示例

TypeScript

JavaScript

要渲染多列，请使用 numColumns prop。使用这种方法而不是 flexWrap 布局可以防止与项目高度逻辑发生冲突。

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

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

TypeScript

JavaScript

这是 <VirtualizedList> 的一个便利包装器，因此继承了其属性（以及 <ScrollView> 的属性），除非此处明确列出，同时具有以下注意事项：

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

---

参考

属性

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 函数，它允许你设置任何想要更改的 prop，以改变前导分隔符或尾随分隔符的渲染，以防更常见的 highlight 和 unhighlight（它们设置 highlighted: boolean prop）不足以满足你的用例。

类型
函数

• item (Object): 来自 data 正在被渲染的项目。
• index (number): 该项目在 data 数组中对应的索引。
• separators (Object)
  • highlight (函数)
  • unhighlight (函数)
  • updateProps (函数)
    • 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 来使用其他数据类型。

类型
类数组

---

ItemSeparatorComponent

渲染在每两项之间，但不在顶部或底部。默认情况下，提供 highlighted 和 leadingItem props。renderItem 提供 separators.highlight/unhighlight 将更新 highlighted prop，但你也可以使用 separators.updateProps 添加自定义 props。可以是 React 组件（例如 SomeComponent），或 React 元素（例如 <SomeComponent />）。

类型
组件，函数，元素

---

ListEmptyComponent

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

类型
组件，元素

---

ListFooterComponent

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

类型
组件，元素

---

ListFooterComponentStyle

ListFooterComponent 内部 View 的样式。

类型
View 样式

---

ListHeaderComponent

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

类型
组件，元素

---

ListHeaderComponentStyle

ListHeaderComponent 内部 View 的样式。

类型
View 样式

---

columnWrapperStyle

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

类型
View 样式

---

extraData

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

类型
any

---

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 prop。

类型
函数

---

onViewableItemsChanged

当行的可见性发生变化时调用，由 viewabilityConfig prop 定义。

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

---

progressViewOffset

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

类型
数字

---

refreshing

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

类型
布尔值

---

removeClippedSubviews

注意

在某些情况下使用此属性可能会导致错误（内容丢失）- 请自担风险使用。

当为 true 时，离屏子视图在离屏时会从其原生备份父视图中移除。这可能会提高大列表的滚动性能。在 Android 上，默认值为 true。

类型
布尔值

---

viewabilityConfig

参见 ViewabilityHelper.js 了解 flow 类型和进一步文档。

类型
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 了解 flow 类型和进一步文档。

类型
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	object

有效的 params 键包括：

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

---

scrollToIndex()

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

tsx

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

需要线性扫描数据 - 如果可能，请使用 scrollToIndex 代替。

备注

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

参数：

名称	类型
params 必需	object

有效的 params 键包括：

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

---

scrollToOffset()

tsx

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

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

参数：

名称	类型
params 必需	object

有效的 params 键包括：

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