ScrollView
Component that wraps platform ScrollView while providing integration with touch locking "responder" system.
Keep in mind that ScrollViews must have a bounded height in order to work, since they contain unbounded-height children into a bounded container (via a scroll interaction). In order to bound the height of a ScrollView, either set the height of the view directly (discouraged) or make sure all parent views have bounded height. Forgetting to transfer {flex: 1} down the view stack can lead to errors here, which the element inspector makes quick to debug.
Doesn't yet support other contained responders from blocking this scroll view from becoming the responder.
<ScrollView> vs <FlatList> - which one to use?
ScrollView renders all its react child components at once, but this has a performance downside.
Imagine you have a very long list of items you want to display, maybe several screens worth of content. Creating JS components and native views for everything all at once, much of which may not even be shown, will contribute to slow rendering and increased memory usage.
This is where FlatList comes into play. FlatList renders items lazily, when they are about to appear, and removes items that scroll way off screen to save memory and processing time.
FlatList is also handy if you want to render separators between your items, multiple columns, infinite scroll loading, or any number of other features it supports out of the box.
Exampleโ
Reference
Propsโ
View Propsโ
Inherits View Props.
StickyHeaderComponentโ
A React Component that will be used to render sticky headers, should be used together with stickyHeaderIndices. You may need to set this component if your sticky header uses custom transforms, for example, when you want your list to have an animated and hidable header. If a component has not been provided, the default ScrollViewStickyHeader component will be used.
| Type |
|---|
| component, element |
alwaysBounceHorizontal iOSโ
When true, the scroll view bounces horizontally when it reaches the end even if the content is smaller than the scroll view itself.
| Type | Default |
|---|---|
| bool | true when horizontal={true}false otherwise |
alwaysBounceVertical iOSโ
When true, the scroll view bounces vertically when it reaches the end even if the content is smaller than the scroll view itself.
| Type | Default |
|---|---|
| bool | false when horizontal={true}true otherwise |
automaticallyAdjustContentInsets iOSโ
Controls whether iOS should automatically adjust the content inset for scroll views that are placed behind a navigation bar or tab bar/toolbar.
| Type | Default |
|---|---|
| bool | true |
automaticallyAdjustKeyboardInsets iOSโ
Controls whether the ScrollView should automatically adjust its contentInset and scrollViewInsets when the Keyboard changes its size.
| Type | Default |
|---|---|
| bool | false |
automaticallyAdjustsScrollIndicatorInsets iOSโ
Controls whether iOS should automatically adjust the scroll indicator insets. See Apple's documentation on the property.
| Type | Default |
|---|---|
| bool | true |
bounces iOSโ
When true, the scroll view bounces when it reaches the end of the content if the content is larger than the scroll view along the axis of the scroll direction. When false, it disables all bouncing even if the alwaysBounce* props are true.
| Type | Default |
|---|---|
| bool | true |
bouncesZoom iOSโ
When true, gestures can drive zoom past min/max and the zoom will animate to the min/max value at gesture end, otherwise the zoom will not exceed the limits.
| Type | Default |
|---|---|
| bool | true |
canCancelContentTouches iOSโ
When false, once tracking starts, won't try to drag if the touch moves.
| Type | Default |
|---|---|
| bool | true |
centerContent iOSโ
When true, the scroll view automatically centers the content when the content is smaller than the scroll view bounds; when the content is larger than the scroll view, this property has no effect.
| Type | Default |
|---|---|
| bool | false |
contentContainerStyleโ
These styles will be applied to the scroll view content container which wraps all of the child views. Example:
return (
<ScrollView contentContainerStyle={styles.contentContainer}>
</ScrollView>
);
...
const styles = StyleSheet.create({
contentContainer: {
paddingVertical: 20
}
});
| Type |
|---|
| View Style |
contentInset iOSโ
The amount by which the scroll view content is inset from the edges of the scroll view.
| Type | Default |
|---|---|
object: {top: number, left: number, bottom: number, right: number} | {top: 0, left: 0, bottom: 0, right: 0} |
contentInsetAdjustmentBehavior iOSโ
This property specifies how the safe area insets are used to modify the content area of the scroll view. Available on iOS 11 and later.
| Type | Default |
|---|---|
enum('automatic', 'scrollableAxes', 'never', 'always') | 'never' |
contentOffsetโ
Used to manually set the starting scroll offset.
| Type | Default |
|---|---|
| Point | {x: 0, y: 0} |
decelerationRateโ
A floating-point number that determines how quickly the scroll view decelerates after the user lifts their finger. You may also use string shortcuts "normal" and "fast" which match the underlying iOS settings for UIScrollViewDecelerationRateNormal and UIScrollViewDecelerationRateFast respectively.
'normal'0.998 on iOS, 0.985 on Android.'fast', 0.99 on iOS, 0.9 on Android.
| Type | Default |
|---|---|
enum('fast', 'normal'), number | 'normal' |
directionalLockEnabled iOSโ
When true, the ScrollView will try to lock to only vertical or horizontal scrolling while dragging.
| Type | Default |
|---|---|
| bool | false |
disableIntervalMomentumโ
When true, the scroll view stops on the next index (in relation to scroll position at release) regardless of how fast the gesture is. This can be used for pagination when the page is less than the width of the horizontal ScrollView or the height of the vertical ScrollView.
| Type | Default |
|---|---|
| bool | false |
disableScrollViewPanResponderโ
When true, the default JS pan responder on the ScrollView is disabled, and full control over touches inside the ScrollView is left to its child components. This is particularly useful if snapToInterval is enabled, since it does not follow typical touch patterns. Do not use this on regular ScrollView use cases without snapToInterval as it may cause unexpected touches to occur while scrolling.
| Type | Default |
|---|---|
| bool | false |
endFillColor Androidโ
Sometimes a scrollview takes up more space than its content fills. When this is the case, this prop will fill the rest of the scrollview with a color to avoid setting a background and creating unnecessary overdraw. This is an advanced optimization that is not needed in the general case.
| Type |
|---|
| color |
fadingEdgeLength Androidโ
Fades out the edges of the scroll content.
If the value is greater than 0, the fading edges will be set accordingly to the current scroll direction and position, indicating if there is more content to show.
| Type | Default |
|---|---|
| number object: {start: number, end: number} | 0 |
horizontalโ
When true, the scroll view's children are arranged horizontally in a row instead of vertically in a column.
| Type | Default |
|---|---|
| bool | false |
indicatorStyle iOSโ
The style of the scroll indicators.
'default'same asblack.'black', scroll indicator isblack. This style is good against a light background.'white', scroll indicator iswhite. This style is good against a dark background.
| Type | Default |
|---|---|
enum('default', 'black', 'white') | 'default' |
invertStickyHeadersโ
If sticky headers should stick at the bottom instead of the top of the ScrollView. This is usually used with inverted ScrollViews.
| Type | Default |
|---|---|
| bool | false |
keyboardDismissModeโ
Determines whether the keyboard gets dismissed in response to a drag.
'none', drags do not dismiss the keyboard.'on-drag', the keyboard is dismissed when a drag begins.
iOS Only
'interactive', the keyboard is dismissed interactively with the drag and moves in synchrony with the touch, dragging upwards cancels the dismissal. On Android this is not supported and it will have the same behavior as'none'.
| Type | Default |
|---|---|
enum('none', 'on-drag') Android enum( 'none', 'on-drag', 'interactive') iOS | 'none' |
keyboardShouldPersistTapsโ
Determines when the keyboard should stay visible after a tap.
'never'tapping outside of the focused text input when the keyboard is up dismisses the keyboard. When this happens, children won't receive the tap.'always', the keyboard will not dismiss automatically, and the scroll view will not catch taps, but children of the scroll view can catch taps.'handled', the keyboard will not dismiss automatically when the tap was handled by children of the scroll view (or captured by an ancestor).
| Type | Default |
|---|---|
enum('always', 'never', 'handled') | 'never' |
maintainVisibleContentPositionโ
When set, the scroll view will adjust the scroll position so that the first child that is currently visible and at or beyond minIndexForVisible will not change position. This is useful for lists that are loading content in both directions, e.g. a chat thread, where new messages coming in might otherwise cause the scroll position to jump. A value of 0 is common, but other values such as 1 can be used to skip loading spinners or other content that should not maintain position.
The optional autoscrollToTopThreshold can be used to make the content automatically scroll to the top after making the adjustment if the user was within the threshold of the top before the adjustment was made. This is also useful for chat-like applications where you want to see new messages scroll into place, but not if the user has scrolled up a ways and it would be disruptive to scroll a bunch.
Caveat 1: Reordering elements in the scrollview with this enabled will probably cause jumpiness and jank. It can be fixed, but there are currently no plans to do so. For now, don't re-order the content of any ScrollViews or Lists that use this feature.
Caveat 2: This uses contentOffset and frame.origin in native code to compute visibility. Occlusion, transforms, and other complexity won't be taken into account as to whether content is "visible" or not.
| Type |
|---|
object: {minIndexForVisible: number, autoscrollToTopThreshold: number} |
maximumZoomScale iOSโ
The maximum allowed zoom scale.
| Type | Default |
|---|---|
| number | 1.0 |
minimumZoomScale iOSโ
The minimum allowed zoom scale.
| Type | Default |
|---|---|
| number | 1.0 |
nestedScrollEnabled Androidโ
Enables nested scrolling for Android API level 21+.
| Type | Default |
|---|---|
| bool | false |
onContentSizeChangeโ
Called when scrollable content view of the ScrollView changes.
The handler function will receive two parameters: the content width and content height (contentWidth, contentHeight).
It's implemented using onLayout handler attached to the content container which this ScrollView renders.
| Type |
|---|
| function |
onMomentumScrollBeginโ
Called when the momentum scroll starts (scroll which occurs as the ScrollView starts gliding).
| Type |
|---|
| function |
onMomentumScrollEndโ
Called when the momentum scroll ends (scroll which occurs as the ScrollView glides to a stop).