SurfaceViewProps

Extends

• ViewProps

Properties

accessibilityActions?

optional accessibilityActions: readonly Readonly<{ label: string; name: string; }>[]

Provides an array of custom actions available for accessibility.

Inherited from

ViewProps.accessibilityActions

---

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

ViewProps.accessibilityElementsHidden

---

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

ViewProps.accessibilityHint

---

accessibilityIgnoresInvertColors?

optional accessibilityIgnoresInvertColors: boolean

https://reactnative.dev/docs/accessibility#accessibilityignoresinvertcolorsios

Platform

ios

Inherited from

ViewProps.accessibilityIgnoresInvertColors

---

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

ViewProps.accessibilityLabel

---

accessibilityLabelledBy?

optional accessibilityLabelledBy: string | string[]

A reference to another element nativeID used to build complex forms. The value of accessibilityLabelledBy should match the nativeID of the related element.

Platform

android

Inherited from

ViewProps.accessibilityLabelledBy

---

accessibilityLanguage?

optional accessibilityLanguage: string

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

Inherited from

ViewProps.accessibilityLanguage

---

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

ViewProps.accessibilityLiveRegion

---

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

ViewProps.accessibilityRole

---

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

ViewProps.accessibilityState

---

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

ViewProps.accessibilityValue

---

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

ViewProps.accessibilityViewIsModal

---

accessible?

optional accessible: boolean

When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.

Inherited from

ViewProps.accessible

---

aria-busy?

optional aria-busy: boolean

alias for accessibilityState

see https://reactnative.dev/docs/accessibility#accessibilitystate

Inherited from

ViewProps.aria-busy

---

aria-checked?

optional aria-checked: boolean | "mixed"

Inherited from

ViewProps.aria-checked

---

aria-disabled?

optional aria-disabled: boolean

Inherited from

ViewProps.aria-disabled

---

aria-expanded?

optional aria-expanded: boolean

Inherited from

ViewProps.aria-expanded

---

aria-hidden?

optional aria-hidden: boolean

A value indicating whether the accessibility elements contained within this accessibility element are hidden.

Inherited from

ViewProps.aria-hidden

---

aria-label?

optional aria-label: string

Alias for accessibilityLabel https://reactnative.dev/docs/view#accessibilitylabel https://github.com/facebook/react-native/issues/34424

Inherited from

ViewProps.aria-label

---

aria-labelledby?

optional aria-labelledby: string

Represents the nativeID of the associated label text. When the assistive technology focuses on the component with this props, the text is read aloud.

Platform

android

Inherited from

ViewProps.aria-labelledby

---

aria-live?

optional aria-live: "off" | "polite" | "assertive"

Inherited from

ViewProps.aria-live

---

aria-modal?

optional aria-modal: boolean

Inherited from

ViewProps.aria-modal

---

aria-selected?

optional aria-selected: boolean

Inherited from

ViewProps.aria-selected

---

aria-valuemax?

optional aria-valuemax: number

Inherited from

ViewProps.aria-valuemax

---

aria-valuemin?

optional aria-valuemin: number

Inherited from

ViewProps.aria-valuemin

---

aria-valuenow?

optional aria-valuenow: number

Inherited from

ViewProps.aria-valuenow

---

aria-valuetext?

optional aria-valuetext: string

Inherited from

ViewProps.aria-valuetext

---

children?

optional children: ReactNode

Inherited from

ViewProps.children

---

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

ViewProps.collapsable

---

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

ViewProps.focusable

---

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

ViewProps.hasTVPreferredFocus

---

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

ViewProps.hitSlop

---

id?

optional id: string

Used to reference react managed views from native code.

Inherited from

ViewProps.id

---

importantForAccessibility?

optional importantForAccessibility: "auto" | "yes" | "no" | "no-hide-descendants"

[Android] Controlling if a view fires accessibility events and if it is reported to accessibility services.

Inherited from

ViewProps.importantForAccessibility

---

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

ViewProps.isTVSelectable

---

nativeID?

optional nativeID: string

Used to reference react managed views from native code.

Inherited from

ViewProps.nativeID

---

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

ViewProps.needsOffscreenAlphaCompositing

---

onAccessibilityAction()?

