FlatList
一个用于渲染基本扁平列表的高性能界面，支持最常用的功能
- 完全跨平台。
- 可选水平模式。
- 可配置的可视性回调。
- 支持头部。
- 支持尾部。
- 支持分隔符。
- 下拉刷新。
- 滚动加载。
- 支持滚动到指定索引。
- 支持多列。
如果您需要分段支持，请使用 <SectionList>。
示例
- TypeScript
- JavaScript
要渲染多列，请使用 numColumns 属性。使用这种方法而不是 flexWrap 布局可以避免与项目高度逻辑发生冲突。
下面是一个更复杂的可选择示例。
- 通过将
extraData={selectedId}传递给FlatList，我们确保当状态发生变化时，FlatList本身会重新渲染。如果不设置此属性，FlatList将不知道它需要重新渲染任何项目，因为它是一个PureComponent，并且属性比较不会显示任何更改。 keyExtractor告诉列表使用id作为 React 键，而不是默认的key属性。
- TypeScript
- JavaScript
这是一个围绕 <VirtualizedList> 的便捷包装器，因此继承了其属性（以及未在此处明确列出的 <ScrollView> 的属性），以及以下注意事项
- 当内容滚动出渲染窗口时，内部状态不会被保留。确保所有数据都捕获在项目数据或外部存储（如 Flux、Redux 或 Relay）中。
- 这是一个
PureComponent，这意味着如果props保持浅层相等，它将不会重新渲染。确保renderItem函数依赖的所有内容都作为属性（例如extraData）传递，并且在更新后不为===，否则您的 UI 在更改时可能不会更新。这包括data属性和父组件状态。 - 为了限制内存并启用平滑滚动，内容会在屏幕外异步渲染。这意味着滚动速度可能快于填充率，并且可能短暂地看到空白内容。这是一个折衷方案，可以根据每个应用程序的需求进行调整，我们正在幕后努力改进它。
- 默认情况下，列表会在每个项目上查找
key属性，并将其用作 React 键。或者，您可以提供自定义的keyExtractor属性。
参考
属性
VirtualizedList 属性
必填 renderItem
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(对象)
使用示例
<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
(data, index) => {length: number, offset: number, index: number}
getItemLayout 是一种可选的优化，如果您可以提前知道项目的尺寸（高度或宽度），则可以跳过动态内容的测量。例如，如果您有固定尺寸的项目，则 getItemLayout 非常有效
getItemLayout={(data, index) => (
{length: ITEM_HEIGHT, offset: ITEM_HEIGHT * index, index}
)}
为包含数百个项目的列表添加 getItemLayout 可以极大地提高性能。如果您指定了 ItemSeparatorComponent，请记住在偏移量计算中包含分隔符的长度（高度或宽度）。
| 类型 |
|---|
| 函数 |
horizontal
如果为 true，则水平渲染项目，而不是垂直堆叠。
| 类型 |
|---|
| 布尔值 |
initialNumToRender
在初始批次中渲染多少个项目。这应该足以填充屏幕，但不要太多。请注意，为了提高滚动到顶部操作的感知性能，这些项目永远不会作为窗口化渲染的一部分卸载。
| 类型 | 默认值 |
|---|---|
| 数字 | 10 |
initialScrollIndex
不是从第一个项目开始在顶部开始，而是从 initialScrollIndex 开始。这将禁用“滚动到顶部”优化，该优化始终保持前 initialNumToRender 个项目已渲染，并立即渲染从该初始索引开始的项目。需要实现 getItemLayout。
| 类型 |
|---|
| 数字 |
inverted
反转滚动方向。使用 -1 的缩放变换。
| 类型 |
|---|
| 布尔值 |
keyExtractor
(item: ItemT, index: number) => string;
用于为指定索引处的给定项目提取唯一键。键用于缓存以及作为 React 键来跟踪项目的重新排序。默认提取器检查 item.key，然后检查 item.id，然后回退到使用索引，就像 React 所做的那样。
| 类型 |
|---|
| 函数 |
numColumns
只有在 horizontal={false} 时才能渲染多列，并且会像 flexWrap 布局一样之字形排列。所有项目的高度都应该相同 - 不支持砌体布局。
| 类型 |
|---|
| 数字 |
onRefresh
() => void;
如果提供，则会添加一个标准的 RefreshControl 以实现“下拉刷新”功能。确保也正确设置了 refreshing 属性。
| 类型 |
|---|
| 函数 |
onViewableItemsChanged
当行的可视性发生更改时调用，如 viewabilityConfig 属性所定义。
| 类型 |
|---|
(回调：{changed: ViewToken[]，viewableItems: ViewToken[]} => void; |
progressViewOffset
当加载指示器需要偏移量以正确显示时设置此值。
| 类型 |
|---|
| 数字 |
refreshing
在等待来自刷新的新数据时将此设置为 true。
| 类型 |
|---|
| 布尔值 |
removeClippedSubviews
这可能会提高大型列表的滚动性能。在 Android 上，默认值为 true。
注意：在某些情况下可能会出现错误（内容丢失） - 使用风险自负。
| 类型 |
|---|
| 布尔值 |
viewabilityConfig
请参阅 ViewabilityHelper.js 以获取流类型和更多文档。
| 类型 |
|---|
| ViewabilityConfig |
viewabilityConfig 采用类型 ViewabilityConfig，一个具有以下属性的对象
| 属性 | 类型 |
|---|---|
| minimumViewTime | 数字 |
| viewAreaCoveragePercentThreshold | 数字 |
| itemVisiblePercentThreshold | 数字 |
| waitForInteraction | 布尔值 |
至少需要 viewAreaCoveragePercentThreshold 或 itemVisiblePercentThreshold 中的一个。这需要在 constructor 中完成，以避免以下错误（参考）
Error: Changing viewabilityConfig on the fly is not supported
constructor (props) {
super(props)
this.viewabilityConfig = {
waitForInteraction: true,
viewAreaCoveragePercentThreshold: 95
}
}
<FlatList
viewabilityConfig={this.viewabilityConfig}
...
minimumViewTime
项目在触发可见性回调之前必须实际可见的最小时间（以毫秒为单位）。较高的数值意味着在不停止的情况下滚动内容不会将内容标记为可见。
viewAreaCoveragePercentThreshold
对于部分遮挡的项目，视口必须覆盖的百分比，才能将其视为“可见”，范围为 0-100。完全可见的项目始终被视为可见。值为 0 表示视口中单个像素使项目可见，值为 100 表示项目必须完全可见或覆盖整个视口才能被视为可见。
itemVisiblePercentThreshold
类似于 viewAreaCoveragePercentThreshold，但考虑的是可见项目的百分比，而不是它覆盖的可视区域的比例。
waitForInteraction
在用户滚动或渲染后调用 recordInteraction 之前，不会将任何内容视为可见。
viewabilityConfigCallbackPairs
ViewabilityConfig/onViewableItemsChanged 对的列表。当其对应的 ViewabilityConfig 条件满足时，将调用特定的 onViewableItemsChanged。有关流程类型和更多文档，请参阅 ViewabilityHelper.js。
| 类型 |
|---|
| ViewabilityConfigCallbackPair 数组 |
方法
flashScrollIndicators()
flashScrollIndicators();
短暂显示滚动指示器。
getNativeScrollRef()
getNativeScrollRef(): React.ElementRef<typeof ScrollViewComponent>;
提供对底层滚动组件的引用。
getScrollResponder()
getScrollResponder(): ScrollResponderMixin;
提供对底层滚动响应者的句柄。
getScrollableNode()
getScrollableNode(): any;
提供对底层滚动节点的句柄。
scrollToEnd()
scrollToEnd(params?: {animated?: boolean});
滚动到内容的末尾。如果没有 getItemLayout 属性，可能会出现卡顿。
参数
| 名称 | 类型 |
|---|---|
| params | 对象 |
有效的 params 键为
- 'animated'（布尔值） - 列表在滚动时是否应该执行动画。默认为
true。
scrollToIndex()
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()
scrollToItem(params: {
animated?: ?boolean,
item: Item,
viewPosition?: number,
});
需要对数据进行线性扫描 - 如果可能，请改用 scrollToIndex。
注意：如果没有指定
getItemLayout属性，则无法滚动到渲染窗口之外的位置。
参数
| 名称 | 类型 |
|---|---|
| params 必填 | 对象 |
有效的 params 键为
- 'animated'（布尔值） - 列表在滚动时是否应该执行动画。默认为
true。 - 'item'（对象） - 要滚动到的项目。必需。
- 'viewPosition'（数字）
scrollToOffset()
scrollToOffset(params: {
offset: number;
animated?: boolean;
});
滚动到列表中的特定内容像素偏移量。
参数
| 名称 | 类型 |
|---|---|
| params 必填 | 对象 |
有效的 params 键为
- 'offset'（数字） - 要滚动到的偏移量。如果
horizontal为 true，则偏移量为 x 值，否则偏移量为 y 值。必需。 - 'animated'（布尔值） - 列表在滚动时是否应该执行动画。默认为
true。