ScrollView

此组件包装了平台 ScrollView，同时提供与触摸锁定 “响应者” 系统的集成。

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

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

<ScrollView> 与 <FlatList> - 应该使用哪一个？

ScrollView 一次性渲染其所有 React 子组件，但这有一个性能上的缺点。

想象一下，你有一个很长的项目列表要显示，可能内容会铺满好几个屏幕。一次性为所有内容（其中大部分甚至可能不会显示）创建 JS 组件和原生视图，将导致渲染缓慢和内存使用量增加。

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

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

示例

参考

属性

View 属性

继承 View 属性。

`StickyHeaderComponent`

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

类型
组件, 元素

`alwaysBounceHorizontal`
iOS

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

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

`alwaysBounceVertical`
iOS

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

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

`automaticallyAdjustContentInsets`
iOS

控制 iOS 是否应自动调整放置在导航栏或标签栏/工具栏后面的滚动视图的内容插contentInset。

类型	默认值
布尔值	`true`

`automaticallyAdjustKeyboardInsets`
iOS

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

类型	默认值
布尔值	`false`

`automaticallyAdjustsScrollIndicatorInsets`
iOS

控制 iOS 是否应自动调整滚动指示器插contentInset。请参阅 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

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

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

`contentOffset`

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

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

`decelerationRate`

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

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

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

`directionalLockEnabled`
iOS

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

类型	默认值
布尔值	`false`

`disableIntervalMomentum`

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

类型	默认值
布尔值	`false`

`disableScrollViewPanResponder`

为 true 时，ScrollView 上的默认 JS pan responder 被禁用，并且对 ScrollView 内部触摸的完全控制权留给其子组件。如果启用了 snapToInterval，这将特别有用，因为它不遵循典型的触摸模式。在没有 snapToInterval 的常规 ScrollView 用例中不要使用此属性，因为它可能会导致滚动时发生意外触摸。

类型	默认值
布尔值	`false`

`endFillColor`
Android

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

类型
颜色

`fadingEdgeLength`
Android

淡化滚动内容的边缘。

如果值大于 0，则将根据当前的滚动方向和位置设置淡化边缘，指示是否还有更多内容要显示。

类型	默认值
数字	`0`

`horizontal`

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

类型	默认值
布尔值	`false`

`indicatorStyle`
iOS

滚动指示器的样式。

'default' 与 black 相同。
'black'，滚动指示器为 黑色。这种样式适用于浅色背景。
'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：启用此功能后，在滚动视图中重新排序元素可能会导致跳动和卡顿。它可以修复，但目前没有计划这样做。目前，不要重新排序使用此功能的任何 ScrollView 或 List 的内容。

注意 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},
    zoomScale
  }
}

类型
函数

`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 时，屏幕外的子视图（其 overflow 值为 hidden）将在屏幕外时从其原生后备父视图中移除。这可以提高长列表的滚动性能。

类型	默认值
布尔值	`false`

`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。

示例
属性
方法

示例​

参考

属性​

View 属性​

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

示例

属性