VirtualizedList

更方便的 <FlatList> 和 <SectionList> 组件的基础实现，这些组件也拥有更好的文档。通常，只有在您需要比 FlatList 提供的更多灵活性时才应使用此组件，例如，用于处理不可变数据而不是普通数组。

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

示例

TypeScript
JavaScript

一些注意事项

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

参考

属性

ScrollView 属性

继承 ScrollView 属性。

`data`

传递给 getItem 和 getItemCount 以检索项目的 opaque 数据类型。

类型
any

必填
`getItem`

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

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

类型
function

必填
`getItemCount`

(data: any) => number;

确定数据块中有多少个项目。

类型
function

必填
`renderItem`

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

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

类型
function

`CellRendererComponent`

CellRendererComponent 允许自定义在将 renderItem/ListItemComponent 渲染的单元格放置到底层 ScrollView 中时如何包装这些单元格。此组件必须接受事件处理程序，这些处理程序会通知 VirtualizedList 单元格内的更改。

类型
`React.ComponentType<CellRendererProps>`

`ItemSeparatorComponent`

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

类型
component, function, element

`ListEmptyComponent`

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

类型
component, element

`ListItemComponent`

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

类型
component, function

`ListFooterComponent`

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

类型
component, element

`ListFooterComponentStyle`

ListFooterComponent 内部 View 的样式。

类型	必填
ViewStyleProp	否

`ListHeaderComponent`

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

类型
component, element

`ListHeaderComponentStyle`

ListHeaderComponent 内部 View 的样式。

类型
View Style

`debug`

debug 将开启额外的日志记录和视觉叠加层，以帮助调试使用和实现，但会带来明显的性能损失。

类型
boolean

`disableVirtualization`

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

类型
boolean

`extraData`

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

类型
any

`getItemLayout`

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

类型
function

`horizontal`

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

类型
boolean

`initialNumToRender`

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

类型	默认值
number	`10`

`initialScrollIndex`

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

类型
number

`inverted`

反转滚动方向。使用 -1 的缩放变换。

类型
boolean

`keyExtractor`

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

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

类型
function

`maxToRenderPerBatch`

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

类型
number

`onEndReached`

当滚动位置到达列表逻辑末尾的 onEndReachedThreshold 范围内时，调用一次。

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

`onEndReachedThreshold`

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

类型	默认值
number	`2`

`onRefresh`

() => void;

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

类型
function

`onScrollToIndexFailed`

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

用于处理滚动到尚未测量索引时的故障。建议的操作是：要么计算您自己的偏移量并使用 scrollTo 滚动到该偏移量，要么尽可能地滚动，然后在渲染更多项目后重试。

类型
function

`onStartReached`

当滚动位置到达列表逻辑起点的 onStartReachedThreshold 范围内时，调用一次。

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

`onStartReachedThreshold`

列表的前缘距内容起始位置的距离（以列表可见长度为单位），当达到此距离时将触发 onStartReached 回调。因此，值为 0.5 将在内容的起始位置位于列表可见长度的一半范围内时触发 onStartReached。

类型	默认值
number	`2`

`onViewableItemsChanged`

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

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

`persistentScrollbar`

类型
布尔值

`progressViewOffset`

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

类型
number

`refreshControl`

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

类型
元素

`refreshing`

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

类型
boolean

`removeClippedSubviews`

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

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

类型
boolean

`renderScrollComponent`

(props: object) => element;

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

类型
function

`viewabilityConfig`

请参阅 ViewabilityHelper.js 以了解流类型和更多文档。

类型
ViewabilityConfig

`viewabilityConfigCallbackPairs`

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

类型
ViewabilityConfigCallbackPair 数组

`updateCellsBatchingPeriod`

低优先级项目渲染批次之间的时间间隔，例如渲染屏幕外相当远的项目。与 maxToRenderPerBatch 类似的填充率/响应能力权衡。

类型
number

`windowSize`

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

类型
number

方法

`flashScrollIndicators()`

flashScrollIndicators();

`getScrollableNode()`

getScrollableNode(): any;

`getScrollRef()`

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

`getScrollResponder()`

getScrollResponder () => ScrollResponderMixin | null;

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

`scrollToEnd()`

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

滚动到内容的末尾。在没有 getItemLayout 属性的情况下可能会出现卡顿。

参数

名称	类型
参数	对象

有效的 params 键为

'animated'（布尔值） - 列表在滚动时是否应执行动画。默认为 true。

`scrollToIndex()`

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

有效的 params 包括

'index'（数字）。必需。
'animated'（布尔值）。可选。
'viewOffset'（数字）。可选。
'viewPosition'（数字）。可选。

`scrollToItem()`

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

有效的 params 包括

'item'（项目）。必需。
'animated'（布尔值）。可选。
'viewOffset'（数字）。可选。
'viewPosition'（数字）。可选。

`scrollToOffset()`

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

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

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

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

示例​

参考

属性​

ScrollView 属性​

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

示例

属性