跳到主要内容

FlatList

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

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

如果需要section支持，请使用 <SectionList>。

示例​

要渲染多列，请使用 numColumns 属性。使用这种方法代替 flexWrap 布局可以防止与项目高度逻辑冲突。

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

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

这是 <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 (对象): 从 data 渲染的项目。
  • index (数字): 此项目在 data 数组中对应的索引。
  • separators (对象)
    • highlight (函数)
    • unhighlight (函数)
    • updateProps (函数)
      • select (枚举('leading', 'trailing'))
      • newProps (对象)

用法示例

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 属性。renderItem 提供 separators.highlight/unhighlight，这将更新 highlighted 属性，但你也可以使用 separators.updateProps 添加自定义属性。可以是 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 属性之外的任何内容，请将其放在此处并将其视为不可变的。

类型
任意类型

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 布局一样呈锯齿状。项目应具有相同的高度 - 不支持 masonry 布局。

类型
数字

onRefresh​

tsx
() => void;

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

类型
函数

onViewableItemsChanged​

当行的可视性更改时调用，由 viewabilityConfig 属性定义。

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

progressViewOffset​

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

类型
数字

refreshing​

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

类型
布尔值

removeClippedSubviews​

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

注意：在某些情况下可能存在错误（内容丢失） - 使用风险自负。

类型
布尔值

viewabilityConfig​

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

类型
ViewabilityConfig

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

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

至少需要 viewAreaCoveragePercentThreshold 或 itemVisiblePercentThreshold 之一。这需要在 constructor 中完成，以避免以下错误 (ref)

  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。有关 flow 类型和更多文档，请参阅 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' (布尔值) - 列表在滚动时是否应执行动画。默认为 true。

scrollToIndex()​

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

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

注意：在未指定 getItemLayout 属性的情况下，无法滚动到渲染窗口之外的位置。

参数

名称类型
params
必需
对象

有效的 params 键是

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

scrollToItem()​

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

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

注意：在未指定 getItemLayout 属性的情况下，无法滚动到渲染窗口之外的位置。

参数

名称类型
params
必需
对象

有效的 params 键是

  • 'animated' (布尔值) - 列表在滚动时是否应执行动画。默认为 true。
  • 'item' (对象) - 要滚动到的项目。必需。
  • 'viewPosition' (数字)

scrollToOffset()​

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

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

参数

名称类型
params
必需
对象

有效的 params 键是

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