VAScrollView

A common component that provides a scrollable view. Use this instead of ScrollView. This component is a wrapper for react-native ScrollView that has a scrollbar styling fix

Properties

Name	Type	Default Value	Required	Description
scrollViewRef	Ref<ScrollView>		No	Optional reference prop to determine scroll position
backgroundColor	string | number | symbol		No	optional background color to override the main background
removeInsets	boolean		No	remove insets
contentContainerStyle	StyleProp<ViewStyle>		No	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 } });
decelerationRate	number | "normal" | "fast"		No	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 (the default) - `'fast'`: 0.99 on iOS, 0.9 on Android
horizontal	boolean		No	When true the scroll view's children are arranged horizontally in a row instead of vertically in a column. The default value is false.
invertStickyHeaders	boolean		No	If sticky headers should stick at the bottom instead of the top of the ScrollView. This is usually used with inverted ScrollViews.
keyboardDismissMode	"none" | "interactive" | "on-drag"		No	Determines whether the keyboard gets dismissed in response to a drag. - 'none' (the default) drags do not dismiss the keyboard. - 'onDrag' 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.
keyboardShouldPersistTaps	boolean | "always" | "never" | "handled"		No	Determines when the keyboard should stay visible after a tap. - 'never' (the default), 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 a children, (or captured by an ancestor). - false, deprecated, use 'never' instead - true, deprecated, use 'always' instead
onContentSizeChange	(w: number, h: number) => void		No	Called 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.
onScroll	(event: NativeSyntheticEvent<NativeScrollEvent>) => void		No	Fires at most once per frame during scrolling.
onScrollBeginDrag	(event: NativeSyntheticEvent<NativeScrollEvent>) => void		No	Fires if a user initiates a scroll gesture.
onScrollEndDrag	(event: NativeSyntheticEvent<NativeScrollEvent>) => void		No	Fires when a user has finished scrolling.
onMomentumScrollEnd	(event: NativeSyntheticEvent<NativeScrollEvent>) => void		No	Fires when scroll view has finished moving
onMomentumScrollBegin	(event: NativeSyntheticEvent<NativeScrollEvent>) => void		No	Fires when scroll view has begun moving
pagingEnabled	boolean		No	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.
scrollEnabled	boolean		No	When false, the content does not scroll. The default value is true
removeClippedSubviews	boolean		No	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.
showsHorizontalScrollIndicator	boolean		No	When true, shows a horizontal scroll indicator.
showsVerticalScrollIndicator	boolean		No	When true, shows a vertical scroll indicator.
stickyHeaderHiddenOnScroll	boolean		No	When true, Sticky header is hidden when scrolling down, and dock at the top when scrolling up.
style	StyleProp<ViewStyle>		No	Style
refreshControl	ReactElement<RefreshControlProps, string | JSXElementConstructor<any>>		No	A RefreshControl component, used to provide pull-to-refresh functionality for the ScrollView.
snapToInterval	number		No	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` and `decelerationRate="fast"`. Overrides less configurable `pagingEnabled` prop.
snapToOffsets	number[]		No	When 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.
snapToStart	boolean		No	Use 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.
snapToEnd	boolean		No	Use 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.
stickyHeaderIndices	number[]		No	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}`.
disableIntervalMomentum	boolean		No	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 horizontal pagination when the page is less than the width of the ScrollView. The default value is false.
disableScrollViewPanResponder	boolean		No	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. The default value is false.
StickyHeaderComponent	ComponentType<any>		No	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 component have not been provided, the default ScrollViewStickyHeader component will be used.
hitSlop	number | Insets		No	This 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.
id	string		No	Used to reference react managed views from native code.
needsOffscreenAlphaCompositing	boolean		No	Whether 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.
onLayout	(event: LayoutChangeEvent) => void		No	Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
pointerEvents	"none" | "box-none" | "box-only" | "auto"		No	In 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.
testID	string		No	Used to locate this view in end-to-end tests.
nativeID	string		No	Used to reference react managed views from native code.
collapsable	boolean		No	Views 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.
collapsableChildren	boolean		No	Setting 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.
renderToHardwareTextureAndroid	boolean		No	Whether 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.
focusable	boolean		No	Whether this `View` should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
tabIndex	0 | -1		No	Indicates 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: - 0 (View is focusable) - -1 (View is not focusable)
shouldRasterizeIOS	boolean		No	Whether 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.
isTVSelectable	boolean		No	*(Apple TV only)* When set to true, this view will be focusable and navigable using the Apple TV remote. @platform ios
hasTVPreferredFocus	boolean		No	*(Apple TV only)* May be set to true to force the Apple TV focus engine to move focus to this view. @platform ios
tvParallaxShiftDistanceX	number		No	*(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. @platform ios
tvParallaxShiftDistanceY	number		No	*(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. @platform ios
tvParallaxTiltAngle	number		No	*(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. @platform ios
tvParallaxMagnification	number		No	*(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. @platform ios
onStartShouldSetResponder	(event: GestureResponderEvent) => boolean		No	Does this view want to become responder on the start of a touch?
onMoveShouldSetResponder	(event: GestureResponderEvent) => boolean		No	Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
onResponderEnd	(event: GestureResponderEvent) => void		No	If the View returns true and attempts to become the responder, one of the following will happen:
onResponderGrant	(event: GestureResponderEvent) => void		No	The View is now responding for touch events. This is the time to highlight and show the user what is happening
onResponderReject	(event: GestureResponderEvent) => void		No	Something else is the responder right now and will not release it
onResponderMove	(event: GestureResponderEvent) => void		No	The user is moving their finger
onResponderRelease	(event: GestureResponderEvent) => void		No	Fired at the end of the touch, ie "touchUp"
onResponderStart	(event: GestureResponderEvent) => void		No
onResponderTerminationRequest	(event: GestureResponderEvent) => boolean		No	Something else wants to become responder. Should this view release the responder? Returning true allows release
onResponderTerminate	(event: GestureResponderEvent) => void		No	The 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)
onStartShouldSetResponderCapture	(event: GestureResponderEvent) => boolean		No	onStartShouldSetResponder 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.
onMoveShouldSetResponderCapture	(event: GestureResponderEvent) => boolean		No	onStartShouldSetResponder 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.
onTouchStart	(event: GestureResponderEvent) => void		No
onTouchMove	(event: GestureResponderEvent) => void		No
onTouchEnd	(event: GestureResponderEvent) => void		No
onTouchCancel	(event: GestureResponderEvent) => void		No
onTouchEndCapture	(event: GestureResponderEvent) => void		No
onPointerEnter	(event: PointerEvent) => void		No
onPointerEnterCapture	(event: PointerEvent) => void		No
onPointerLeave	(event: PointerEvent) => void		No
onPointerLeaveCapture	(event: PointerEvent) => void		No
onPointerMove	(event: PointerEvent) => void		No
onPointerMoveCapture	(event: PointerEvent) => void		No
onPointerCancel	(event: PointerEvent) => void		No
onPointerCancelCapture	(event: PointerEvent) => void		No
onPointerDown	(event: PointerEvent) => void		No
onPointerDownCapture	(event: PointerEvent) => void		No
onPointerUp	(event: PointerEvent) => void		No
onPointerUpCapture	(event: PointerEvent) => void		No
accessible	boolean		No	When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
accessibilityActions	readonly Readonly<{ name: string; label?: string; }>[]		No	Provides an array of custom actions available for accessibility.
accessibilityLabel	string		No	Overrides 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.
aria-label	string		No	Alias for accessibilityLabel https://reactnative.dev/docs/view#accessibilitylabel https://github.com/facebook/react-native/issues/34424
accessibilityRole	AccessibilityRole		No	Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
accessibilityState	AccessibilityState		No	Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
aria-busy	boolean		No	alias for accessibilityState see https://reactnative.dev/docs/accessibility#accessibilitystate
aria-checked	boolean | "mixed"		No
aria-disabled	boolean		No
aria-expanded	boolean		No
aria-selected	boolean		No
accessibilityHint	string		No	An 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.
accessibilityValue	AccessibilityValue		No	Represents 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).
aria-valuemax	number		No
aria-valuemin	number		No
aria-valuenow	number		No
aria-valuetext	string		No
onAccessibilityAction	(event: AccessibilityActionEvent) => void		No	When `accessible` is true, the system will try to invoke this function when the user performs an accessibility custom action.
importantForAccessibility	"auto" | "yes" | "no" | "no-hide-descendants"		No	[Android] Controlling if a view fires accessibility events and if it is reported to accessibility services.
aria-hidden	boolean		No	A value indicating whether the accessibility elements contained within this accessibility element are hidden.
aria-modal	boolean		No
role	Role		No	Indicates to accessibility services to treat UI component like a specific role.
accessibilityLabelledBy	string | string[]		No	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. @platform android
aria-labelledby	string		No	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. @platform android
accessibilityLiveRegion	"none" | "polite" | "assertive"		No	Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only. @platform android See https://reactnative.dev/docs/view#accessibilityliveregion
aria-live	"polite" | "assertive" | "off"		No	Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only. @platform android See https://reactnative.dev/docs/view#accessibilityliveregion
accessibilityElementsHidden	boolean		No	A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. @platform ios
accessibilityViewIsModal	boolean		No	A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. @platform ios
onAccessibilityEscape	() => void		No	When accessible is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers). @platform ios
onAccessibilityTap	() => void		No	When `accessible` is true, the system will try to invoke this function when the user performs accessibility tap gesture. @platform ios
onMagicTap	() => void		No	When accessible is true, the system will invoke this function when the user performs the magic tap gesture. @platform ios
accessibilityIgnoresInvertColors	boolean		No	https://reactnative.dev/docs/accessibility#accessibilityignoresinvertcolorsios @platform ios
accessibilityLanguage	string		No	By 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 @platform ios
alwaysBounceHorizontal	boolean		No	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.
alwaysBounceVertical	boolean		No	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.
automaticallyAdjustContentInsets	boolean		No	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.
automaticallyAdjustKeyboardInsets	boolean		No	Controls whether the ScrollView should automatically adjust its contentInset and scrollViewInsets when the Keyboard changes its size. The default value is false.
automaticallyAdjustsScrollIndicatorInsets	boolean		No	Controls whether iOS should automatically adjust the scroll indicator insets. The default value is true. Available on iOS 13 and later.
bounces	boolean		No	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.
bouncesZoom	boolean		No	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.
canCancelContentTouches	boolean		No	When false once tracking starts won't try to drag if the touch moves. The default value is true.
centerContent	boolean		No	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.
contentInset	Insets		No	The amount by which the scroll view content is inset from the edges of the scroll view. Defaults to {0, 0, 0, 0}.
contentOffset	PointProp		No	Used to manually set the starting scroll offset. The default value is {x: 0, y: 0}
contentInsetAdjustmentBehavior	"always" | "never" | "automatic" | "scrollableAxes"		No	This 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.
directionalLockEnabled	boolean		No	When true the ScrollView will try to lock to only vertical or horizontal scrolling while dragging. The default value is false.
indicatorStyle	"default" | "black" | "white"		No	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.
maintainVisibleContentPosition	{ autoscrollToTopThreshold?: number; minIndexForVisible: number; }		No	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.
maximumZoomScale	number		No	The maximum allowed zoom scale. The default value is 1.0.
minimumZoomScale	number		No	The minimum allowed zoom scale. The default value is 1.0.
onScrollAnimationEnd	() => void		No	Called when a scrolling animation ends.
pinchGestureEnabled	boolean		No	When true, ScrollView allows use of pinch gestures to zoom in and out. The default value is true.
scrollEventThrottle	number		No	Limits 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.
scrollIndicatorInsets	Insets		No	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}.
scrollToOverflowEnabled	boolean		No	When true, the scroll view can be programmatically scrolled beyond its content size. The default value is false. @platform ios
scrollsToTop	boolean		No	When true the scroll view scrolls to top when the status bar is tapped. The default value is true.
snapToAlignment	"center" | "start" | "end"		No	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)
onScrollToTop	(event: NativeSyntheticEvent<NativeScrollEvent>) => void		No	Fires when the scroll view scrolls to top after the status bar has been tapped @platform ios
zoomScale	number		No	The current scale of the scroll view content. The default value is 1.0.
endFillColor	ColorValue		No	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.
scrollPerfTag	string		No	Tag 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. @platform android
overScrollMode	"auto" | "always" | "never"		No	Used to override default value of overScroll mode. Possible values: - 'auto' - Default value, allow a user to over-scroll this view only if the content is large enough to meaningfully scroll. - 'always' - Always allow a user to over-scroll this view. - 'never' - Never allow a user to over-scroll this view.
nestedScrollEnabled	boolean		No	Enables nested scrolling for Android API level 21+. Nested scrolling is supported by default on iOS.
fadingEdgeLength	number		No	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. The default value is 0. @platform android
persistentScrollbar	boolean		No	Causes the scrollbars not to turn transparent when they are not in use. The default value is false.

