Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ViewProps
    • IProps

Index

Properties

Methods

Properties

Optional accessibilityActions

accessibilityActions: Array<string>

Provides an array of custom actions available for accessibility.

platform

ios

Optional accessibilityComponentType

accessibilityComponentType: "none" | "button" | "radiobutton_checked" | "radiobutton_unchecked"

In some cases, we also want to alert the end user of the type of selected component (i.e., that it is a “button”). If we were using native buttons, this would work automatically. Since we are using javascript, we need to provide a bit more context for TalkBack. To do so, you must specify the ‘accessibilityComponentType’ property for any UI component. For instances, we support ‘button’, ‘radiobutton_checked’ and ‘radiobutton_unchecked’ and so on.

platform

android

Optional accessibilityElementsHidden

accessibilityElementsHidden: undefined | false | true

A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader.

platform

ios

Optional accessibilityLabel

accessibilityLabel: undefined | 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.

Optional accessibilityLiveRegion

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

Optional accessibilityTraits

accessibilityTraits: AccessibilityTrait | AccessibilityTrait[]

Accessibility traits tell a person using VoiceOver what kind of element they have selected. Is this element a label? A button? A header? These questions are answered by accessibilityTraits.

platform

ios

Optional accessibilityViewIsModal

accessibilityViewIsModal: undefined | false | true

A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.

platform

ios

Optional accessible

accessible: undefined | false | true

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

Optional activeOpacity

activeOpacity: undefined | number

The opacity of the element when the touch is active

Optional activeOpacityDelay

activeOpacityDelay: undefined | number

The length of time the active opacity fade should delay before occuring

Optional activeOpacityDuration

activeOpacityDuration: undefined | number

The length of time the active opacity takes to fade

Optional activeOpacityEasing

activeOpacityEasing: EasingFunction

How the fade should tween

Optional alignContent

alignContent: "flex-start" | "flex-end" | "center" | "stretch" | "space-between" | "space-around"

Optional alignItems

alignItems: FlexAlignType

Optional alignSelf

alignSelf: "auto" | FlexAlignType

Optional animate

animate: undefined | false | true

Should we perform an animation on the opacity

Optional aspectRatio

aspectRatio: undefined | number

Optional backfaceVisibility

backfaceVisibility: "visible" | "hidden"

Optional backgroundColor

backgroundColor: undefined | string

Optional borderBottomColor

borderBottomColor: undefined | string

Optional borderBottomEndRadius

borderBottomEndRadius: undefined | number

Optional borderBottomLeftRadius

borderBottomLeftRadius: undefined | number

Optional borderBottomRightRadius

borderBottomRightRadius: undefined | number

Optional borderBottomStartRadius

borderBottomStartRadius: undefined | number

Optional borderBottomWidth

borderBottomWidth: undefined | number

Optional borderColor

borderColor: undefined | string

Optional borderEndColor

borderEndColor: undefined | string

Optional borderEndWidth

borderEndWidth: number | string

Optional borderLeftColor

borderLeftColor: undefined | string

Optional borderLeftWidth

borderLeftWidth: undefined | number

Optional borderRadius

borderRadius: undefined | number

Optional borderRightColor

borderRightColor: undefined | string

Optional borderRightWidth

borderRightWidth: undefined | number

Optional borderStartColor

borderStartColor: undefined | string

Optional borderStartWidth

borderStartWidth: number | string

Optional borderStyle

borderStyle: "solid" | "dotted" | "dashed"

Optional borderTopColor

borderTopColor: undefined | string

Optional borderTopEndRadius

borderTopEndRadius: undefined | number

Optional borderTopLeftRadius

borderTopLeftRadius: undefined | number

Optional borderTopRightRadius

borderTopRightRadius: undefined | number

Optional borderTopStartRadius

borderTopStartRadius: undefined | number

Optional borderTopWidth

borderTopWidth: undefined | number

Optional borderWidth

borderWidth: undefined | number

Optional bottom

bottom: number | string

Optional collapsable

collapsable: undefined | false | true

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.

Optional delayLongPress

delayLongPress: undefined | number

The duration in milliseconds to wait from the time a touch is initiated before firing the onLongPress handler. If the touch ends before this duration is reached, the touch will be treated as a tap. Optional, and when not defined, default to defaultLongPressDelay = 500

Optional direction

direction: "inherit" | "ltr" | "rtl"
platform

ios

Optional display

display: "none" | "flex"

Optional elevation

elevation: undefined | number

Sets the elevation of a view, using Android's underlying elevation API. This adds a drop shadow to the item and affects z-order for overlapping views. Only supported on Android 5.0+, has no effect on earlier versions.

platform

android

Optional end

end: number | string

Optional flex

flex: undefined | number

Optional flexBasis

flexBasis: number | string

Optional flexDirection

flexDirection: "row" | "column" | "row-reverse" | "column-reverse"

Optional flexGrow

flexGrow: undefined | number

Optional flexShrink

flexShrink: undefined | number

Optional flexWrap

flexWrap: "wrap" | "nowrap" | "wrap-reverse"

Optional height

height: number | string

Optional hitSlop

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.

Optional importantForAccessibility

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.

Optional justifyContent

justifyContent: "flex-start" | "flex-end" | "center" | "space-between" | "space-around" | "space-evenly"

