0.63

帮助改进此文档

SectionList

本文档贡献者：sunnylqm(100.00%)

高性能的分组(section)列表组件，支持下面这些常用的功能：

  • 完全跨平台。
  • 行组件显示或隐藏时可配置回调事件。
  • 支持单独的头部组件。
  • 支持单独的尾部组件。
  • 支持自定义行间分隔线。
  • 支持分组的头部组件。
  • 支持分组的分隔线。
  • 支持多种数据源结构
  • 支持下拉刷新。
  • 支持上拉加载。

如果你的列表不需要分组(section)，那么可以使用结构更简单的<FlatList>。

Example

本组件实质是基于<VirtualizedList>组件的封装，继承了其所有 props（也包括所有<ScrollView>)的 props）。此外还有下面这些需要注意的事项：

  • 当某行滑出渲染区域之外后，其内部状态将不会保留。请确保你在行组件以外的地方保留了数据。
  • 本组件继承自PureComponent而非通常的Component，这意味着如果其props在浅比较中是相等的，则不会重新渲染。所以请先检查你的renderItem函数所依赖的props数据（包括data属性以及可能用到的父组件的 state），如果是一个引用类型（Object 或者数组都是引用类型），则需要先修改其引用地址（比如先复制到一个新的 Object 或者数组中），然后再修改其值，否则界面很可能不会刷新。（译注：这一段不了解的朋友建议先学习下js 中的基本类型和引用类型。）
  • 为了优化内存占用同时保持滑动的流畅，列表内容会在屏幕外异步绘制。这意味着如果用户滑动的速度超过渲染的速度，则会先看到空白的内容。这是为了优化不得不作出的妥协，而我们也在设法持续改进。
  • 默认情况下每行都需要提供一个不重复的 key 属性。你也可以提供一个keyExtractor函数来生成 key。

文档

Props

Inherits ScrollView Props.

sections

用来渲染的数据，类似于FlatList中的data属性。

类型必填
array of Sections是

initialNumToRender

指定一开始渲染的元素数量，最好刚刚够填满一个屏幕，这样保证了用最短的时间给用户呈现可见的内容。注意这第一批次渲染的元素不会在滑动过程中被卸载，这样是为了保证用户执行返回顶部的操作时，不需要重新渲染首批元素。

类型必填
number否

keyExtractor

此函数用于为给定的 item 生成一个不重复的 key。Key 的作用是使 React 能够区分同类元素的不同个体，以便在刷新时能够确定其变化的位置，减少重新渲染的开销。若不指定此函数，则默认抽取 item.key 作为 key 值。若 item.key 也不存在，则使用数组下标。注意这只设置了每行（item）的 key，对于每个组（section）仍然需要另外设置 key。

类型必填
(item: Item, index: number) => string是

renderItem

用来渲染每一个 section 中的每一个列表项的默认渲染器。可以在 section 级别上进行覆盖重写。必须返回一个 react 组件。

类型必填
function是

The render function will be passed an object with the following keys:

  • 'item' (object) - the item object as specified in this section's data key
  • 'index' (number) - Item's index within the section.
  • 'section' (object) - The full section object as specified in sections.
  • 'separators' (object) - An object with the following keys:
    • 'highlight' (function) - () => void
    • 'unhighlight' (function) - () => void
    • 'updateProps' (function) - (select, newProps) => void
      • 'select' (enum) - possible values are 'leading', 'trailing'
      • 'newProps' (object)

onEndReached

当列表被滚动到距离内容最底部不足onEndReachedThreshold的距离时调用。

类型必填
[(info: {distanceFromEnd: number}) => void]否

extraData

如果有除data以外的数据用在列表中（不论是用在renderItem还是 Header 或者 Footer 中），请在此属性中指定。同时此数据在修改时也需要先修改其引用地址（比如先复制到一个新的 Object 或者数组中），然后再修改其值，否则界面很可能不会刷新。

类型必填
any否

ItemSeparatorComponent

行与行之间的分隔线组件。不会出现在第一行之前和最后一行之后。By default, highlighted, section, and [leading/trailing][Item/Separator] props are provided. renderItem provides separators.highlight/unhighlight which will update the highlighted prop, but you can also add custom props with separators.updateProps.

类型必填
[component, function, element]否

inverted

翻转滚动方向。实质是将 scale 变换设置为-1。

类型必填
[boolean]否

ListFooterComponent

尾部组件。

类型必填
[component, function, element]否

ListEmptyComponent

当列表数据为空时渲染的组件。

类型必填
[component, function, element]否

onEndReachedThreshold

