ScrollView

一个组件，它封装了平台原生的 ScrollView，同时与触控锁定“响应者”系统集成。

请记住，ScrollView 必须有一个限定的高度才能正常工作，因为它们将高度不限的子组件放到一个有限的容器中（通过滚动交互）。为了限定 ScrollView 的高度，可以直接设置视图的高度（不推荐），或者确保所有父视图都有限定的高度。忘记将 {flex: 1} 传递到视图堆栈中可能会导致错误，元素检查器可以快速调试这些错误。

目前还不支持其他包含的响应者阻止此滚动视图成为响应者。

<ScrollView> vs <FlatList> - 如何选择？

ScrollView 会一次性渲染所有其 React 子组件，但这会带来性能上的负面影响。

想象一下，你有一个非常长的项目列表要显示，可能需要几屏的内容。一次性为所有内容创建 JS 组件和原生视图，其中许多甚至可能不会显示，这将导致渲染缓慢和内存使用增加。

这就是 FlatList 发挥作用的地方。FlatList 会在项目即将出现时懒惰地渲染它们，并移除滚动到屏幕外的项目，以节省内存和处理时间。

如果你想在项目之间渲染分隔符、多列、无限滚动加载或它开箱即用的任何其他功能，FlatList 也非常方便。

示例

参考

属性

视图属性

继承自 View 属性。

`StickyHeaderComponent`

一个 React 组件，用于渲染粘性头部，应与 stickyHeaderIndices 一起使用。如果你的粘性头部使用了自定义转换，例如，当你的列表需要一个动画和可隐藏的头部时，你可能需要设置此组件。如果未提供组件，则将使用默认的 ScrollViewStickyHeader 组件。

类型
组件，元素

`alwaysBounceHorizontal`
iOS

当为 true 时，即使内容小于滚动视图本身，滚动视图在到达末尾时也会水平回弹。

类型	默认
布尔值	当 `horizontal={true}` 时为 `true` 否则为 `false`

`alwaysBounceVertical`
iOS

当为 true 时，即使内容小于滚动视图本身，滚动视图在到达末尾时也会垂直回弹。

类型	默认
布尔值	当 `horizontal={true}` 时为 `false` 否则为 `true`

`automaticallyAdjustContentInsets`
iOS

控制 iOS 是否应自动调整位于导航栏或标签栏/工具栏后面的滚动视图的内容内边距。

类型	默认
布尔值	`true`

`automaticallyAdjustKeyboardInsets`
iOS

控制当键盘大小改变时，ScrollView 是否应自动调整其 contentInset 和 scrollViewInsets。

类型	默认
布尔值	`false`

`automaticallyAdjustsScrollIndicatorInsets`
iOS

控制 iOS 是否应自动调整滚动指示器的内边距。请参阅 Apple 关于该属性的文档。

类型	默认
布尔值	`true`

`bounces`
iOS

当为 true 时，如果内容沿滚动方向大于滚动视图，则滚动视图在到达内容末尾时会回弹。当为 false 时，即使 alwaysBounce* 属性为 true，也会禁用所有回弹。

类型	默认
布尔值	`true`

`bouncesZoom`
iOS

当为 true 时，手势可以驱动缩放超出最小/最大值，并且缩放将在手势结束时动画到最小/最大值，否则缩放将不超过限制。

类型	默认
布尔值	`true`

`canCancelContentTouches`
iOS

当为 false 时，一旦开始跟踪，如果触摸移动，则不会尝试拖动。

类型	默认
布尔值	`true`

`centerContent`
iOS

当为 true 时，当内容小于滚动视图边界时，滚动视图会自动居中内容；当内容大于滚动视图时，此属性无效。

类型	默认
布尔值	`false`

`contentContainerStyle`

这些样式将应用于包裹所有子视图的滚动视图内容容器。示例