Optional left

left: number | string

Optional margin

margin: number | string

Optional marginBottom

marginBottom: number | string

Optional marginEnd

marginEnd: number | string

Optional marginHorizontal

marginHorizontal: number | string

Optional marginLeft

marginLeft: number | string

Optional marginRight

marginRight: number | string

Optional marginStart

marginStart: number | string

Optional marginTop

marginTop: number | string

Optional marginVertical

marginVertical: number | string

Optional maxHeight

maxHeight: number | string

Optional maxWidth

maxWidth: number | string

Optional minHeight

minHeight: number | string

Optional minWidth

minWidth: number | string

Optional needsOffscreenAlphaCompositing

needsOffscreenAlphaCompositing: undefined | false | true

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.

Optional onAcccessibilityTap

onAcccessibilityTap: undefined | function

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

platform

ios

Optional onAccessibilityAction

onAccessibilityAction: undefined | function

When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action.

platform

ios

Optional onLayout

onLayout: undefined | function

Invoked on mount and layout changes with

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

Optional onMagicTap

onMagicTap: undefined | function

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

platform

ios

Optional onMoveShouldSetResponder

onMoveShouldSetResponder: undefined | function

Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?

Optional onMoveShouldSetResponderCapture

onMoveShouldSetResponderCapture: undefined | function

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.

Optional onResponderEnd

onResponderEnd: undefined | function

If the View returns true and attempts to become the responder, one of the following will happen:

Optional onResponderGrant

onResponderGrant: undefined | function

The View is now responding for touch events. This is the time to highlight and show the user what is happening

Optional onResponderMove

onResponderMove: undefined | function

The user is moving their finger

Optional onResponderReject

onResponderReject: undefined | function

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

Optional onResponderRelease

onResponderRelease: undefined | function

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

Optional onResponderStart

onResponderStart: undefined | function

Optional onResponderTerminate

onResponderTerminate: undefined | function

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)

Optional onResponderTerminationRequest

onResponderTerminationRequest: undefined | function

Something else wants to become responder. Should this view release the responder? Returning true allows release

Optional onStartShouldSetResponder

onStartShouldSetResponder: undefined | function

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

Optional onStartShouldSetResponderCapture

onStartShouldSetResponderCapture: undefined | function

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.

Optional onTouchCancel

onTouchCancel: undefined | function

Optional onTouchEnd

onTouchEnd: undefined | function

Optional onTouchEndCapture

onTouchEndCapture: undefined | function

Optional onTouchMove

onTouchMove: undefined | function

Optional onTouchStart

onTouchStart: undefined | function

Optional opacity

opacity: undefined | number

Optional overflow

overflow: "visible" | "hidden" | "scroll"

Optional padding

padding: number | string

Optional paddingBottom

paddingBottom: number | string

Optional paddingEnd

paddingEnd: number | string

Optional paddingHorizontal

paddingHorizontal: number | string

Optional paddingLeft

paddingLeft: number | string

Optional paddingRight

paddingRight: number | string

Optional paddingStart

paddingStart: number | string

Optional paddingTop

paddingTop: number | string

Optional paddingVertical

paddingVertical: number | string

Optional pointerEvents

pointerEvents: "box-none" | "none" | "box-only" | "auto"

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.

Optional position

position: "absolute" | "relative"

Optional radius

radius: undefined | number

The radius of the touch hitbox

Optional removeClippedSubviews

removeClippedSubviews: undefined | false | true

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

Optional renderToHardwareTextureAndroid

renderToHardwareTextureAndroid: undefined | false | true

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.

Optional right

right: number | string

Optional rotation

rotation: undefined | number

Optional scaleX

scaleX: undefined | number

Optional scaleY

scaleY: undefined | number

Optional shadowColor

shadowColor: undefined | string

Optional shadowOffset

shadowOffset: undefined | object

Optional shadowOpacity

shadowOpacity: undefined | number

Optional shadowRadius

shadowRadius: undefined | number

Optional shouldRasterizeIOS

shouldRasterizeIOS: undefined | false | true

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.

Optional start

start: number | string

Optional style

style: StyleProp<ViewStyle>

Optional testID

testID: undefined | string

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

Optional theme

theme: ITheme

The application styling theme.

Optional top

top: number | string

Optional transform

transform: (PerpectiveTransform | RotateTransform | RotateXTransform | RotateYTransform | RotateZTransform | ScaleTransform | ScaleXTransform | ScaleYTransform | TranslateXTransform | TranslateYTransform | SkewXTransform | SkewYTransform)[]

Optional transformMatrix

transformMatrix: Array<number>

Optional translateX

translateX: undefined | number

Optional translateY

translateY: undefined | number

Optional width

width: number | string

Optional zIndex

zIndex: undefined | number

Methods

Optional onLongPress

  • onLongPress(): void
  • The handler for a touch of specific duration on the view. Optional, and when not defined will allow touches to pass through unless pointerEvents are explicitly set to auto and the gesture handlers are implemented

    Returns void

Optional onPress

  • onPress(): void
  • The handler for a tap on the view. Optional, and when not defined will allow touches to pass through unless pointerEvents are explicitly set to auto and the gesture handlers are implemented

    Returns void