决定当距离内容最底部还有多远时触发onEndReached回调。注意此参数是一个比值而非像素单位。比如，0.5 表示距离内容最底部的距离为当前列表可见长度的一半时触发。

类型必填
[number]否

onRefresh

如果设置了此选项，则会在列表头部添加一个标准的RefreshControl控件，以便实现“下拉刷新”的功能。同时你需要正确设置refreshing属性。如果你想把刷新控件往下移动一些（比如 100 个 pt），可以设置progressViewOffset={100}。

类型必填
[() => void]否

onViewableItemsChanged

在可见行元素变化时调用。可见范围和变化频率等参数的配置请设置viewabilityConfig属性。

类型必填
function否

The function will be passed an object with the following keys:

  • 'viewableItems' (array of ViewTokens)
  • 'changed' (array of ViewTokens)

The ViewToken type is exported by ViewabilityHelper.js:

名称类型必填
itemany是
keystring是
indexnumber否
isViewableboolean是
sectionany否

refreshing

在等待加载新数据时将此属性设为 true，列表就会显示出一个正在加载的符号。

类型必填
[boolean]否

removeClippedSubviews

Note: may have bugs (missing content) in some circumstances - use at your own risk.

This may improve scroll performance for large lists.

类型必填
boolean否

ListHeaderComponent

头部组件。

类型必填
component, function, element否

renderSectionFooter

每个组的尾部组件。

类型必填
[(info: {section: SectionT}) => ?React.Element]否

renderSectionHeader

在每个 section 的头部渲染。在 iOS 上，这些 headers 是默认粘接在ScrollView的顶部的. 参见[stickySectionHeadersEnabled]。

类型必填
[(info: {section: SectionT}) => ?React.Element]否

SectionSeparatorComponent

在每个section的顶部和底部渲染(区别于ItemSeparatorComponent，它仅在列表项之间渲染)。它的作用是为了从视觉上把section与它上方或下方的headers区别开来，从这个意义上讲，它的作用和ItemSeparatorComponent是一样的. 它也接受highlighted, [leading/trailing][Item/Separator]这两个默认提供的属性或其他通过separators.updateProps添加的自定义属性.

类型必填
[ReactClass]否

stickySectionHeadersEnabled

当下一个 section 把它的前一个 section 的可视区推离屏幕的时候，让这个 section 的 header 粘连在屏幕的顶端。这个属性在 iOS 上是默认可用的，因为这是 iOS 的平台规范。

类型必填
boolean否

方法

scrollToLocation()

scrollToLocation(params);

将可视区内位于特定sectionIndex 或 itemIndex (section 内)位置的列表项，滚动到可视区的制定位置。比如说，viewPosition 为 0 时将这个列表项滚动到可视区顶部 (可能会被顶部粘接的 header 覆盖), 为 1 时将它滚动到可视区底部, 为 0.5 时将它滚动到可视区中央。

注意: 如果没有设置getItemLayout或是onScrollToIndexFailed，就不能滚动到位于外部渲染区的位置。

参数：

名称类型必填说明
paramsobject是看下面的说明

Valid params keys are:

  • 'animated' (boolean) - Whether the list should do an animation while scrolling. Defaults to true.
  • 'itemIndex' (number) - Index within section for the item to scroll to. Required.
  • 'sectionIndex' (number) - Index for section that contains the item to scroll to. Required.
  • 'viewOffset' (number) - 一个以像素为单位，到最终位置偏移距离的固定值，比如为了弥补粘接的 header 所占据的空间。
  • 'viewPosition' (number) - A value of 0 places the item specified by index at the top, 1 at the bottom, and 0.5 centered in the middle.

recordInteraction()

recordInteraction();

主动通知列表发生了一个事件，以使列表重新计算可视区域。比如说当waitForInteractions 为 true 并且用户没有滚动列表时，就可以调用这个方法。不过一般来说，当用户点击了一个列表项，或发生了一个导航动作时，我们就可以调用这个方法。

flashScrollIndicators()

flashScrollIndicators();

短暂地显示滚动指示器。

类型定义

Section

An object that identifies the data to be rendered for a given section.

类型
any

属性：

名称类型说明
dataarrayThe data for rendering items in this section. Array of objects, much like FlatList的 data 属性.
[key]stringOptional key to keep track of section re-ordering. If you don't plan on re-ordering sections, the array index will be used by default.
[renderItem]functionOptionally define an arbitrary item renderer for this section, overriding the default renderItem for the list.
[ItemSeparatorComponent]component, function, elementOptionally define an arbitrary item separator for this section, overriding the default ItemSeparatorComponent for the list.
[keyExtractor]functionOptionally define an arbitrary key extractor for this section, overriding the default keyExtractor.
← ScrollViewStatusBar →