WrapperProps
@chelseaapps/react-native-elements / Exports / WrapperProps
Interface: WrapperProps
Hierarchy
WrapperElementProps↳
WrapperProps
Table of contents
Properties
StickyHeaderComponent
accessibilityActions
accessibilityElementsHidden
accessibilityHint
accessibilityIgnoresInvertColors
accessibilityLabel
accessibilityLiveRegion
accessibilityRole
accessibilityState
accessibilityValue
accessibilityViewIsModal
accessible
alwaysBounceHorizontal
alwaysBounceVertical
automaticallyAdjustContentInsets
bounces
bouncesZoom
canCancelContentTouches
centerContent
children
collapsable
contentContainerStyle
contentInset
contentInsetAdjustmentBehavior
contentOffset
decelerationRate
directionalLockEnabled
disableIntervalMomentum
disableScrollViewPanResponder
endFillColor
fadingEdgeLength
fixed
focusable
hasTVPreferredFocus
hitSlop
horizontal
importantForAccessibility
indicatorStyle
invertStickyHeaders
isTVSelectable
keyboardDismissMode
keyboardShouldPersistTaps
keyboardVerticalOffset
maintainVisibleContentPosition
maximumZoomScale
minimumZoomScale
nativeID
needsOffscreenAlphaCompositing
nestedScrollEnabled
onAccessibilityAction
onAccessibilityEscape
onAccessibilityTap
onContentSizeChange
onLayout
onMagicTap
onMomentumScrollBegin
onMomentumScrollEnd
onMoveShouldSetResponder
onMoveShouldSetResponderCapture
onResponderEnd
onResponderGrant
onResponderMove
onResponderReject
onResponderRelease
onResponderStart
onResponderTerminate
onResponderTerminationRequest
onScroll
onScrollAnimationEnd
onScrollBeginDrag
onScrollEndDrag
onScrollToTop
onStartShouldSetResponder
onStartShouldSetResponderCapture
onTouchCancel
onTouchEnd
onTouchEndCapture
onTouchMove
onTouchStart
overScrollMode
pagingEnabled
persistentScrollbar
pinchGestureEnabled
pointerEvents
refreshControl
removeClippedSubviews
renderToHardwareTextureAndroid
scrollEnabled
scrollEventThrottle
scrollIndicatorInsets
scrollPerfTag
scrollToOverflowEnabled
scrollsToTop
shouldRasterizeIOS
showsHorizontalScrollIndicator
showsVerticalScrollIndicator
snapToAlignment
snapToEnd
snapToInterval
snapToOffsets
snapToStart
stickyHeaderHiddenOnScroll
stickyHeaderIndices
style
testID
tvParallaxMagnification
tvParallaxProperties
tvParallaxShiftDistanceX
tvParallaxShiftDistanceY
tvParallaxTiltAngle
type
zoomScale
Properties
StickyHeaderComponent
• Optional StickyHeaderComponent: ComponentType<any>
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.
Inherited from
WrapperElementProps.StickyHeaderComponent
Defined in
node_modules/@types/react-native/index.d.ts:6846
accessibilityActions
• Optional accessibilityActions: readonly Readonly<Object>[]
Provides an array of custom actions available for accessibility.
Inherited from
WrapperElementProps.accessibilityActions
Defined in
node_modules/@types/react-native/index.d.ts:2265
accessibilityElementsHidden
• Optional accessibilityElementsHidden: boolean
A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader.
platform ios
Inherited from
WrapperElementProps.accessibilityElementsHidden
Defined in
node_modules/@types/react-native/index.d.ts:2440
accessibilityHint
• Optional accessibilityHint: string
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.
Inherited from
WrapperElementProps.accessibilityHint
Defined in
node_modules/@types/react-native/index.d.ts:2284
accessibilityIgnoresInvertColors
• Optional accessibilityIgnoresInvertColors: boolean
https://reactnative.dev/docs/accessibility#accessibilityignoresinvertcolorsios
platform ios
Inherited from
WrapperElementProps.accessibilityIgnoresInvertColors
Defined in
node_modules/@types/react-native/index.d.ts:2470
accessibilityLabel
• Optional accessibilityLabel: string
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.
Inherited from
WrapperElementProps.accessibilityLabel
Defined in
node_modules/@types/react-native/index.d.ts:2271
accessibilityLiveRegion
• Optional accessibilityLiveRegion: "none" | "polite" | "assertive"
Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only. See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion for references.
platform android
Inherited from
WrapperElementProps.accessibilityLiveRegion
Defined in
node_modules/@types/react-native/index.d.ts:2418
accessibilityRole
• Optional accessibilityRole: AccessibilityRole
Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
Inherited from
WrapperElementProps.accessibilityRole
Defined in
node_modules/@types/react-native/index.d.ts:2276
accessibilityState
• Optional accessibilityState: AccessibilityState
Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
Inherited from
WrapperElementProps.accessibilityState
Defined in
node_modules/@types/react-native/index.d.ts:2280
accessibilityValue
• Optional accessibilityValue: AccessibilityValue
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).
Inherited from
WrapperElementProps.accessibilityValue
Defined in
node_modules/@types/react-native/index.d.ts:2289
accessibilityViewIsModal
• Optional accessibilityViewIsModal: boolean
A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
platform ios
Inherited from
WrapperElementProps.accessibilityViewIsModal
Defined in
node_modules/@types/react-native/index.d.ts:2446
accessible
• Optional accessible: boolean
When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
Inherited from
WrapperElementProps.accessible
Defined in
node_modules/@types/react-native/index.d.ts:2260
alwaysBounceHorizontal
• Optional alwaysBounceHorizontal: boolean
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.
Inherited from
WrapperElementProps.alwaysBounceHorizontal
Defined in
node_modules/@types/react-native/index.d.ts:6420
alwaysBounceVertical
• Optional alwaysBounceVertical: boolean
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.
Inherited from
WrapperElementProps.alwaysBounceVertical
Defined in
node_modules/@types/react-native/index.d.ts:6426
automaticallyAdjustContentInsets
• Optional automaticallyAdjustContentInsets: boolean
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.
Inherited from
WrapperElementProps.automaticallyAdjustContentInsets
Defined in
node_modules/@types/react-native/index.d.ts:6432
bounces
• Optional bounces: boolean
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.
Inherited from
WrapperElementProps.bounces
Defined in
node_modules/@types/react-native/index.d.ts:6440
bouncesZoom
• Optional bouncesZoom: boolean
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.
Inherited from
WrapperElementProps.bouncesZoom
Defined in
node_modules/@types/react-native/index.d.ts:6446
canCancelContentTouches
• Optional canCancelContentTouches: boolean
When false once tracking starts won't try to drag if the touch moves. The default value is true.
Inherited from
WrapperElementProps.canCancelContentTouches
Defined in
node_modules/@types/react-native/index.d.ts:6452
centerContent
• Optional centerContent: boolean
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.
Inherited from
WrapperElementProps.centerContent
Defined in
node_modules/@types/react-native/index.d.ts:6460
children
• children: ReactNode
Pages elements
Inherited from
WrapperElementProps.children
Defined in
collapsable
• Optional collapsable: boolean
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.
Inherited from
WrapperElementProps.collapsable
Defined in
node_modules/@types/react-native/index.d.ts:2213
contentContainerStyle
• Optional contentContainerStyle: StyleProp<ViewStyle>
These styles will be applied to the scroll view content container which wraps all of the child views. Example:
return ( ); ... const styles = StyleSheet.create({ contentContainer: { paddingVertical: 20 } });
Inherited from
WrapperElementProps.contentContainerStyle
Defined in
node_modules/@types/react-native/index.d.ts:6659
contentInset
• Optional contentInset: Insets
The amount by which the scroll view content is inset from the edges of the scroll view. Defaults to {0, 0, 0, 0}.
Inherited from
WrapperElementProps.contentInset
Defined in
node_modules/@types/react-native/index.d.ts:6466
contentInsetAdjustmentBehavior
• Optional contentInsetAdjustmentBehavior: "never" | "always" | "automatic" | "scrollableAxes"
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 [email protected].
Inherited from
WrapperElementProps.contentInsetAdjustmentBehavior
Defined in
node_modules/@types/react-native/index.d.ts:6478
contentOffset
• Optional contentOffset: PointPropType
Used to manually set the starting scroll offset. The default value is {x: 0, y: 0}
Inherited from
WrapperElementProps.contentOffset
Defined in
node_modules/@types/react-native/index.d.ts:6472
decelerationRate
• Optional decelerationRate: number | "normal" | "fast"
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
Inherited from
WrapperElementProps.decelerationRate
Defined in
node_modules/@types/react-native/index.d.ts:6671
directionalLockEnabled
• Optional directionalLockEnabled: boolean
When true the ScrollView will try to lock to only vertical or horizontal scrolling while dragging. The default value is false.
Inherited from
WrapperElementProps.directionalLockEnabled
Defined in
node_modules/@types/react-native/index.d.ts:6484
disableIntervalMomentum
• Optional disableIntervalMomentum: boolean
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.
Inherited from
WrapperElementProps.disableIntervalMomentum
Defined in
node_modules/@types/react-native/index.d.ts:6829
disableScrollViewPanResponder
• Optional disableScrollViewPanResponder: boolean
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.
Inherited from
WrapperElementProps.disableScrollViewPanResponder
Defined in
node_modules/@types/react-native/index.d.ts:6838
endFillColor
• Optional endFillColor: ColorValue
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.
Inherited from
WrapperElementProps.endFillColor
Defined in
node_modules/@types/react-native/index.d.ts:6599
fadingEdgeLength
• Optional fadingEdgeLength: number
Fades out the edges of the 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
Inherited from
WrapperElementProps.fadingEdgeLength
Defined in
node_modules/@types/react-native/index.d.ts:6635
fixed
• Optional fixed: boolean
Quick way to make the content not scrollable
Inherited from
WrapperElementProps.fixed
Defined in
focusable
• Optional focusable: boolean
Whether this View should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
Inherited from
WrapperElementProps.focusable
Defined in
node_modules/@types/react-native/index.d.ts:2243
hasTVPreferredFocus
• Optional hasTVPreferredFocus: boolean
(Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view.
platform ios
Inherited from
WrapperElementProps.hasTVPreferredFocus
Defined in
node_modules/@types/react-native/index.d.ts:2155
hitSlop
• Optional hitSlop: Insets
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.
Inherited from
WrapperElementProps.hitSlop
Defined in
node_modules/@types/react-native/index.d.ts:2493
horizontal
• Optional horizontal: null | boolean
When true the scroll view's children are arranged horizontally in a row instead of vertically in a column. The default value is false.
Inherited from
WrapperElementProps.horizontal
Defined in
node_modules/@types/react-native/index.d.ts:6677
importantForAccessibility
• Optional importantForAccessibility: "auto" | "yes" | "no" | "no-hide-descendants"
Controls how view is important for accessibility which is if it fires accessibility events and if it is reported to accessibility services that query the screen. Works for Android only. See http://developer.android.com/reference/android/R.attr.html#importantForAccessibility for references.
Possible values: 'auto' - The system determines whether the view is important for accessibility - default (recommended). 'yes' - The view is important for accessibility. 'no' - The view is not important for accessibility. 'no-hide-descendants' - The view is not important for accessibility, nor are any of its descendant views.
Inherited from
WrapperElementProps.importantForAccessibility
Defined in
node_modules/@types/react-native/index.d.ts:2431
indicatorStyle
• Optional indicatorStyle: "default" | "black" | "white"
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.
Inherited from
WrapperElementProps.indicatorStyle
Defined in
node_modules/@types/react-native/index.d.ts:6494
invertStickyHeaders
• Optional invertStickyHeaders: boolean
If sticky headers should stick at the bottom instead of the top of the ScrollView. This is usually used with inverted ScrollViews.
Inherited from
WrapperElementProps.invertStickyHeaders
Defined in
node_modules/@types/react-native/index.d.ts:6683
isTVSelectable
• Optional isTVSelectable: boolean
(Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote.
platform ios
Inherited from
WrapperElementProps.isTVSelectable
Defined in
node_modules/@types/react-native/index.d.ts:2148
keyboardDismissMode
• Optional keyboardDismissMode: "none" | "interactive" | "on-drag"
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.
Inherited from
WrapperElementProps.keyboardDismissMode
Defined in
node_modules/@types/react-native/index.d.ts:6693
keyboardShouldPersistTaps
• Optional keyboardShouldPersistTaps: boolean | "never" | "always" | "handled"
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
Inherited from
WrapperElementProps.keyboardShouldPersistTaps
Defined in
node_modules/@types/react-native/index.d.ts:6703
keyboardVerticalOffset
• Optional keyboardVerticalOffset: number
Space to be shown at the bottom when the keyboard is up. Default - 0
Inherited from
WrapperElementProps.keyboardVerticalOffset
Defined in
maintainVisibleContentPosition
• Optional maintainVisibleContentPosition: null | { autoscrollToTopThreshold?: null | number ; minIndexForVisible: number }
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.
Inherited from
WrapperElementProps.maintainVisibleContentPosition
Defined in
node_modules/@types/react-native/index.d.ts:6518
maximumZoomScale
• Optional maximumZoomScale: number
The maximum allowed zoom scale. The default value is 1.0.
Inherited from
WrapperElementProps.maximumZoomScale
Defined in
node_modules/@types/react-native/index.d.ts:6525
minimumZoomScale
• Optional minimumZoomScale: number
The minimum allowed zoom scale. The default value is 1.0.
Inherited from
WrapperElementProps.minimumZoomScale
Defined in
node_modules/@types/react-native/index.d.ts:6530
nativeID
• Optional nativeID: string
Used to reference react managed views from native code.
Inherited from
WrapperElementProps.nativeID
Defined in
node_modules/@types/react-native/index.d.ts:2545
needsOffscreenAlphaCompositing
• Optional needsOffscreenAlphaCompositing: boolean
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.
Inherited from
WrapperElementProps.needsOffscreenAlphaCompositing
Defined in
node_modules/@types/react-native/index.d.ts:2229
nestedScrollEnabled
• Optional nestedScrollEnabled: boolean
Enables nested scrolling for Android API level 21+. Nested scrolling is supported by default on iOS.
Inherited from
WrapperElementProps.nestedScrollEnabled
Defined in
node_modules/@types/react-native/index.d.ts:6623
onAccessibilityAction
• Optional onAccessibilityAction: (event: AccessibilityActionEvent) => void
Type declaration
▸ (event): void
When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action.
Parameters
event
AccessibilityActionEvent
Returns
void
Inherited from
WrapperElementProps.onAccessibilityAction
Defined in
node_modules/@types/react-native/index.d.ts:2294
onAccessibilityEscape
• Optional onAccessibilityEscape: () => void
Type declaration
▸ (): void
When accessibile is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).
platform ios
Returns
void
Inherited from
WrapperElementProps.onAccessibilityEscape
Defined in
node_modules/@types/react-native/index.d.ts:2452
onAccessibilityTap
• Optional onAccessibilityTap: () => void
Type declaration
▸ (): void
When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture.
platform ios
Returns
void
Inherited from
WrapperElementProps.onAccessibilityTap
Defined in
node_modules/@types/react-native/index.d.ts:2458
onContentSizeChange
• Optional onContentSizeChange: (w: number, h: number) => void
Type declaration
▸ (w, h): void
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.
Parameters
w
number
h
number
Returns
void
Inherited from
WrapperElementProps.onContentSizeChange
Defined in
node_modules/@types/react-native/index.d.ts:6711
onLayout
• Optional onLayout: (event: LayoutChangeEvent) => void
Type declaration
▸ (event): void
Invoked on mount and layout changes with
{nativeEvent: { layout: {x, y, width, height}}}.
Parameters
event
LayoutChangeEvent
Returns
void
Inherited from
WrapperElementProps.onLayout
Defined in
node_modules/@types/react-native/index.d.ts:2500
onMagicTap
• Optional onMagicTap: () => void
Type declaration
▸ (): void
When accessible is true, the system will invoke this function when the user performs the magic tap gesture.
platform ios
Returns
void
Inherited from
WrapperElementProps.onMagicTap
Defined in
node_modules/@types/react-native/index.d.ts:2464
onMomentumScrollBegin
• Optional onMomentumScrollBegin: (event: NativeSyntheticEvent<NativeScrollEvent>) => void
Type declaration
▸ (event): void
Fires when scroll view has begun moving
Parameters
event
NativeSyntheticEvent<NativeScrollEvent>
Returns
void
Inherited from
WrapperElementProps.onMomentumScrollBegin
Defined in
node_modules/@types/react-native/index.d.ts:6737
onMomentumScrollEnd
• Optional onMomentumScrollEnd: (event: NativeSyntheticEvent<NativeScrollEvent>) => void
Type declaration
▸ (event): void
Fires when scroll view has finished moving
Parameters
event
NativeSyntheticEvent<NativeScrollEvent>
Returns
void
Inherited from
WrapperElementProps.onMomentumScrollEnd
Defined in
node_modules/@types/react-native/index.d.ts:6732
onMoveShouldSetResponder
• Optional onMoveShouldSetResponder: (event: GestureResponderEvent) => boolean
Type declaration
▸ (event): boolean
Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
Parameters
event
GestureResponderEvent
Returns
boolean
Inherited from
WrapperElementProps.onMoveShouldSetResponder
Defined in
node_modules/@types/react-native/index.d.ts:1978
onMoveShouldSetResponderCapture
• Optional onMoveShouldSetResponderCapture: (event: GestureResponderEvent) => boolean
Type declaration
▸ (event): boolean
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.
Parameters
event
GestureResponderEvent
Returns
boolean
Inherited from
WrapperElementProps.onMoveShouldSetResponderCapture
Defined in
node_modules/@types/react-native/index.d.ts:2054
onResponderEnd
• Optional onResponderEnd: (event: GestureResponderEvent) => void
Type declaration
▸ (event): void
If the View returns true and attempts to become the responder, one of the following will happen:
Parameters
event
GestureResponderEvent
Returns
void
Inherited from
WrapperElementProps.onResponderEnd
Defined in
node_modules/@types/react-native/index.d.ts:1984
onResponderGrant
• Optional onResponderGrant: (event: GestureResponderEvent) => void
Type declaration
▸ (event): void
The View is now responding for touch events. This is the time to highlight and show the user what is happening
Parameters
event
GestureResponderEvent
Returns
void
Inherited from
WrapperElementProps.onResponderGrant
Defined in
node_modules/@types/react-native/index.d.ts:1990
onResponderMove
• Optional onResponderMove: (event: GestureResponderEvent) => void
Type declaration
▸ (event): void
The user is moving their finger
Parameters
event
GestureResponderEvent
Returns
void
Inherited from
WrapperElementProps.onResponderMove
Defined in
node_modules/@types/react-native/index.d.ts:2004
onResponderReject
• Optional onResponderReject: (event: GestureResponderEvent) => void
Type declaration
▸ (event): void
Something else is the responder right now and will not release it
Parameters
event
GestureResponderEvent
Returns
void
Inherited from
WrapperElementProps.onResponderReject
Defined in
node_modules/@types/react-native/index.d.ts:1995
onResponderRelease
• Optional onResponderRelease: (event: GestureResponderEvent) => void
Type declaration
▸ (event): void
Fired at the end of the touch, ie "touchUp"
Parameters
event
GestureResponderEvent
Returns
void
Inherited from
WrapperElementProps.onResponderRelease
Defined in
node_modules/@types/react-native/index.d.ts:2009
onResponderStart
• Optional onResponderStart: (event: GestureResponderEvent) => void
Type declaration
▸ (event): void
Parameters
event
GestureResponderEvent
Returns
void
Inherited from
WrapperElementProps.onResponderStart
Defined in
node_modules/@types/react-native/index.d.ts:2011
onResponderTerminate
• Optional onResponderTerminate: (event: GestureResponderEvent) => void
Type declaration
▸ (event): void
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)
Parameters
event
GestureResponderEvent
Returns
void
Inherited from
WrapperElementProps.onResponderTerminate
Defined in
node_modules/@types/react-native/index.d.ts:2024
onResponderTerminationRequest
• Optional onResponderTerminationRequest: (event: GestureResponderEvent) => boolean
Type declaration
▸ (event): boolean
Something else wants to become responder. Should this view release the responder? Returning true allows release
Parameters
event
GestureResponderEvent
Returns
boolean
Inherited from
WrapperElementProps.onResponderTerminationRequest
Defined in
node_modules/@types/react-native/index.d.ts:2017
onScroll
• Optional onScroll: (event: NativeSyntheticEvent<NativeScrollEvent>) => void
Type declaration
▸ (event): void
Fires at most once per frame during scrolling. The frequency of the events can be contolled using the scrollEventThrottle prop.
Parameters
event
NativeSyntheticEvent<NativeScrollEvent>
Returns
void
Inherited from
WrapperElementProps.onScroll
Defined in
node_modules/@types/react-native/index.d.ts:6717
onScrollAnimationEnd
• Optional onScrollAnimationEnd: () => void
Type declaration
▸ (): void
Called when a scrolling animation ends.
Returns
void
Inherited from
WrapperElementProps.onScrollAnimationEnd
Defined in
node_modules/@types/react-native/index.d.ts:6535
onScrollBeginDrag
• Optional onScrollBeginDrag: (event: NativeSyntheticEvent<NativeScrollEvent>) => void
Type declaration
▸ (event): void
Fires if a user initiates a scroll gesture.
Parameters
event
NativeSyntheticEvent<NativeScrollEvent>
Returns
void
Inherited from
WrapperElementProps.onScrollBeginDrag
Defined in
node_modules/@types/react-native/index.d.ts:6722
onScrollEndDrag
• Optional onScrollEndDrag: (event: NativeSyntheticEvent<NativeScrollEvent>) => void
Type declaration
▸ (event): void
Fires when a user has finished scrolling.
Parameters
event
NativeSyntheticEvent<NativeScrollEvent>
Returns
void
Inherited from
WrapperElementProps.onScrollEndDrag
Defined in
node_modules/@types/react-native/index.d.ts:6727
onScrollToTop
• Optional onScrollToTop: (event: NativeSyntheticEvent<NativeScrollEvent>) => void
Type declaration
▸ (event): void
Fires when the scroll view scrolls to top after the status bar has been tapped
platform ios
Parameters
event
NativeSyntheticEvent<NativeScrollEvent>
Returns
void
Inherited from
WrapperElementProps.onScrollToTop
Defined in
node_modules/@types/react-native/index.d.ts:6583
onStartShouldSetResponder
• Optional onStartShouldSetResponder: (event: GestureResponderEvent) => boolean
Type declaration
▸ (event): boolean
Does this view want to become responder on the start of a touch?
Parameters
event
GestureResponderEvent
Returns
boolean
Inherited from
WrapperElementProps.onStartShouldSetResponder
Defined in
node_modules/@types/react-native/index.d.ts:1973
onStartShouldSetResponderCapture
• Optional onStartShouldSetResponderCapture: (event: GestureResponderEvent) => boolean
Type declaration
▸ (event): boolean
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.
Parameters
event
GestureResponderEvent
Returns
boolean
Inherited from
WrapperElementProps.onStartShouldSetResponderCapture
Defined in
node_modules/@types/react-native/index.d.ts:2039
onTouchCancel
• Optional onTouchCancel: (event: GestureResponderEvent) => void
Type declaration
▸ (event): void
Parameters
event
GestureResponderEvent
Returns
void
Inherited from
WrapperElementProps.onTouchCancel
Defined in
node_modules/@types/react-native/index.d.ts:557
onTouchEnd
• Optional onTouchEnd: (event: GestureResponderEvent) => void
Type declaration
▸ (event): void
Parameters
event
GestureResponderEvent
Returns
void
Inherited from
WrapperElementProps.onTouchEnd
Defined in
node_modules/@types/react-native/index.d.ts:556
onTouchEndCapture
• Optional onTouchEndCapture: (event: GestureResponderEvent) => void
Type declaration
▸ (event): void
Parameters
event
GestureResponderEvent
Returns
void
Inherited from
WrapperElementProps.onTouchEndCapture
Defined in
node_modules/@types/react-native/index.d.ts:558
onTouchMove
• Optional onTouchMove: (event: GestureResponderEvent) => void
Type declaration
▸ (event): void
Parameters
event
GestureResponderEvent
Returns
void
Inherited from
WrapperElementProps.onTouchMove
Defined in
node_modules/@types/react-native/index.d.ts:555
onTouchStart
• Optional onTouchStart: (event: GestureResponderEvent) => void
Type declaration
▸ (event): void
Parameters
event
GestureResponderEvent
Returns
void
Inherited from
WrapperElementProps.onTouchStart
Defined in
node_modules/@types/react-native/index.d.ts:554
overScrollMode
• Optional overScrollMode: "auto" | "never" | "always"
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.
Inherited from
WrapperElementProps.overScrollMode
Defined in
node_modules/@types/react-native/index.d.ts:6618
pagingEnabled
• Optional pagingEnabled: boolean
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.
Inherited from
WrapperElementProps.pagingEnabled
Defined in
node_modules/@types/react-native/index.d.ts:6744
persistentScrollbar
• Optional persistentScrollbar: boolean
Causes the scrollbars not to turn transparent when they are not in use. The default value is false.
Inherited from
WrapperElementProps.persistentScrollbar
Defined in
node_modules/@types/react-native/index.d.ts:6640
pinchGestureEnabled
• Optional pinchGestureEnabled: boolean
When true, ScrollView allows use of pinch gestures to zoom in and out. The default value is true.
Inherited from
WrapperElementProps.pinchGestureEnabled
Defined in
node_modules/@types/react-native/index.d.ts:6541
pointerEvents
• Optional pointerEvents: "none" | "auto" | "box-none" | "box-only"
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.
Inherited from
WrapperElementProps.pointerEvents
Defined in
node_modules/@types/react-native/index.d.ts:2525
refreshControl
• Optional refreshControl: ReactElement<RefreshControlProps, string | JSXElementConstructor<any>>
A RefreshControl component, used to provide pull-to-refresh functionality for the ScrollView.
Inherited from
WrapperElementProps.refreshControl
Defined in
node_modules/@types/react-native/index.d.ts:6783
removeClippedSubviews
• Optional removeClippedSubviews: boolean
Experimental: When true offscreen child views (whose overflow value is hidden) are removed from their native backing superview when offscreen. This canimprove scrolling performance on long lists. The default value is false.
Inherited from
WrapperElementProps.removeClippedSubviews
Defined in
node_modules/@types/react-native/index.d.ts:6757
renderToHardwareTextureAndroid
• Optional renderToHardwareTextureAndroid: boolean
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.
Inherited from
WrapperElementProps.renderToHardwareTextureAndroid
Defined in
node_modules/@types/react-native/index.d.ts:2238
scrollEnabled
• Optional scrollEnabled: boolean
When false, the content does not scroll. The default value is true
Inherited from
WrapperElementProps.scrollEnabled
Defined in
node_modules/@types/react-native/index.d.ts:6749
scrollEventThrottle
• Optional scrollEventThrottle: number
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 sent over the bridge. The default value is zero, which means the scroll event will be sent only once each time the view is scrolled.
Inherited from
WrapperElementProps.scrollEventThrottle
Defined in
node_modules/@types/react-native/index.d.ts:6549
scrollIndicatorInsets
• Optional scrollIndicatorInsets: Insets
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}.
Inherited from
WrapperElementProps.scrollIndicatorInsets
Defined in
node_modules/@types/react-native/index.d.ts:6556
scrollPerfTag
• Optional scrollPerfTag: string
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
Inherited from
WrapperElementProps.scrollPerfTag
Defined in
node_modules/@types/react-native/index.d.ts:6608
scrollToOverflowEnabled
• Optional scrollToOverflowEnabled: boolean
When true, the scroll view can be programmatically scrolled beyond its content size. The default value is false.
platform ios
Inherited from
WrapperElementProps.scrollToOverflowEnabled
Defined in
node_modules/@types/react-native/index.d.ts:6563
scrollsToTop
• Optional scrollsToTop: boolean
When true the scroll view scrolls to top when the status bar is tapped. The default value is true.
Inherited from
WrapperElementProps.scrollsToTop
Defined in
node_modules/@types/react-native/index.d.ts:6569
shouldRasterizeIOS
• Optional shouldRasterizeIOS: boolean
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.
Inherited from
WrapperElementProps.shouldRasterizeIOS
Defined in
node_modules/@types/react-native/index.d.ts:2204
showsHorizontalScrollIndicator
• Optional showsHorizontalScrollIndicator: boolean
When true, shows a horizontal scroll indicator.
Inherited from
WrapperElementProps.showsHorizontalScrollIndicator
Defined in
node_modules/@types/react-native/index.d.ts:6762
showsVerticalScrollIndicator
• Optional showsVerticalScrollIndicator: boolean
When true, shows a vertical scroll indicator.
Inherited from
WrapperElementProps.showsVerticalScrollIndicator
Defined in
node_modules/@types/react-native/index.d.ts:6767
snapToAlignment
• Optional snapToAlignment: "center" | "start" | "end"
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)
Inherited from
WrapperElementProps.snapToAlignment
Defined in
node_modules/@types/react-native/index.d.ts:6577
snapToEnd
• Optional snapToEnd: boolean
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.
Inherited from
WrapperElementProps.snapToEnd
Defined in
node_modules/@types/react-native/index.d.ts:6813
snapToInterval
• Optional snapToInterval: number
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.
Inherited from
WrapperElementProps.snapToInterval
Defined in
node_modules/@types/react-native/index.d.ts:6791
snapToOffsets
• Optional snapToOffsets: number[]
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.
Inherited from
WrapperElementProps.snapToOffsets
Defined in
node_modules/@types/react-native/index.d.ts:6799
snapToStart
• Optional snapToStart: boolean
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.
Inherited from
WrapperElementProps.snapToStart
Defined in
node_modules/@types/react-native/index.d.ts:6806
stickyHeaderHiddenOnScroll
• Optional stickyHeaderHiddenOnScroll: boolean
When true, Sticky header is hidden when scrolling down, and dock at the top when scrolling up.
Inherited from
WrapperElementProps.stickyHeaderHiddenOnScroll
Defined in
node_modules/@types/react-native/index.d.ts:6772
stickyHeaderIndices
• Optional stickyHeaderIndices: number[]
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}.
Inherited from
WrapperElementProps.stickyHeaderIndices
Defined in
node_modules/@types/react-native/index.d.ts:6822
style
• Optional style: StyleProp<ViewStyle>
Style
Inherited from
WrapperElementProps.style
Defined in
node_modules/@types/react-native/index.d.ts:6777
testID
• Optional testID: string
Used to locate this view in end-to-end tests.
Inherited from
WrapperElementProps.testID
Defined in
node_modules/@types/react-native/index.d.ts:2540
tvParallaxMagnification
• Optional tvParallaxMagnification: number
(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
Inherited from
WrapperElementProps.tvParallaxMagnification
Defined in
node_modules/@types/react-native/index.d.ts:2190
tvParallaxProperties
• Optional tvParallaxProperties: TVParallaxProperties
(Apple TV only) Object with properties to control Apple TV parallax effects.
platform ios
Inherited from
WrapperElementProps.tvParallaxProperties
Defined in
node_modules/@types/react-native/index.d.ts:2162
tvParallaxShiftDistanceX
• Optional tvParallaxShiftDistanceX: number
(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
Inherited from
WrapperElementProps.tvParallaxShiftDistanceX
Defined in
node_modules/@types/react-native/index.d.ts:2169
tvParallaxShiftDistanceY
• Optional tvParallaxShiftDistanceY: number
(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
Inherited from
WrapperElementProps.tvParallaxShiftDistanceY
Defined in
node_modules/@types/react-native/index.d.ts:2176
tvParallaxTiltAngle
• Optional tvParallaxTiltAngle: number
(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
Inherited from
WrapperElementProps.tvParallaxTiltAngle
Defined in
node_modules/@types/react-native/index.d.ts:2183
type
• Optional type: "scrollView" | "list" | "fullScreenView"
Container type. 'scrollview' - Allows the content to be scrollable. 'list' - When the page contains only a flatlist. 'fixed' - content is not scrollable.
Inherited from
WrapperElementProps.type
Defined in
zoomScale
• Optional zoomScale: number
The current scale of the scroll view content. The default value is 1.0.
Inherited from
WrapperElementProps.zoomScale
Defined in
node_modules/@types/react-native/index.d.ts:6588
Last updated
Was this helpful?