return (
  <ScrollView contentContainerStyle={styles.contentContainer}>
  </ScrollView>
);
...
const styles = StyleSheet.create({
  contentContainer: {
    paddingVertical: 20
  }
});

类型
View 样式

`contentInset`
iOS

滚动视图内容从滚动视图边缘嵌入的量。

类型	默认
对象：`{top: number, left: number, bottom: number, right: number}`	`{top: 0, left: 0, bottom: 0, right: 0}`

`contentInsetAdjustmentBehavior`
iOS

此属性指定如何使用安全区域内边距来修改滚动视图的内容区域。在 iOS 11 及更高版本上可用。

类型	默认
枚举 (`'automatic'`, `'scrollableAxes'`, `'never'`, `'always'`)	`'never'`

`contentOffset`

用于手动设置起始滚动偏移量。

类型	默认
点	`{x: 0, y: 0}`

`decelerationRate`

一个浮点数，它决定了用户抬起手指后滚动视图减速的速度。你也可以使用字符串快捷方式 "normal" 和 "fast"，它们分别与底层 iOS 设置中的 UIScrollViewDecelerationRateNormal 和 UIScrollViewDecelerationRateFast 匹配。

iOS 上 'normal' 为 0.998，Android 上为 0.985。
iOS 上 'fast' 为 0.99，Android 上为 0.9。

类型	默认
枚举 (`'fast'`, `'normal'`), 数字	`'normal'`

`directionalLockEnabled`
iOS

当为 true 时，ScrollView 在拖动时将尝试只锁定垂直或水平滚动。

类型	默认
布尔值	`false`

`disableIntervalMomentum`

当为 true 时，无论手势速度多快，滚动视图都会停止在下一个索引（相对于释放时的滚动位置）。这可用于当页面小于水平 ScrollView 的宽度或垂直 ScrollView 的高度时进行分页。

类型	默认
布尔值	`false`

`disableScrollViewPanResponder`

当为 true 时，ScrollView 上的默认 JS 平移响应器将被禁用，并且对 ScrollView 内部触摸的完全控制权将留给其子组件。当启用 snapToInterval 时，这尤其有用，因为它不遵循典型的触摸模式。在没有 snapToInterval 的常规 ScrollView 用例中不要使用此功能，因为它可能会导致滚动时发生意外触摸。

类型	默认
布尔值	`false`

`endFillColor`
Android

有时滚动视图占用的空间比其内容填充的空间大。在这种情况下，此属性将用颜色填充滚动视图的其余部分，以避免设置背景并创建不必要的过度绘制。这是一个高级优化，在一般情况下不需要。

类型
颜色

`fadingEdgeLength`
Android

使滚动内容的边缘淡出。

如果值大于 0，则根据当前的滚动方向和位置相应地设置淡出边缘，指示是否有更多内容可显示。

类型	默认
数字对象：`{start: number, end: number}`	`0`

`horizontal`

当为 true 时，滚动视图的子元素水平排列成一行，而不是垂直排列成一列。

类型	默认
布尔值	`false`

`indicatorStyle`
iOS

滚动指示器的样式。

'default' 与 black 相同。
'black'，滚动指示器为 black。这种样式适用于浅色背景。
'white'，滚动指示器为 white。这种样式适用于深色背景。

类型	默认
枚举 (`'default'`, `'black'`, `'white'`)	`'default'`

`invertStickyHeaders`

如果粘性头部应该粘在 ScrollView 的底部而不是顶部。这通常与反向 ScrollView 一起使用。

类型	默认
布尔值	`false`

`keyboardDismissMode`

决定键盘是否响应拖动而关闭。

'none'，拖动不会关闭键盘。
'on-drag'，拖动开始时键盘关闭。

仅限 iOS

'interactive'，键盘与拖动交互式关闭，并与触摸同步移动，向上拖动会取消关闭。在 Android 上不支持此功能，其行为将与 'none' 相同。

类型	默认
枚举 (`'none'`, `'on-drag'`) Android 枚举 (`'none'`, `'on-drag'`, `'interactive'`) iOS	`'none'`

