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
easy to debug.
Doesn't yet support other contained responders from blocking this scroll view from becoming the responder.
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> ); ... var styles = StyleSheet.create({ contentContainer: { paddingVertical: 20 } });
When true, the scroll view's children are arranged horizontally in a row instead of vertically in a column. The default value is false.
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'.
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.
Fires at most once per frame during scrolling. The frequency of the
events can be contolled using the scrollEventThrottle prop.
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
false.
When true, shows a horizontal scroll indicator.
When true, shows a vertical scroll indicator.
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.
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.
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.
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.
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.
When false, once tracking starts, won't try to drag if the touch moves. The default value is true.
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.
The amount by which the scroll view content is inset from the edges
of the scroll view. Defaults to {0, 0, 0, 0}.
Used to manually set the starting scroll offset.
The default value is {x: 0, y: 0}.
A floating-point number that determines how quickly the scroll view decelerates after the user lifts their finger. Reasonable choices include - Normal: 0.998 (the default) - Fast: 0.9
When true, the ScrollView will try to lock to only vertical or horizontal scrolling while dragging. The default value is false.
The maximum allowed zoom scale. The default value is 1.0.
The minimum allowed zoom scale. The default value is 1.0.
Called when a scrolling animation ends.
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.
When false, the content does not scroll. The default value is true.
This controls how often the scroll event will be fired while scrolling (in events per seconds). A higher 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. The default value is zero, which means the scroll event will be sent only once each time the view is scrolled.
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}.
When true, the scroll view scrolls to top when the status bar is tapped. The default value is true.
When snapToInterval is set, snapToAlignment will define the relationship
of the 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)
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.
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}.
The current scale of the scroll view content. The default value is 1.0.