ScrollView

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 easy to debug.

Doesn't yet support other contained responders from blocking this scroll view from becoming the responder.

keyboardDismissMode

Determines whether the keyboard gets dismissed in response to a drag.

'none' (the default), drags do not dismiss the keyboard.

'on-drag', the keyboard is dismissed when a drag begins.

'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

Required

enum('none', 'interactive', 'on-drag')

No

keyboardShouldPersistTaps

When false, tapping outside of the focused text input when the keyboard is up dismisses the keyboard. When true, the scroll view will not catch taps, and the keyboard will not dismiss automatically. The default value is false.

Type

Required

bool

No

onContentSizeChange

Called when scrollable content view of the ScrollView changes. It's implemented using onLayout handler attached to the content container which this ScrollView renders.

Type

Required

function

No

onScroll

Fires at most once per frame during scrolling. The frequency of the events can be controlled using the scrollEventThrottle prop.

Type

Required

function

No

refreshControl

A RefreshControl component, used to provide pull-to-refresh functionality for the ScrollView.

removeClippedSubviews

Experimental: When true, offscreen child views (whose overflow value is hidden) are removed from their native backing superview when offscreen. This can improve scrolling performance on long lists. The default value is true.

(Android-only) Sets the elevation of a view, using Android's underlying elevation API. This adds a drop shadow to the item and affects z-order for overlapping views. Only supported on Android 5.0+, has no effect on earlier versions.

endFillColor

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.

alwaysBounceHorizontal

When true, the scroll view bounces horizontally when it reaches the end even if the content is smaller than the scroll view itself. The default value is true when horizontal={true} and false otherwise.

Type

Required

Platform

bool

No

iOS

alwaysBounceVertical

When true, the scroll view bounces vertically when it reaches the end even if the content is smaller than the scroll view itself. The default value is false when horizontal={true} and true otherwise.

Type

Required

Platform

bool

No

iOS

automaticallyAdjustContentInsets

Controls whether iOS should automatically adjust the content inset for scroll views that are placed behind a navigation bar or tab bar/ toolbar. The default value is true.

Type

Required

Platform

bool

No

iOS

bounces

When true, the scroll view bounces when it reaches the end of the content if the content is larger then the scroll view along the axis of the scroll direction. When false, it disables all bouncing even if the alwaysBounce* props are true. The default value is true.

Type

Required

Platform

bool

No

iOS

bouncesZoom

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

Required

Platform

bool

No

iOS

horizontal

When true, the scroll view's children are arranged horizontally in a row instead of vertically in a column. The default value is false.

Type

Required

bool

No

centerContent

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. The default value is false.

Type

Required

Platform

bool

No

iOS

contentInset

The amount by which the scroll view content is inset from the edges of the scroll view. Defaults to {0, 0, 0, 0}.

Type

Required

Platform

object: {top: number, left: number, bottom: number, right: number}

No

iOS

contentOffset

Used to manually set the starting scroll offset. The default value is {x: 0, y: 0}.

Type

Required

Platform

PointPropType

No

iOS

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 (the default)

fast: 0.99

Type

Required

Platform

enum('fast', 'normal'), ,number

No

iOS

directionalLockEnabled

When true, the ScrollView will try to lock to only vertical or horizontal scrolling while dragging. The default value is false.

Type

Required

Platform

bool

No

iOS

indicatorStyle

The style of the scroll indicators.

default (the default), same as black.

black, scroll indicator is black. This style is good against a white content background.

white, scroll indicator is white. This style is good against a black content background.

Type

Required

Platform

enum('default', 'black', 'white')

No

iOS

maximumZoomScale

The maximum allowed zoom scale. The default value is 1.0.

Type

Required

Platform

number

No

iOS

minimumZoomScale

The minimum allowed zoom scale. The default value is 1.0.

Type

Required

Platform

number

No

iOS

stickyHeaderIndices

An array of child indices determining which children get docked to the top of the screen when scrolling. For example, passing stickyHeaderIndices={[0]} will cause the first child to be fixed to the top of the scroll view. This property is not supported in conjunction with horizontal={true}.

Type

Required

Platform

array of number

No

iOS

onScrollAnimationEnd

Called when a scrolling animation ends.

Type

Required

Platform

function

No

iOS

pagingEnabled

When true, the scroll view stops on multiples of the scroll view's size when scrolling. This can be used for horizontal pagination. The default value is false.

Type

Required

Platform

bool

No

iOS

scrollEventThrottle

This controls how often the scroll event will be fired while scrolling (as a time interval in ms). A lower number yields better accuracy for code that is tracking the scroll position, but can lead to scroll performance problems due to the volume of information being send over the bridge. You will not notice a difference between values set between 1-16 as the JS run loop is synced to the screen refresh rate. If you do not need precise scroll position tracking, set this value higher to limit the information being sent across the bridge. The default value is zero, which results in the scroll event being sent only once each time the view is scrolled.

Type

Required

Platform

number

No

iOS

scrollIndicatorInsets

The amount by which the scroll view indicators are inset from the edges of the scroll view. This should normally be set to the same value as the contentInset. Defaults to {0, 0, 0, 0}.

Type

Required

Platform

object: {top: number, left: number, bottom: number, right: number}

No

iOS

scrollsToTop

When true, the scroll view scrolls to top when the status bar is tapped. The default value is true.

Type

Required

Platform

bool

No

iOS

snapToAlignment

When snapToInterval is set, snapToAlignment will define the relationship of the snapping to the scroll view.

start (the default) will align the snap at the left (horizontal) or top (vertical)

center will align the snap in the center

end will align the snap at the right (horizontal) or bottom (vertical)

Type

Required

Platform

enum('start', 'center', 'end')

No

iOS

snapToInterval

When set, causes the scroll view to stop at multiples of the value of snapToInterval. This can be used for paginating through children that have lengths smaller than the scroll view. Used in combination with snapToAlignment.

Type

Required

Platform

number

No

iOS

zoomScale

The current scale of the scroll view content. The default value is 1.0.

Type

Required

Platform

number

No

iOS

onRefreshStart

Deprecated. Use the refreshControl prop instead.

Type

Required

Platform

function

No

iOS

Methods

endRefreshing()

endRefreshing();

scrollTo()

scrollTo(([y]: number), object,([x]: number),([animated]: boolean));

Scrolls to a given x, y offset, either immediately or with a smooth animation. Syntax:

Note: The weird argument signature is due to the fact that, for historical reasons, the function also accepts separate arguments as as alternative to the options object. This is deprecated due to ambiguity (y before x), and SHOULD NOT BE USED.