`keyboardShouldPersistTaps`

决定键盘在点击后何时保持可见。

'never' 当键盘弹出时，点击聚焦文本输入框之外的区域会关闭键盘。发生这种情况时，子组件将不会收到点击事件。
'always'，键盘不会自动关闭，滚动视图也不会捕获点击事件，但滚动视图的子组件可以捕获点击事件。
'handled'，当点击事件由滚动视图的子组件处理（或被祖先捕获）时，键盘不会自动关闭。
false，已弃用，请改用 'never'
true，已弃用，请改用 'always'

类型	默认
枚举 (`'always'`, `'never'`, `'handled'`, `false`, `true`)	`'never'`

`maintainVisibleContentPosition`

设置后，滚动视图将调整滚动位置，以便当前可见且位于或超出 minIndexForVisible 的第一个子元素的位置不会改变。这对于在两个方向加载内容的列表很有用，例如聊天线程，其中新消息的传入可能会导致滚动位置跳动。0 是常见值，但也可以使用其他值，例如 1，以跳过加载微调器或其他不应保持位置的内容。

可选的 autoscrollToTopThreshold 可用于在调整后，如果用户在调整前位于顶部的阈值范围内，则自动将内容滚动到顶部。这对于聊天类应用程序也很有用，您希望看到新消息滚动到位，但如果用户已经向上滚动了一段距离，则大量滚动会造成干扰。

注意事项 1：在此功能启用时对滚动视图中的元素重新排序可能会导致跳动和卡顿。它可以修复，但目前没有计划这样做。现在，不要重新排序任何使用此功能的 ScrollViews 或 Lists 的内容。

注意事项 2：这在原生代码中使用 contentOffset 和 frame.origin 来计算可见性。遮挡、转换和其他复杂性将不被考虑为内容是否“可见”。

类型
对象：`{minIndexForVisible: number, autoscrollToTopThreshold: number}`

`maximumZoomScale`
iOS

允许的最大缩放比例。

类型	默认
数字	`1.0`

`minimumZoomScale`
iOS

允许的最小缩放比例。

类型	默认
数字	`1.0`

`nestedScrollEnabled`
Android

为 Android API 级别 21+ 启用嵌套滚动。

类型	默认
布尔值	`false`

`onContentSizeChange`

当 ScrollView 的可滚动内容视图发生变化时调用。

处理函数将接收两个参数：内容宽度和内容高度 (contentWidth, contentHeight)。

它使用附加到此 ScrollView 渲染的内容容器的 onLayout 处理程序实现。

类型
函数

`onMomentumScrollBegin`

当惯性滚动开始时（ScrollView 开始滑动时发生的滚动）调用。

类型
函数

`onMomentumScrollEnd`

当惯性滚动结束时（ScrollView 滑动停止时发生的滚动）调用。

类型
函数

`onScroll`

在滚动期间每帧最多触发一次。事件具有以下形状（所有未指定类型的值均为数字）

js
{
  nativeEvent: {
    contentInset: {bottom, left, right, top},
    contentOffset: {x, y},
    contentSize: {height, width},
    layoutMeasurement: {height, width},
    velocity: {x, y},
    responderIgnoreScroll: boolean,
    zoomScale,
    // iOS only
    targetContentOffset: {x, y}
  }
}

类型
函数

`onScrollBeginDrag`

当用户开始拖动滚动视图时调用。

类型
函数

`onScrollEndDrag`

当用户停止拖动滚动视图并且它停止或开始滑动时调用。

类型
函数

`onScrollToTop`
iOS

当点击状态栏后滚动视图滚动到顶部时触发。

类型
函数

`overScrollMode`
Android

用于覆盖 overScroll 模式的默认值。

可能的值

'auto' - 仅当内容足够大以至于可以有意义地滚动时，才允许用户过度滚动此视图。
'always' - 始终允许用户过度滚动此视图。
'never' - 绝不允许用户过度滚动此视图。

