VirtualizedList

这是更方便的 <FlatList> 和 <SectionList> 组件的基础实现，它们也拥有更完善的文档。一般来说，只有当你需要比 FlatList 提供更多灵活性时才应使用此组件，例如与不可变数据而非普通数组一起使用。

通过维护一个有限的活动项目渲染窗口，并将渲染窗口之外的所有项目替换为适当大小的空白区域，虚拟化极大地提高了大型列表的内存消耗和性能。窗口会根据滚动行为进行调整，如果项目距离可见区域较远，则以低优先级（在任何正在运行的交互之后）进行增量渲染；否则以高优先级渲染，以最大程度地减少看到空白区域的可能性。

示例

TypeScript
JavaScript

一些注意事项

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

参考

属性

ScrollView Props

继承 ScrollView 属性。

`data`

不透明数据类型，传递给 `getItem` 和 `getItemCount` 以检索项目。

类型
任何

必需
`getItem`

tsx
(data: any, index: number) => any;

一个通用访问器，用于从任何类型的数据块中提取项目。

类型
函数

必需
`getItemCount`

tsx
(data: any) => number;

确定数据块中有多少项。

类型
函数

必需
`renderItem`

tsx
(info: any) => ?React.Element<any>

从 `data` 中获取一个项目并将其渲染到列表中

类型
函数

`CellRendererComponent`

CellRendererComponent 允许自定义由 `renderItem`/`ListItemComponent` 渲染的单元格在底层 ScrollView 中如何封装。此组件必须接受事件处理程序，以通知 VirtualizedList 单元格内的更改。

类型
`React.ComponentType<CellRendererProps>`

`ItemSeparatorComponent`

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

类型
组件，函数，元素

`ListEmptyComponent`

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

类型
组件，元素

`ListItemComponent`

每个数据项都使用此元素渲染。可以是 React 组件类或渲染函数。

类型
组件，函数

`ListFooterComponent`

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

类型
组件，元素

`ListFooterComponentStyle`

`ListFooterComponent` 内部视图的样式。

类型	必需
ViewStyleProp	否

`ListHeaderComponent`

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

类型
组件，元素

`ListHeaderComponentStyle`

ListHeaderComponent 的内部 View 样式。

类型
View 样式

`debug`

debug 将启用额外的日志记录和视觉叠加，以帮助调试使用和实现，但会显着影响性能。

类型
布尔值

`disableVirtualization`

已弃用。虚拟化提供了显著的性能和内存优化，但会完全卸载渲染窗口之外的 React 实例。您应该只在调试时禁用此功能。

类型
布尔值

`extraData`

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

类型
任何

`getItemLayout`

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

类型
函数

`horizontal`

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

类型
布尔值

`initialNumToRender`

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

类型	默认
数字	`10`

`initialScrollIndex`

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

类型
数字

`inverted`

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

类型
布尔值

`keyExtractor`

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

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

类型
函数

`maxToRenderPerBatch`

每个增量渲染批次中要渲染的最大项目数。一次渲染的越多，填充率越好，但响应能力可能会受到影响，因为渲染内容可能会干扰响应按钮点击或其他交互。

类型
数字

`onEndReached`

当滚动位置距离列表逻辑末尾在 `onEndReachedThreshold` 范围内时，调用一次。

类型
`(info: {distanceFromEnd: number}) => void`

`onEndReachedThreshold`

列表的尾部边缘与内容末尾的距离（以列表可见长度为单位）必须达到多远才能触发 `onEndReached` 回调。因此，值为 0.5 将在内容末尾距离列表可见长度的一半范围内触发 `onEndReached`。

类型	默认
数字	`2`

`onRefresh`

tsx
() => void;

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

类型
函数

`onScrollToIndexFailed`

tsx
(info: {
  index: number,
  highestMeasuredFrameIndex: number,
  averageItemLength: number,
}) => void;

用于处理滚动到尚未测量的索引时的失败。推荐的做法是计算自己的偏移量并 `scrollTo` 它，或者尽可能滚动然后等待更多项目渲染后再重试。

类型
函数

`onStartReached`

当滚动位置距离列表逻辑起始点在 `onStartReachedThreshold` 范围内时，调用一次。

类型
`(info: {distanceFromStart: number}) => void`

`onStartReachedThreshold`