optional onAccessibilityAction: (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

ViewProps.onAccessibilityAction

---

onAccessibilityEscape()?

optional onAccessibilityEscape: () => void

When accessible is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).

Returns

void

Platform

ios

Inherited from

ViewProps.onAccessibilityEscape

---

onAccessibilityTap()?

optional onAccessibilityTap: () => void

When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture.

Returns

void

Platform

ios

Inherited from

ViewProps.onAccessibilityTap

---

onComponentDidMount?

optional onComponentDidMount: Function

Brief

An event callback that is called when SurfaceView is mounted to render tree.

---

onComponentWillUnmount?

optional onComponentWillUnmount: Function

Brief

An event callback that is called when SurfaceView is unmounted from render tree.

---

onLayout()?

optional onLayout: (event) => void

Invoked on mount and layout changes with

{nativeEvent: { layout: {x, y, width, height}}}.

Parameters

event

LayoutChangeEvent

Returns

void

Inherited from

ViewProps.onLayout

---

onMagicTap()?

optional onMagicTap: () => void

When accessible is true, the system will invoke this function when the user performs the magic tap gesture.

Returns

void

Platform

ios

Inherited from

ViewProps.onMagicTap

---

onMoveShouldSetResponder()?

optional onMoveShouldSetResponder: (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

ViewProps.onMoveShouldSetResponder

---

onMoveShouldSetResponderCapture()?

optional onMoveShouldSetResponderCapture: (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

ViewProps.onMoveShouldSetResponderCapture

---

onPointerCancel()?

optional onPointerCancel: (event) => void

Parameters

event

PointerEvent

Returns

void

Inherited from

ViewProps.onPointerCancel

---

onPointerCancelCapture()?

optional onPointerCancelCapture: (event) => void

Parameters

event

PointerEvent

Returns

void

Inherited from

ViewProps.onPointerCancelCapture

---

onPointerDown()?

optional onPointerDown: (event) => void

Parameters

event

PointerEvent

Returns

void

Inherited from

ViewProps.onPointerDown

---

onPointerDownCapture()?

optional onPointerDownCapture: (event) => void

Parameters

event

PointerEvent

Returns

void

Inherited from

ViewProps.onPointerDownCapture

---

onPointerEnter()?

optional onPointerEnter: (event) => void

Parameters

event

PointerEvent

Returns

void

Inherited from

ViewProps.onPointerEnter

---

onPointerEnterCapture()?

optional onPointerEnterCapture: (event) => void

Parameters

event

PointerEvent

Returns

void

Inherited from

ViewProps.onPointerEnterCapture

---

onPointerLeave()?

optional onPointerLeave: (event) => void

Parameters

event

PointerEvent

Returns

void

Inherited from

ViewProps.onPointerLeave

---

onPointerLeaveCapture()?

optional onPointerLeaveCapture: (event) => void

Parameters

event

PointerEvent

Returns

void

Inherited from

ViewProps.onPointerLeaveCapture

---

onPointerMove()?

optional onPointerMove: (event) => void

Parameters

event

PointerEvent

Returns

void

Inherited from

ViewProps.onPointerMove

---

onPointerMoveCapture()?

optional onPointerMoveCapture: (event) => void

Parameters

event

PointerEvent

Returns

void

Inherited from

ViewProps.onPointerMoveCapture

---

onPointerUp()?

optional onPointerUp: (event) => void

Parameters

event

PointerEvent

Returns

void

Inherited from

ViewProps.onPointerUp

---

onPointerUpCapture()?

optional onPointerUpCapture: (event) => void

Parameters

event

PointerEvent

Returns

void

Inherited from

ViewProps.onPointerUpCapture

---

onResponderEnd()?

optional onResponderEnd: (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

ViewProps.onResponderEnd

---

onResponderGrant()?

optional onResponderGrant: (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

ViewProps.onResponderGrant

---

onResponderMove()?

optional onResponderMove: (event) => void

The user is moving their finger

Parameters

event

GestureResponderEvent

Returns

void

Inherited from

ViewProps.onResponderMove

---

onResponderReject()?

optional onResponderReject: (event) => void

Something else is the responder right now and will not release it

Parameters

event

GestureResponderEvent

Returns

void

Inherited from

ViewProps.onResponderReject

---

onResponderRelease()?

optional onResponderRelease: (event) => void

Fired at the end of the touch, ie "touchUp"

Parameters

event

GestureResponderEvent

Returns

void

Inherited from

ViewProps.onResponderRelease

---

onResponderStart()?

optional onResponderStart: (event) => void

Parameters

event

GestureResponderEvent

Returns

void

Inherited from

ViewProps.onResponderStart

---

onResponderTerminate()?

optional onResponderTerminate: (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

ViewProps.onResponderTerminate

---

onResponderTerminationRequest()?

optional onResponderTerminationRequest: (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

ViewProps.onResponderTerminationRequest

---

onStartShouldSetResponder()?

optional onStartShouldSetResponder: (event) => boolean

Does this view want to become responder on the start of a touch?

Parameters

event

GestureResponderEvent

Returns

boolean

Inherited from

ViewProps.onStartShouldSetResponder

---

onStartShouldSetResponderCapture()?

optional onStartShouldSetResponderCapture: (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

ViewProps.onStartShouldSetResponderCapture

---

onSurfaceViewCreated()?

optional onSurfaceViewCreated: (surfaceViewHandle) => void

Parameters

surfaceViewHandle

string

Returns

void

Brief

An event callback that is called when the underlying native surface

• view is created.
• @param[in] surfaceViewHandle

---

onSurfaceViewDestroyed()?

optional onSurfaceViewDestroyed: (surfaceViewHandle) => void

Parameters

surfaceViewHandle

string

Returns

void

Brief

And event callback that is called when the underlying native surface view is destroyed. @param[in] surfaceViewHandle The surface view handle to provide to the player to render video.

---

onTouchCancel()?

optional onTouchCancel: (event) => void

Parameters

event

GestureResponderEvent

Returns

void

Inherited from

ViewProps.onTouchCancel

---

onTouchEnd()?

optional onTouchEnd: (event) => void

Parameters

event

GestureResponderEvent

Returns

void

Inherited from

ViewProps.onTouchEnd

---

onTouchEndCapture()?

optional onTouchEndCapture: (event) => void

Parameters

event

GestureResponderEvent

Returns

void

Inherited from

ViewProps.onTouchEndCapture

---

onTouchMove()?

optional onTouchMove: (event) => void

Parameters

event

GestureResponderEvent

Returns

void

Inherited from

ViewProps.onTouchMove

---

onTouchStart()?

optional onTouchStart: (event) => void

Parameters

event

GestureResponderEvent

Returns

void

Inherited from

ViewProps.onTouchStart

---

pointerEvents?

optional pointerEvents: "auto" | "box-none" | "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

ViewProps.pointerEvents

---

removeClippedSubviews?

optional removeClippedSubviews: boolean

This 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).

Inherited from

ViewProps.removeClippedSubviews

---

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

ViewProps.renderToHardwareTextureAndroid

---

role?

optional role: Role

Indicates to accessibility services to treat UI component like a specific role.

Inherited from

ViewProps.role

---

scalingmode?

optional scalingmode: "fill" | "none" | "fit" | "strech"

Brief

configure the scaling mode for rendered video. scalingmode suppprts following. 'none' : No scaling. It preserves the input size. 'fit' : Scales buffer to match window size while preserving the aspect ratio & center position. 'strech': Scales buffer to fit in window, initially without cropping. Scaling up beyond the bounds of the window will stretch the dst rect and excess is cropped down to window bounds. Aspect ratio and center pos are maintained 'fill': Scales buffer to fill the entire window, preserving its aspect ratio and hiding any overflow on the top/bottom/left/right. default: 'strech'

---

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

ViewProps.shouldRasterizeIOS

---

style?

optional style: StyleProp<ViewStyle>

Inherited from

ViewProps.style

---

testID?

optional testID: string

Used to locate this view in end-to-end tests.

Inherited from

ViewProps.testID

---

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

ViewProps.tvParallaxMagnification

---

tvParallaxProperties?

optional tvParallaxProperties: TVParallaxProperties

(Apple TV only) Object with properties to control Apple TV parallax effects.

Platform

ios

Inherited from

ViewProps.tvParallaxProperties

---

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

ViewProps.tvParallaxShiftDistanceX

---

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

ViewProps.tvParallaxShiftDistanceY

---

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

ViewProps.tvParallaxTiltAngle

---

Last updated: Sep 30, 2025