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 activeOptional activityOptional 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 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 customBoolean indicating that swipe dismissal should trigger animation provided by stackAnimation. Defaults to false.
ios
Optional enabledAll children screens should have the same value of their "enabled" prop as their container.
Optional focusableWhether this View should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
Optional freezeWhether inactive screens should be suspended from re-rendering. Defaults to false.
When enableFreeze() is run at the top of the application defaults to true.
Optional fullBoolean indicating whether the swipe gesture should work on whole screen. Swiping with this option results in the same transition animation as simple_push by default.
It can be changed to other custom animations with customAnimationOnSwipe prop, but default iOS swipe animation is not achievable due to usage of custom recognizer.
Defaults to false.
ios
Optional gestureWhether you can use gestures to dismiss this screen. Defaults to true.
ios
Optional gestureUse it to restrict the distance from the edges of screen in which the gesture should be recognized. To be used alongside fullScreenSwipeEnabled.
ios
Optional hasInternal boolean used to detect if current header has large title on iOS.
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 hideWhether the keyboard should hide when swiping to the previous screen. Defaults to false.
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 homeWhether the home indicator should be hidden on this screen. Defaults to false.
ios
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 isInternal boolean used to not attach events used only by native-stack. It prevents non native-stack navigators from sending transition progress from their Screen components.
Optional isTVSelectable(Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote.
ios
Optional nativeBoolean indicating whether, when the Android default back button is clicked, the pop action should be performed on the native side or on the JS side to be able to prevent it.
Unfortunately the same behavior is not available on iOS since the behavior of native back button cannot be changed there.
Defaults to false.
android
Optional nativeIDUsed to reference react managed views from native code.
Optional navigationSets the navigation bar color. Defaults to initial status bar color.
android
Optional navigationSets the visibility of the navigation bar. Defaults to false.
android
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 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 onA callback that gets called when the current screen appears.
Optional onOptional onA callback that gets called when the current screen disappears.
Optional onA callback that gets called when the current screen is dismissed by hardware back (on Android) or dismiss gesture (swipe back or down). The callback takes the number of dismissed screens as an argument since iOS 14 native header back button can pop more than 1 screen at a time.
Optional onA callback that gets called after swipe back is canceled.
Optional onAn internal callback that gets called when the native header back button is clicked on Android and enableNativeBackButtonDismissal is set to false. It dismises the screen using navigation.pop().
android
Optional onA callback that gets called when the header height has changed.
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 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 onAn internal callback called when screen is dismissed by gesture or by native header back button and preventNativeDismiss is set to true.
ios
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 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 onAn internal callback called every frame during the transition of screens of native-stack, used to feed transition context.
Optional onA callback that gets called when the current screen will appear. This is called as soon as the transition begins.
Optional onA callback that gets called when the current screen will disappear. This is called as soon as the transition begins.
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 preventBoolean indicating whether to prevent current screen from being dismissed.
Defaults to false.
ios
Optional refOptional removeThis is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
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 replaceHow should the screen replacing another screen animate. Defaults to pop.
The following values are currently supported:
Optional roleIndicates to accessibility services to treat UI component like a specific role.
Optional screenIn which orientation should the screen appear. The following values are currently supported:
Optional sheetDescribes heights where a sheet can rest.
Works only when stackPresentation is set to formSheet.
Defaults to large.
Available values:
large - only large detent level will be allowedmedium - only medium detent level will be allowedall - all detent levels will be allowedios
Optional sheetThe corner radius that the sheet will try to render with.
Works only when stackPresentation is set to formSheet.
If set to non-negative value it will try to render sheet with provided radius, else it will apply system default.
If left unset system default is used.
ios
Optional sheetWhether the sheet should expand to larger detent when scrolling.
Works only when stackPresentation is set to formSheet.
Defaults to true.
ios
Optional sheetBoolean indicating whether the sheet shows a grabber at the top.
Works only when stackPresentation is set to formSheet.
Defaults to false.
ios
Optional sheetThe largest sheet detent for which a view underneath won't be dimmed.
Works only when stackPresentation is set to formSheet.
If this prop is set to:
large - the view underneath won't be dimmed at any detent levelmedium - the view underneath will be dimmed only when detent level is largeall - the view underneath will be dimmed for any detent levelDefaults to all.
ios
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 stackHow the screen should appear/disappear when pushed or popped at the top of the stack. The following values are currently supported:
slide_from_bottom – performs a slide from bottom animationOptional stackHow should the screen be presented. The following values are currently supported:
Optional statusSets the status bar animation (similar to the StatusBar component). Requires enabling (or deleting) View controller-based status bar appearance in your Info.plist file on iOS.
Optional statusSets the status bar color (similar to the StatusBar component). Defaults to initial status bar color.
android
Optional statusWhether the status bar should be hidden on this screen. Requires enabling (or deleting) View controller-based status bar appearance in your Info.plist file on iOS. Defaults to false.
Optional statusSets the status bar color (similar to the StatusBar component). Requires enabling (or deleting) View controller-based status bar appearance in your Info.plist file on iOS. Defaults to auto.
Optional statusSets the translucency of the status bar. Defaults to false.
android
Optional styleOptional swipeSets the direction in which you should swipe to dismiss the screen.
When using vertical option, options fullScreenSwipeEnabled: true, customAnimationOnSwipe: true and stackAnimation: 'slide_from_bottom' are set by default.
The following values are supported:
vertical – dismiss screen verticallyhorizontal – dismiss screen horizontally (default)ios
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 transitionChanges the duration (in milliseconds) of slide_from_bottom, fade_from_bottom, fade and simple_push transitions on iOS. Defaults to 350.
The duration of default and flip transitions isn't customizable.
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 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
See
https://reactnative.dev/docs/view#props