列表的前沿与内容开头之间的距离（以列表可见长度为单位）必须达到多远才能触发 `onStartReached` 回调。因此，值为 0.5 将在内容开头距离列表可见长度的一半范围内触发 `onStartReached`。

类型	默认
数字	`2`

`onViewableItemsChanged`

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

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

`persistentScrollbar`

类型
布尔值

`progressViewOffset`

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

类型
数字

`refreshControl`

一个自定义的刷新控制元素。设置后，它将覆盖内部构建的默认 `<RefreshControl>` 组件。`onRefresh` 和 `refreshing` 属性也将被忽略。仅适用于垂直 VirtualizedList。

类型
元素

`refreshing`

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

类型
布尔值

`removeClippedSubviews`

这可能会提高大型列表的滚动性能。

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

类型
布尔值

`renderScrollComponent`

tsx
(props: object) => element;

渲染自定义滚动组件，例如具有不同样式 `RefreshControl` 的组件。

类型
函数

`viewabilityConfig`

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

类型
ViewabilityConfig

`viewabilityConfigCallbackPairs`

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

类型
ViewabilityConfigCallbackPair 数组

`updateCellsBatchingPeriod`

低优先级项目渲染批次之间的时间量，例如，用于渲染远离屏幕的项目。与 `maxToRenderPerBatch` 具有相似的填充率/响应能力权衡。

类型
数字

`windowSize`

确定渲染在可见区域之外的最大项目数，以可见长度为单位。因此，如果您的列表填满了屏幕，那么 `windowSize={21}`（默认值）将渲染可见屏幕区域，以及视口上方和下方最多 10 个屏幕。减少此数字将减少内存消耗并可能提高性能，但会增加快速滚动可能会显示未渲染内容的瞬时空白区域的可能性。

类型
数字

方法

`flashScrollIndicators()`

tsx
flashScrollIndicators();

`getScrollableNode()`

tsx
getScrollableNode(): any;

`getScrollRef()`

tsx
getScrollRef():
  | React.ElementRef<typeof ScrollView>
  | React.ElementRef<typeof View>
  | null;

`getScrollResponder()`

tsx
getScrollResponder () => ScrollResponderMixin | null;

提供对底层滚动响应器的句柄。请注意，`this._scrollRef` 可能不是 `ScrollView`，因此在调用它之前需要检查它是否响应 `getScrollResponder`。

`scrollToEnd()`

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

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

参数

姓名	类型
参数	对象

有效的 `params` 键是

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

`scrollToIndex()`

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

有效的 `params` 包括

'index' (数字)。必填。
'animated' (布尔值)。可选。
'viewOffset' (数字)。可选。
'viewPosition' (数字)。可选。

`scrollToItem()`

tsx
scrollToItem(params: {
  item: ItemT;
  animated?: boolean;
  viewOffset?: number;
  viewPosition?: number;
);

有效的 `params` 包括

'item' (项目)。必填。
'animated' (布尔值)。可选。
'viewOffset' (数字)。可选。
'viewPosition' (数字)。可选。

`scrollToOffset()`

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

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

参数 `offset` 期望滚动到的偏移量。如果 `horizontal` 为 true，则偏移量为 x 值，否则为 y 值。

参数 `animated`（默认为 `true`）定义列表滚动时是否应执行动画。

示例​

参考

属性​

ScrollView Props​

data​

必需 getItem​

必需 getItemCount​

必需 renderItem​

CellRendererComponent​

ItemSeparatorComponent​

ListEmptyComponent​

ListItemComponent​

ListFooterComponent​

ListFooterComponentStyle​

ListHeaderComponent​

ListHeaderComponentStyle​

debug​

disableVirtualization​

extraData​

getItemLayout​

horizontal​

initialNumToRender​

initialScrollIndex​

inverted​

keyExtractor​

maxToRenderPerBatch​

onEndReached​

onEndReachedThreshold​

onRefresh​

onScrollToIndexFailed​

onStartReached​

onStartReachedThreshold​

onViewableItemsChanged​

persistentScrollbar​

progressViewOffset​

refreshControl​

refreshing​

removeClippedSubviews​

renderScrollComponent​

viewabilityConfig​

viewabilityConfigCallbackPairs​

updateCellsBatchingPeriod​

windowSize​

方法​

flashScrollIndicators()​

getScrollableNode()​

getScrollRef()​

getScrollResponder()​

scrollToEnd()​

scrollToIndex()​

scrollToItem()​

scrollToOffset()​

示例

属性