类型	默认
枚举 (`'auto'`, `'always'`, `'never'`)	`'auto'`

`pagingEnabled`

当为 true 时，滚动视图在滚动时会在滚动视图大小的倍数处停止。这可用于水平分页。

类型	默认
布尔值	`false`

`persistentScrollbar`
Android

导致滚动条在不使用时不会变为透明。

类型	默认
布尔值	`false`

`pinchGestureEnabled`
iOS

当为 true 时，ScrollView 允许使用捏合手势进行放大和缩小。

类型	默认
布尔值	`true`

`refreshControl`

一个 RefreshControl 组件，用于为 ScrollView 提供下拉刷新功能。仅适用于垂直 ScrollView（horizontal 属性必须为 false）。

参见 RefreshControl。

类型
元素

`removeClippedSubviews`

警告

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

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

类型
布尔值

`scrollEnabled`

当为 false 时，视图无法通过触摸交互滚动。

请注意，始终可以通过调用 scrollTo 来滚动视图。

类型	默认
布尔值	`true`

`scrollEventThrottle`

限制滚动时触发滚动事件的频率，以毫秒为单位的时间间隔指定。当响应滚动执行昂贵的工作时，这可能很有用。值 ≤ 16 将禁用节流，无论设备的刷新率如何。

类型	默认
数字	`0`

`scrollIndicatorInsets`
iOS

滚动视图指示器从滚动视图边缘嵌入的量。这通常应设置为与 contentInset 相同的值。

类型	默认
对象：`{top: number, left: number, bottom: number, right: number}`	`{top: 0, left: 0, bottom: 0, right: 0}`

`scrollPerfTag`
Android

用于记录此滚动视图上的滚动性能的标签。将强制开启惯性事件（参见 sendMomentumEvents）。这本身不会做任何事情，你需要实现一个自定义的原生 FpsListener 才能使其有用。

类型
字符串

`scrollToOverflowEnabled`
iOS

当为 true 时，滚动视图可以编程方式滚动超出其内容大小。

类型	默认
布尔值	`false`

`scrollsToTop`
iOS

当为 true 时，当点击状态栏时，滚动视图会滚动到顶部。

类型	默认
布尔值	`true`

`showsHorizontalScrollIndicator`

当为 true 时，显示水平滚动指示器。

类型	默认
布尔值	`true`

`showsVerticalScrollIndicator`

当为 true 时，显示垂直滚动指示器。

类型	默认
布尔值	`true`

`snapToAlignment`

设置 snapToInterval 时，snapToAlignment 将定义捕捉与滚动视图的关系。

可能的值

'start' 将捕捉对齐到左侧（水平）或顶部（垂直）。
'center' 将捕捉对齐到中心。
'end' 将捕捉对齐到右侧（水平）或底部（垂直）。

类型	默认
枚举 (`'start'`, `'center'`, `'end'`)	`'start'`

`snapToEnd`

与 snapToOffsets 结合使用。默认情况下，列表的末尾算作一个捕捉偏移量。将 snapToEnd 设置为 false 以禁用此行为，并允许列表在其末尾和最后一个 snapToOffsets 偏移量之间自由滚动。

类型	默认
布尔值	`true`

`snapToInterval`

设置后，滚动视图将停在 snapToInterval 值的倍数处。这可用于对长度小于滚动视图的子元素进行分页。通常与 snapToAlignment 和 decelerationRate="fast" 结合使用。覆盖可配置性较低的 pagingEnabled 属性。

类型
数字

`snapToOffsets`

设置后，滚动视图将停在定义的偏移量处。这可用于对大小不同且长度小于滚动视图的子元素进行分页。通常与 decelerationRate="fast" 结合使用。覆盖可配置性较低的 pagingEnabled 和 snapToInterval 属性。

类型
数字数组

`snapToStart`