Example

How to use the VAScrollView component

return (
    <VAScrollView>
        <Box />
    </VAScrollView>
)

Source Code

Full code for the VAScrollView component

import React, { FC, Ref } from 'react'
import { ScrollView, ScrollViewProps, ViewStyle } from 'react-native'
import { useSafeAreaInsets } from 'react-native-safe-area-context'

import { VABackgroundColors } from 'styles/theme'

import { useTheme } from '../utils/hooks'

export type VAScrollViewProps = {
  /** Optional reference prop to determine scroll position */
  scrollViewRef?: Ref<ScrollView>
  /** optional background color to override the main background */
  backgroundColor?: keyof VABackgroundColors
  /** remove insets */
  removeInsets?: boolean
} & ScrollViewProps

/** A common component that provides a scrollable view. Use this instead of ScrollView.
 * This component is a wrapper for react-native ScrollView that has a scrollbar styling fix */
const VAScrollView: FC<VAScrollViewProps> = (props) => {
  const insets = useSafeAreaInsets()
  const theme = useTheme()

  const style = {
    paddingRight: props.removeInsets ? undefined : insets.right,
    paddingLeft: props.removeInsets ? undefined : insets.left,
    backgroundColor: props.backgroundColor
      ? theme.colors.background[props.backgroundColor as keyof VABackgroundColors]
      : theme.colors.background.main,
  }

  // Grow container so short children like loading indicators are vertically centered
  const contentContainerStyle: ViewStyle = { flexGrow: 1 }

  return (
    /**
     * force scroll position by default to avoid visual bug where scrollbar appears in the center of a screen
     * scrollIndicatorInsets is an iOS only prop, this bug only appears on iOS
     */
    <ScrollView
      ref={props.scrollViewRef}
      scrollIndicatorInsets={{ right: 1 }}
      contentContainerStyle={contentContainerStyle}
      {...props}
      style={style}
    />
  )
}

export default VAScrollView

Accessibility