跳到主要内容
版本:0.78

SectionList

一个用于渲染分区列表的高性能接口,支持以下最实用的功能:

  • 完全跨平台。
  • 可配置的可见性回调。
  • 支持列表头部。
  • 支持列表尾部。
  • 支持项分隔符。
  • 支持部分头部。
  • 支持部分分隔符。
  • 支持异构数据和项渲染。
  • 下拉刷新。
  • 滚动加载。

如果你不需要分区支持且想要更简单的接口,请使用 <FlatList>

示例

这是 <VirtualizedList> 的便捷包装器,因此继承了其属性(以及 <ScrollView> 的属性),除非此处明确列出,并注意以下注意事项:

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

参考

属性

VirtualizedList 属性

继承 VirtualizedList 属性


必需
renderItem

每个部分中每个项的默认渲染器。可以按部分覆盖。应返回一个 React 元素。

类型
function

渲染函数将传递一个包含以下键的对象:

  • 'item' (object) - 此部分的 data 键中指定的项对象
  • 'index' (number) - 项在部分内的索引。
  • 'section' (object) - sections 中指定的完整部分对象。
  • 'separators' (object) - 一个包含以下键的对象:
    • 'highlight' (function) - () => void
    • 'unhighlight' (function) - () => void
    • 'updateProps' (function) - (select, newProps) => void
      • 'select' (enum) - 可能的值是 'leading', 'trailing'
      • 'newProps' (object)

必需
sections

实际要渲染的数据,类似于 FlatList 中的 data 属性。

类型
array of Sections

extraData

告诉列表重新渲染的标记属性(因为它实现了 PureComponent)。如果你的任何 renderItem、Header、Footer 等函数依赖于 data 属性之外的任何内容,请将其放在这里并将其视为不可变的。

类型
any

initialNumToRender

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

类型默认值
number10

inverted

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

类型默认值
booleanfalse

ItemSeparatorComponent

渲染在每项之间,但不在顶部或底部。默认情况下,提供 highlightedsection[leading/trailing][Item/Section] 属性。renderItem 提供 separators.highlight/unhighlight 将更新 highlighted 属性,但你也可以使用 separators.updateProps 添加自定义属性。可以是 React Component(例如 SomeComponent),或 React 元素(例如 <SomeComponent />)。

类型
component, function, element

keyExtractor

用于提取指定索引处给定项的唯一键。键用于缓存并作为 React key 跟踪项重新排序。默认提取器检查 item.key,然后 item.id,然后回退到使用索引,就像 React 一样。注意,这为每个项设置键,但每个整体部分仍然需要自己的键。

类型
(item: object, index: number) => string

ListEmptyComponent

当列表为空时渲染。可以是 React Component(例如 SomeComponent),或 React 元素(例如 <SomeComponent />)。

类型
component, element

ListFooterComponent

渲染在列表的非常末尾。可以是 React Component(例如 SomeComponent),或 React 元素(例如 <SomeComponent />)。

类型
component, element

ListHeaderComponent

渲染在列表的非常开头。可以是 React Component(例如 SomeComponent),或 React 元素(例如 <SomeComponent />)。

类型
component, element

onRefresh

如果提供,将为“下拉刷新”功能添加标准的 RefreshControl。确保也正确设置 refreshing 属性。要将 RefreshControl 从顶部偏移(例如 100 pts),使用 progressViewOffset={100}

类型
function

onViewableItemsChanged

当行的可见性变化时调用,由 viewabilityConfig 属性定义。

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

refreshing

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

类型默认值
booleanfalse

removeClippedSubviews

注意:在某些情况下可能有 bug(内容缺失)- 使用风险自负。

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

类型默认值
booleanfalse

renderSectionFooter

渲染在每个部分的底部。

类型
(info: {section: Section}) => element | null

renderSectionHeader

渲染在每个部分的顶部。默认情况下,这些在 iOS 上粘滞在 ScrollView 的顶部。参见 stickySectionHeadersEnabled

类型
(info: {section: Section}) => element | null

SectionSeparatorComponent

渲染在每个部分的顶部和底部(注意这与 ItemSeparatorComponent 不同,后者仅渲染在项之间)。这些旨在将部分与上方和下方的头部分开,通常具有与 ItemSeparatorComponent 相同的高亮响应。还接收 highlighted[leading/trailing][Item/Section] 以及来自 separators.updateProps 的任何自定义属性。

类型
component, element

stickySectionHeadersEnabled

使部分头部粘滞在屏幕顶部,直到下一个头部将其推离。默认仅在 iOS 上启用,因为那是那里的平台标准。

类型默认值
booleanfalse
Android

true
iOS

方法

flashScrollIndicators()
iOS

tsx
flashScrollIndicators();

暂时显示滚动指示器。


recordInteraction()

tsx
recordInteraction();

告诉列表发生了交互,这应该触发可见性计算,例如如果 waitForInteractions 为 true 且用户未滚动。这通常由项上的点击或导航动作调用。


scrollToLocation()

tsx
scrollToLocation(params: SectionListScrollParams);

滚动到指定 sectionIndexitemIndex(在部分内)的项,定位在可见区域,使得 viewPosition 0 将其放置在顶部(可能被粘滞头部覆盖),1 在底部,0.5 在中间居中。

注意:如果不指定 getItemLayoutonScrollToIndexFailed 属性,无法滚动到渲染窗口外的位置。

参数:

名称类型
params
必需
object

params 的有效键是:

  • 'animated' (boolean) - 列表在滚动时是否应该做动画。默认为 true
  • 'itemIndex' (number) - 要滚动到的项在部分内的索引。必需。
  • 'sectionIndex' (number) - 包含要滚动到的项的部分的索引。必需。
  • 'viewOffset' (number) - 偏移最终目标位置的固定像素数,例如补偿粘滞头部。
  • 'viewPosition' (number) - 值 0 将索引指定的项放置在顶部,1 在底部,0.5 在中间居中。

类型定义

Section

一个用于标识给定区段待渲染数据的对象。

类型
any

属性:

名称类型描述
data
必需
array用于渲染该区段中项的数据。对象数组,类似于 FlatList 的 data 属性
keystring可选的 key,用于跟踪区段的重新排序。如果您不打算重新排序区段,默认将使用数组索引。
renderItemfunction可选地为该区段定义任意项渲染器,覆盖列表默认的 renderItem
ItemSeparatorComponentcomponent, element可选地为该区段定义任意项分隔符,覆盖列表默认的 ItemSeparatorComponent
keyExtractorfunction可选地为该区段定义任意 key 提取器,覆盖默认的 keyExtractor