Optional StickyA 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 component have not been provided, the default ScrollViewStickyHeader component will be used.
Optional accessibilityProvides an array of custom actions available for accessibility.
Optional accessibilityA Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader.
ios
Optional accessibilityAn accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.
Optional accessibilityios
Optional accessibilityOverrides the text that's read by the screen reader when the user interacts with the element. By default, the label is constructed by traversing all the children and accumulating all the Text nodes separated by space.
Optional accessibilityIdentifies the element that labels the element it is applied to. When the assistive technology focuses on the component with this props, the text is read aloud. The value should should match the nativeID of the related element.
android
Optional accessibilityBy using the accessibilityLanguage property, the screen reader will understand which language to use while reading the element's label, value and hint. The provided string value must follow the BCP 47 specification (https://www.rfc-editor.org/info/bcp47). https://reactnative.dev/docs/accessibility#accessibilitylanguage-ios
ios
Optional accessibilityIndicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only.
Optional accessibilityAccessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
Optional accessibilityAccessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
Optional accessibilityRepresents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, it contains range information (minimum, current, and maximum).
Optional accessibilityA Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
ios
Optional accessibleWhen true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
Optional alwaysWhen 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.
Optional alwaysWhen 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.
Optional aria-alias for accessibilityState
see https://reactnative.dev/docs/accessibility#accessibilitystate
Optional aria-Optional aria-Optional aria-Optional aria-A value indicating whether the accessibility elements contained within this accessibility element are hidden.
Optional aria-Alias for accessibilityLabel https://reactnative.dev/docs/view#accessibilitylabel https://github.com/facebook/react-native/issues/34424
Optional aria-Identifies the element that labels the element it is applied to. When the assistive technology focuses on the component with this props, the text is read aloud. The value should should match the nativeID of the related element.
android
Optional aria-Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only.
Optional aria-Optional aria-Optional aria-Optional aria-Optional aria-Optional aria-Optional automaticallyControls 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.
Optional automaticallyControls whether the ScrollView should automatically adjust its contentInset and scrollViewInsets when the Keyboard changes its size. The default value is false.
Optional automaticallyControls whether iOS should automatically adjust the scroll indicator insets. The default value is true. Available on iOS 13 and later.
Optional bouncesWhen 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.
Optional bouncesWhen 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.
Optional canWhen false once tracking starts won't try to drag if the touch moves. The default value is true.
Optional centerWhen 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.
Optional childrenOptional collapsableViews that are only used to layout their children or otherwise don't draw anything may be automatically removed from the native hierarchy as an optimization. Set this property to false to disable this optimization and ensure that this View exists in the native view hierarchy.
Optional collapsableSetting to false prevents direct children of the view from being removed
from the native view hierarchy, similar to the effect of setting
collapsable={false} on each child.
Optional contentThese styles will be applied to the scroll view content container which wraps all of the child views. Example:
return (
Optional contentThe amount by which the scroll view content is inset from the edges of the scroll view. Defaults to {0, 0, 0, 0}.
Optional contentThis property specifies how the safe area insets are used to modify the content area of the scroll view. The default value of this property must be 'automatic'. But the default value is 'never' until RN@0.51.
Optional contentUsed to manually set the starting scroll offset. The default value is {x: 0, y: 0}
Optional decelerationA 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 (the default)'fast': 0.99 on iOS, 0.9 on AndroidOptional directionalWhen true the ScrollView will try to lock to only vertical or horizontal scrolling while dragging. The default value is false.
Optional disableWhen 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 horizontal pagination when the page is less than the width of the ScrollView. The default value is false.
Optional disableWhen 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. The default value is false.
Optional endSometimes 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.
Optional fadingFades 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.
The default value is 0.
android
Optional focusableWhether this View should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
Optional hasTVPreferred(Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view.
ios
Optional hitThis defines how far a touch event can start away from the view. Typical interface guidelines recommend touch targets that are at least 30 - 40 points/density-independent pixels. If a Touchable view has a height of 20 the touchable height can be extended to 40 with hitSlop={{top: 10, bottom: 10, left: 0, right: 0}} NOTE The touch area never extends past the parent view bounds and the Z-index of sibling views always takes precedence if a touch hits two overlapping views.
Optional horizontalWhen true the scroll view's children are arranged horizontally in a row instead of vertically in a column. The default value is false.
Optional idUsed to reference react managed views from native code.
Optional important[Android] Controlling if a view fires accessibility events and if it is reported to accessibility services.
Optional indicatorThe style of the scroll indicators.
Optional invertIf sticky headers should stick at the bottom instead of the top of the ScrollView. This is usually used with inverted ScrollViews.
Optional isTVSelectable(Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote.
ios
Optional keyboardDetermines whether the keyboard gets dismissed in response to a drag.
Optional keyboardDetermines when the keyboard should stay visible after a tap.
Optional maintainWhen 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.
Optional autoscrollOptional maximumThe maximum allowed zoom scale. The default value is 1.0.
Optional minimumThe minimum allowed zoom scale. The default value is 1.0.
Optional nativeIDUsed to reference react managed views from native code.
Optional needsWhether this view needs to rendered offscreen and composited with an alpha in order to preserve 100% correct colors and blending behavior. The default (false) falls back to drawing the component and its children with an alpha applied to the paint used to draw each element instead of rendering the full component offscreen and compositing it back with an alpha value. This default may be noticeable and undesired in the case where the View you are setting an opacity on has multiple overlapping elements (e.g. multiple overlapping Views, or text and a background).
Rendering offscreen to preserve correct alpha behavior is extremely expensive and hard to debug for non-native developers, which is why it is not turned on by default. If you do need to enable this property for an animation, consider combining it with renderToHardwareTextureAndroid if the view contents are static (i.e. it doesn't need to be redrawn each frame). If that property is enabled, this View will be rendered off-screen once, saved in a hardware texture, and then composited onto the screen with an alpha each frame without having to switch rendering targets on the GPU.
Optional nestedEnables nested scrolling for Android API level 21+. Nested scrolling is supported by default on iOS.
Optional onWhen accessible is true, the system will try to invoke this function when the user performs an accessibility custom action.
Optional onWhen accessible is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).
ios
Optional onWhen accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture.
ios
Optional onCalled when scrollable content view of the ScrollView changes. Handler function is passed the content width and content height as parameters: (contentWidth, contentHeight) It's implemented using onLayout handler attached to the content container which this ScrollView renders.
Optional onInvoked on mount and layout changes with
{nativeEvent: { layout: {x, y, width, height}}}.
Optional onWhen accessible is true, the system will invoke this function when the user performs the magic tap gesture.
ios
Optional onFires when scroll view has begun moving
Optional onFires when scroll view has finished moving
Optional onCalled for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
Optional ononStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.
However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.
Optional onOptional onOptional onOptional onOptional onOptional onOptional onOptional onOptional onOptional onOptional onOptional onOptional onIf the View returns true and attempts to become the responder, one of the following will happen:
Optional onThe View is now responding for touch events. This is the time to highlight and show the user what is happening
Optional onThe user is moving their finger
Optional onSomething else is the responder right now and will not release it
Optional onFired at the end of the touch, ie "touchUp"
Optional onOptional onThe responder has been taken from the View. Might be taken by other views after a call to onResponderTerminationRequest, or might be taken by the OS without asking (happens with control center/ notification center on iOS)
Optional onSomething else wants to become responder. Should this view release the responder? Returning true allows release
Optional onFires at most once per frame during scrolling.
Optional onCalled when a scrolling animation ends.
Optional onFires if a user initiates a scroll gesture.
Optional onFires when a user has finished scrolling.
Optional onFires when the scroll view scrolls to top after the status bar has been tapped
ios
Optional onDoes this view want to become responder on the start of a touch?
Optional ononStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.
However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.
Optional onOptional onOptional onOptional onOptional onOptional overUsed to override default value of overScroll mode.
Optional pagingWhen 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.
Optional persistentCauses the scrollbars not to turn transparent when they are not in use. The default value is false.
Optional pinchWhen true, ScrollView allows use of pinch gestures to zoom in and out. The default value is true.
Optional pointerIn the absence of auto property, none is much like CSS's none value. box-none is as if you had applied the CSS class:
.box-none { pointer-events: none; } .box-none * { pointer-events: all; }
box-only is the equivalent of
.box-only { pointer-events: all; } .box-only * { pointer-events: none; }
But since pointerEvents does not affect layout/appearance, and we are already deviating from the spec by adding additional modes, we opt to not include pointerEvents on style. On some platforms, we would need to implement it as a className anyways. Using style or not is an implementation detail of the platform.
Optional refreshA RefreshControl component, used to provide pull-to-refresh functionality for the ScrollView.
Optional removeExperimental: 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.
Optional renderWhether this view should render itself (and all of its children) into a single hardware texture on the GPU.
On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
Optional roleIndicates to accessibility services to treat UI component like a specific role.
Optional scrollWhen false, the content does not scroll. The default value is true
Optional scrollLimits how often scroll events will be fired while scrolling, specified as
a time interval in ms. This may be useful when expensive work is performed
in response to scrolling. Values <= 16 will disable throttling,
regardless of the refresh rate of the device.
Optional scrollThe 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}.
Optional scrollTag used to log scroll performance on this scroll view. Will force momentum events to be turned on (see sendMomentumEvents). This doesn't do anything out of the box and you need to implement a custom native FpsListener for it to be useful.
android
Optional scrollWhen true, the scroll view can be programmatically scrolled beyond its content size. The default value is false.
ios
Optional scrollsWhen true the scroll view scrolls to top when the status bar is tapped. The default value is true.
Optional shouldWhether this view should be rendered as a bitmap before compositing.
On iOS, this is useful for animations and interactions that do not modify this component's dimensions nor its children; for example, when translating the position of a static view, rasterization allows the renderer to reuse a cached bitmap of a static view and quickly composite it during each frame.
Rasterization incurs an off-screen drawing pass and the bitmap consumes memory. Test and measure when using this property.
Optional showsWhen true, shows a horizontal scroll indicator.
Optional showsWhen true, shows a vertical scroll indicator.
Optional snapWhen 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)
Optional snapUse in conjunction with snapToOffsets. By default, the end of the list counts as a snap
offset. Set snapToEnd to false to disable this behavior and allow the list to scroll freely
between its end and the last snapToOffsets offset. The default value is true.
Optional snapWhen 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 and decelerationRate="fast". Overrides less
configurable pagingEnabled prop.
Optional snapWhen set, causes the scroll view to stop at the defined offsets. This can be used for
paginating through variously sized children that have lengths smaller than the scroll view.
Typically used in combination with decelerationRate="fast". Overrides less configurable
pagingEnabled and snapToInterval props.
Optional snapUse in conjunction with snapToOffsets. By default, the beginning of the list counts as a
snap offset. Set snapToStart to false to disable this behavior and allow the list to scroll
freely between its start and the first snapToOffsets offset. The default value is true.
Optional stickyWhen true, Sticky header is hidden when scrolling down, and dock at the top when scrolling up.
Optional stickyAn 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}.
Optional styleStyle
Optional tabIndicates whether this View should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
See https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex
for more details.
Supports the following values:
Optional testIDUsed to locate this view in end-to-end tests.
Optional tv(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 1.0.
ios
Optional tv(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 2.0.
ios
Optional tv(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 2.0.
ios
Optional tv(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 0.05.
ios
Optional zoomThe current scale of the scroll view content. The default value is 1.0.
See
https://reactnative.dev/docs/view#props