Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ViewProperties
    • IProps

Index

Properties

Optional accessibilityComponentType

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

Indicates to accessibility services to treat UI component like a native one. Works for Android only.

Optional accessibilityLabel

accessibilityLabel: Node

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" | "assertsive"

Indicates to accessibility services whether the user should be notified when this view changes.

Optional accessibilityTraits

accessibilityTraits: "none" | "button" | "link" | "header" | "search" | "image" | "selected" | "plays" | "key" | "text" | "summary" | "disabled" | "frequentUpdates" | "startsMedia" | "adjustable" | "allowsDirectInteraction" | "pageTurn"

Provides additional traits to screen reader. By default no traits are provided unless specified otherwise in element.

Optional accessibilityViewIsModal

accessibilityViewIsModal: undefined | true | false

A value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. Default is false. It is for ios only

Optional accessible

accessible: undefined | true | false

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

bluerain

bluerain: BlueRainType

Optional collapsable

collapsable: undefined | true | false

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 hitSlop

hitSlop: undefined | object

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

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.

Optional nativeID

nativeID: undefined | string

Used to locate this view from native classes.

Optional needsOffscreenAlphaCompositing

needsOffscreenAlphaCompositing: undefined | true | false

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 It is for android only

Optional onAccessibilityTap

onAccessibilityTap: undefined | function

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

Optional onLayout

onLayout: undefined | function

Invoked on mount and layout changes with: {nativeEvent: { layout: {x, y, width, height}}} This event is fired immediately once the layout has been calculated, but the new layout may not yet be reflected on the screen at the time the event is received, especially if a layout animation is in progress.

Optional onMagicTap

onMagicTap: undefined | function

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

Optional onMoveShouldSetResponder

onMoveShouldSetResponder: undefined | function

Does this view want to "claim" touch responsiveness? This is called for every touch move on the View when it is not the responder.

Optional onMoveShouldSetResponderCapture

onMoveShouldSetResponderCapture: undefined | function

If a parent View wants to prevent a child View from becoming responder on a move, it should have this handler which returns true. View.props.onMoveShouldSetResponderCapture: (event) => [true | false], where event is a synthetic touch event as described above.

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. View.props.onResponderGrant: (event) => {}, where event is a synthetic touch event as described above.

Optional onResponderMove

onResponderMove: undefined | function

The user is moving their finger. View.props.onResponderMove: (event) => {}, where event is a synthetic touch event as described above.

Optional onResponderReject

onResponderReject: undefined | function

Another responder is already active and will not release it to that View asking to be the responder. View.props.onResponderReject: (event) => {}, where event is a synthetic touch event as described above

Optional onResponderRelease

onResponderRelease: undefined | function

Fired at the end of the touch. View.props.onResponderRelease: (event) => {}, where event is a synthetic touch event as described above.

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 (e.g., happens with control center/ notification center on iOS)

Optional onResponderTerminationRequest

onResponderTerminationRequest: undefined | function

Some other View wants to become responder and is asking this View to release its responder. Returning true allows its release. View.props.onResponderTerminationRequest: (event) => {}, where event is a synthetic touch event as described above

Optional onStartShouldSetResponder

onStartShouldSetResponder: undefined | function

Does this view want to become responder on the start of a touch? View.props.onStartShouldSetResponder: (event) => [true | false], where event is a synthetic touch event as described above.

Optional onStartShouldSetResponderCapture

onStartShouldSetResponderCapture: undefined | function

If a parent View wants to prevent a child View from becoming responder on a touch start, it should have this handler which returns true. View.props.onStartShouldSetResponderCapture: (event) => [true | false], where event is a synthetic touch event as described above.

Optional pointerEvents

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

Controls whether the View can be the target of touch events.

Optional removeClippedSubviews

removeClippedSubviews: undefined | true | false

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 | true | false

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. It is for andoid only

Optional shouldRasterizeIOS

shouldRasterizeIOS: undefined | true | false

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. It is for ios only

style

style: ViewStyle

Optional taskBarwidth

taskBarwidth: any

Optional testID

testID: undefined | string

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

Optional widths

widths: undefined | object

windowSize

windowSize: WindowSize

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc