VirtualizedList

更方便的 <FlatList> 和 <SectionList> 组件的基础实现，这些组件也有更好的文档。一般来说，只有当你需要比 FlatList 提供更大的灵活性时，才应该真正使用它，例如用于不可变数据而不是普通数组。

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

示例

TypeScript
JavaScript

一些注意事项

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

参考

属性

ScrollView Props

继承 ScrollView Props。

`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 props。 renderItem 提供 separators.highlight/unhighlight，它将更新 highlighted prop，但你也可以使用 separators.updateProps 添加自定义 props。可以是 React 组件（例如 SomeComponent），也可以是 React 元素（例如 <SomeComponent />）。

类型
组件，函数，元素

`ListEmptyComponent`

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

类型
组件，元素

`ListItemComponent`

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

类型
组件，函数

`ListFooterComponent`

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

类型
组件，元素

`ListFooterComponentStyle`

ListFooterComponent 内部 View 的样式。

类型	必需
ViewStyleProp	否

`ListHeaderComponent`

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

类型
组件，元素

`ListHeaderComponentStyle`

ListHeaderComponent 内部 View 的样式。

类型
View 样式

`debug`

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

类型
布尔值

`disableVirtualization`

已弃用

虚拟化提供了显著的性能和内存优化，但会完全卸载渲染窗口之外的 react 实例。你通常只需要出于调试目的禁用此功能。

类型
布尔值

`extraData`

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

类型
任何

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

类型
函数

`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 props 也将被忽略。仅适用于垂直 VirtualizedList。

类型
元素

`refreshing`

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

类型
布尔值

`removeClippedSubviews`

警告

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

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

类型
布尔值

`renderScrollComponent`

tsx
(props: object) => element;

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

类型
函数

`viewabilityConfig`

请参阅 ViewabilityHelper.js 以获取 flow 类型和更多文档。

类型
ViewabilityConfig

`viewabilityConfigCallbackPairs`

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

类型
ViewabilityConfigCallbackPair 数组

`updateCellsBatchingPeriod`

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

类型
数字

`windowSize`

确定在可见区域外渲染的最大项目数，以可见长度为单位。因此，如果你的列表填满了屏幕，那么 windowSize={21}（默认值）将渲染可见屏幕区域加上视口上方最多 10 个屏幕和下方最多 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 之前检查它是否响应 getScrollResponder。

`scrollToEnd()`

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

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

参数

姓名	类型
参数	对象

有效的 `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()​

示例

属性