与 snapToOffsets 结合使用。默认情况下，列表的开头算作一个捕捉偏移量。将 snapToStart 设置为 false 以禁用此行为，并允许列表在其开头和第一个 snapToOffsets 偏移量之间自由滚动。

类型	默认
布尔值	`true`

`stickyHeaderHiddenOnScroll`

设置为 true 时，粘性头部将在向下滚动列表时隐藏，并在向上滚动时停靠在列表顶部。

类型	默认
布尔值	`false`

`stickyHeaderIndices`

一个子索引数组，用于确定哪些子元素在滚动时会停靠在屏幕顶部。例如，传递 stickyHeaderIndices={[0]} 将使第一个子元素固定在滚动视图的顶部。您也可以使用 [x,y,z] 使多个项目在到达顶部时保持粘性。此属性不支持与 horizontal={true} 结合使用。

类型
数字数组

`zoomScale`
iOS

滚动视图内容的当前缩放比例。

类型	默认
数字	`1.0`

方法

`flashScrollIndicators()`

tsx
flashScrollIndicators();

短暂显示滚动指示器。

`scrollTo()`

tsx
scrollTo(
  options?: {x?: number, y?: number, animated?: boolean} | number,
  deprecatedX?: number,
  deprecatedAnimated?: boolean,
);

滚动到给定的 x, y 偏移量，可以是立即滚动，也可以是平滑动画。

示例

scrollTo({x: 0, y: 0, animated: true})

注意

奇怪的函数签名是由于历史原因，该函数也接受单独的参数作为选项对象的替代方案。由于歧义（y 在 x 之前），此功能已弃用，不应使用。

`scrollToEnd()`

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

如果这是一个垂直 ScrollView，则滚动到底部。如果这是一个水平 ScrollView，则滚动到右侧。

使用 scrollToEnd({animated: true}) 进行平滑动画滚动，使用 scrollToEnd({animated: false}) 进行立即滚动。如果没有传递任何选项，animated 默认为 true。

示例
属性
方法

示例​

参考

属性​

视图属性​

StickyHeaderComponent​

alwaysBounceHorizontal iOS​

alwaysBounceVertical iOS​

automaticallyAdjustContentInsets iOS​

automaticallyAdjustKeyboardInsets iOS​

automaticallyAdjustsScrollIndicatorInsets iOS​

bounces iOS​

bouncesZoom iOS​

canCancelContentTouches iOS​

centerContent iOS​

contentContainerStyle​

contentInset iOS​

contentInsetAdjustmentBehavior iOS​

contentOffset​

decelerationRate​

directionalLockEnabled iOS​

disableIntervalMomentum​

disableScrollViewPanResponder​

endFillColor Android​

fadingEdgeLength Android​

horizontal​

indicatorStyle iOS​

invertStickyHeaders​

keyboardDismissMode​

keyboardShouldPersistTaps​

maintainVisibleContentPosition​

maximumZoomScale iOS​

minimumZoomScale iOS​

nestedScrollEnabled Android​

onContentSizeChange​

onMomentumScrollBegin​

onMomentumScrollEnd​

onScroll​

onScrollBeginDrag​

onScrollEndDrag​

onScrollToTop iOS​

overScrollMode Android​

pagingEnabled​

persistentScrollbar Android​

pinchGestureEnabled iOS​

refreshControl​

removeClippedSubviews​

scrollEnabled​

scrollEventThrottle​

scrollIndicatorInsets iOS​

scrollPerfTag Android​

scrollToOverflowEnabled iOS​

scrollsToTop iOS​

showsHorizontalScrollIndicator​

showsVerticalScrollIndicator​

snapToAlignment​

snapToEnd​

snapToInterval​

snapToOffsets​

snapToStart​

stickyHeaderHiddenOnScroll​

stickyHeaderIndices​

zoomScale iOS​

方法​

flashScrollIndicators()​

scrollTo()​

scrollToEnd()​

示例

属性