Skip to main content

TextView

A common component for styling text in the application. It also conforms to the Box properties so you don't need to wrap it with a Box view for margins / paddings

NameTypeDefault ValueRequiredDescription
accessiblebooleanNoWhen true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
accessibilityActionsreadonly Readonly<{ name: string; label?: string; }>[]NoProvides an array of custom actions available for accessibility.
accessibilityLabelstringNoOverrides 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-labelstringNoAlias for accessibilityLabel https://reactnative.dev/docs/view#accessibilitylabel https://github.com/facebook/react-native/issues/34424
accessibilityRoleAccessibilityRoleNoAccessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
accessibilityStateAccessibilityStateNoAccessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
aria-busybooleanNoalias for accessibilityState see https://reactnative.dev/docs/accessibility#accessibilitystate
aria-checkedboolean | "mixed"No
aria-disabledbooleanNo
aria-expandedbooleanNo
aria-selectedbooleanNo
accessibilityHintstringNoAn 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.
accessibilityValueAccessibilityValueNoRepresents 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-valuemaxnumberNo
aria-valueminnumberNo
aria-valuenownumberNo
aria-valuetextstringNo
onAccessibilityAction(event: AccessibilityActionEvent) => voidNoWhen `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-hiddenbooleanNoA value indicating whether the accessibility elements contained within this accessibility element are hidden.
aria-modalbooleanNo
roleRoleNoIndicates to accessibility services to treat UI component like a specific role.
accessibilityLabelledBystring | string[]NoIdentifies 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-labelledbystringNoIdentifies 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"NoIndicates 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"NoIndicates 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
accessibilityElementsHiddenbooleanNoA Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. @platform ios
accessibilityViewIsModalbooleanNoA Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. @platform ios
onAccessibilityEscape() => voidNoWhen accessible is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers). @platform ios
onAccessibilityTap() => voidNoWhen `accessible` is true, the system will try to invoke this function when the user performs accessibility tap gesture. @platform ios
onMagicTap() => voidNoWhen accessible is true, the system will invoke this function when the user performs the magic tap gesture. @platform ios
accessibilityIgnoresInvertColorsbooleanNohttps://reactnative.dev/docs/accessibility#accessibilityignoresinvertcolorsios @platform ios
accessibilityLanguagestringNoBy 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
childrenReactNodeNoreact nodes passed to the component
hitSlopnumber | InsetsNoThis 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.
idstringNoUsed to reference react managed views from native code.
needsOffscreenAlphaCompositingbooleanNoWhether 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) => voidNoInvoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
pointerEvents"none" | "box-none" | "box-only" | "auto"NoIn 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.
removeClippedSubviewsbooleanNoThis 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).
styleStyleProp<ViewStyle>No
testIDstringNoUsed to locate this view in end-to-end tests. Optional TestID
nativeIDstringNoUsed to reference react managed views from native code.
collapsablebooleanNoViews 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.
collapsableChildrenbooleanNoSetting 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.
renderToHardwareTextureAndroidbooleanNoWhether 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.
focusablebooleanNoWhether this `View` should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
tabIndex0 | -1NoIndicates 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)
shouldRasterizeIOSbooleanNoWhether 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.
isTVSelectablebooleanNo*(Apple TV only)* When set to true, this view will be focusable and navigable using the Apple TV remote. @platform ios
hasTVPreferredFocusbooleanNo*(Apple TV only)* May be set to true to force the Apple TV focus engine to move focus to this view. @platform ios
tvParallaxShiftDistanceXnumberNo*(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
tvParallaxShiftDistanceYnumberNo*(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
tvParallaxTiltAnglenumberNo*(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
tvParallaxMagnificationnumberNo*(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) => booleanNoDoes this view want to become responder on the start of a touch?
onMoveShouldSetResponder(event: GestureResponderEvent) => booleanNoCalled for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
onResponderEnd(event: GestureResponderEvent) => voidNoIf the View returns true and attempts to become the responder, one of the following will happen:
onResponderGrant(event: GestureResponderEvent) => voidNoThe View is now responding for touch events. This is the time to highlight and show the user what is happening
onResponderReject(event: GestureResponderEvent) => voidNoSomething else is the responder right now and will not release it
onResponderMove(event: GestureResponderEvent) => voidNoThe user is moving their finger
onResponderRelease(event: GestureResponderEvent) => voidNoFired at the end of the touch, ie "touchUp"
onResponderStart(event: GestureResponderEvent) => voidNo
onResponderTerminationRequest(event: GestureResponderEvent) => booleanNoSomething else wants to become responder. Should this view release the responder? Returning true allows release
onResponderTerminate(event: GestureResponderEvent) => voidNoThe 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) => booleanNoonStartShouldSetResponder 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) => booleanNoonStartShouldSetResponder 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) => voidNo
onTouchMove(event: GestureResponderEvent) => voidNo
onTouchEnd(event: GestureResponderEvent) => voidNo
onTouchCancel(event: GestureResponderEvent) => voidNo
onTouchEndCapture(event: GestureResponderEvent) => voidNo
onPointerEnter(event: PointerEvent) => voidNo
onPointerEnterCapture(event: PointerEvent) => voidNo
onPointerLeave(event: PointerEvent) => voidNo
onPointerLeaveCapture(event: PointerEvent) => voidNo
onPointerMove(event: PointerEvent) => voidNo
onPointerMoveCapture(event: PointerEvent) => voidNo
onPointerCancel(event: PointerEvent) => voidNo
onPointerCancelCapture(event: PointerEvent) => voidNo
onPointerDown(event: PointerEvent) => voidNo
onPointerDownCapture(event: PointerEvent) => voidNo
onPointerUp(event: PointerEvent) => voidNo
onPointerUpCapture(event: PointerEvent) => voidNo
mNumOrStrPxNoset margin of this component
mtNumOrStrPxNoset margin top of this component
mrNumOrStrPxNoset margin right of this component
mbNumOrStrPxNoset margin bottom of this component
mlNumOrStrPxNoset margin left of this component
mxNumOrStrPxNoset margin right and left of this component
myNumOrStrPxNoset margin top and bottom of this component
pNumOrStrPxNoset padding of this component
ptNumOrStrPxNoset padding top of this component
prNumOrStrPxNoset padding right of this component
pbNumOrStrPxNoset padding bottom of this component
plNumOrStrPxNoset padding left of this component
pxNumOrStrPxNoset padding right and left of this component
pyNumOrStrPxNoset padding top and bottom of this component
topstring | numberNosets the number of logical pixels to offset the top edge of this component
leftstring | numberNosets the number of logical pixels to offset the left edge of this component
rightstring | numberNosets the number of logical pixels to offset the right edge of this component
bottomstring | numberNosets the number of logical pixels to offset the bottom edge of this component
position"relative" | "absolute"Nosets the positioning to relative or absolute of this component
display"none" | "flex"Nosets the display type of this component
flexnumberNosets the flex property of this component
flexGrownumberNodescribes how any space within a container should be distributed among its children along the main axis
flexShrinknumberNoflexShrink describes how to shrink children along the main axis in the case in which the total size of the children overflows the size of the container on the main axis
flexWrap"wrap" | "nowrap" | "wrap-reverse"Nocontrols whether children can wrap around after they hit the end of a flex container
flexDirection"row" | "column"Nocontrols which directions children of a container go
gapnumberNosets the gaps between rows and columns
overflow"hidden" | "visible" | "scroll"Nocontrols how children are measured and displayed
justifyContent"center" | "flex-start" | "flex-end" | "space-between"Noaligns children in the main direction
alignItems"center" | "flex-start" | "flex-end"Noaligns children in the cross direction
alignSelf"auto" | FlexAlignTypeNocontrols how a child aligns in the cross direction, overriding the alignItems of the parent
widthstring | numberNosets the width of this component
minWidthstring | numberNosets the min width of this component
heightstring | numberNosets the height of this component
minHeightstring | numberNosets the min height of this component
textAlign"left" | "right" | "center"Noalings the text of this component
backgroundColorBackgroundVariantNosets the background color of this component
opacitynumberNosets the opacity of this component
borderWidthBorderWidthsNosets the border width of this component
borderColorBorderColorVariantNosets the border color of this component
borderStyleBorderStylesNosets the border style of this component
borderBottomWidthBorderWidthsNosets the bottom border's width of this component
borderBottomColorBorderColorVariantNosets the bottom border's color of this component
borderTopWidthBorderWidthsNosets the top border's width of this component
borderTopColorBorderColorVariantNosets the top border's color of this component
borderRightWidthBorderWidthsNosets the right border's width of this component
borderRightColorBorderColorVariantNosets the right border's color of this component
borderLeftWidthBorderWidthsNosets the left border's width of this component
borderLeftColorBorderColorVariantNosets the left border's color of this component
borderRadiusstring | numberNosets the border's radius of this component
borderRadiusTopstring | numberNosets the border radius just for the top of the component
borderRadiusBottomstring | numberNosets the border radius just for the bottom of the component
colorstring | number | symbolNoDefaults to primary text
variantstring | number | symbolNoDefaults to regular
textTransform"none" | "uppercase" | "lowercase" | "capitalize"NoThe text transformation
textDecoration"none" | "underline" | "line-through" | "underline line-through"Notext decoration
textDecorationColorstring | number | symbolNotext decoration color
onPress() => voidNoonPress callback
allowFontScalingbooleanNoif false font won't scale if screen font size changes
selectablebooleanfalseNoif true the text will be selectable
numberOfLinesnumberNoif set, sets the number of lines the text will render on. if the text exceeds the line amount, it will ellipsis
maxFontSizeMultipliernumberNoMax size for font when user adjusts their font scaling
paragraphSpacingbooleanfalseNoif true apply paragraphSpacing, it overrides the mb if supplied