Module

React.Basic.Native.Generated

Package
purescript-react-basic-native
Repository
dwhitney/purescript-react-basic-native

THIS FILE IS GENERATED -- DO NOT EDIT IT

#ARTClippingRectangleProps Source

type ARTClippingRectangleProps = (children :: Array JSX, height :: Number, key :: String, opacity :: Number, originX :: Number, originY :: Number, scale :: Number, scaleX :: Number, scaleY :: Number, title :: String, visible :: Boolean, width :: Number, x :: Number, y :: Number)

#clippingRectangle Source

clippingRectangle :: forall attrs_ attrs. Union attrs attrs_ (ARTClippingRectangleProps) => Record attrs -> JSX

#clippingRectangle_ Source

#ARTGroupProps Source

type ARTGroupProps = (children :: Array JSX, height :: Number, key :: String, opacity :: Number, originX :: Number, originY :: Number, scale :: Number, scaleX :: Number, scaleY :: Number, title :: String, visible :: Boolean, width :: Number, x :: Number, y :: Number)

#group Source

group :: forall attrs_ attrs. Union attrs attrs_ (ARTGroupProps) => Record attrs -> JSX

#group_ Source

#ARTShapeProps_optional Source

type ARTShapeProps_optional = (children :: Array JSX, fill :: String, height :: Number, key :: String, opacity :: Number, originX :: Number, originY :: Number, scale :: Number, scaleX :: Number, scaleY :: Number, stroke :: String, strokeCap :: String, strokeDash :: Array Number, strokeJoin :: String, strokeWidth :: Number, title :: String, visible :: Boolean, width :: Number, x :: Number, y :: Number)

#ARTShapeProps_required Source

type ARTShapeProps_required optional = (d :: String | optional)

#shape Source

shape :: forall attrs_ attrs. Union attrs attrs_ (ARTShapeProps_optional) => Record ((ARTShapeProps_required) attrs) -> JSX

#ARTSurfaceProps_optional Source

type ARTSurfaceProps_optional = (children :: Array JSX, key :: String, style :: CSS)

#ARTSurfaceProps_required Source

type ARTSurfaceProps_required optional = (height :: Number, width :: Number | optional)

#surface Source

surface :: forall attrs_ attrs. Union attrs attrs_ (ARTSurfaceProps_optional) => Record ((ARTSurfaceProps_required) attrs) -> JSX

#ARTTextProps Source

type ARTTextProps = (alignment :: String, children :: Array JSX, fill :: String, font :: String, key :: String, opacity :: Number, originX :: Number, originY :: Number, scale :: Number, scaleX :: Number, scaleY :: Number, stroke :: String, strokeCap :: String, strokeDash :: Array Number, strokeJoin :: String, strokeWidth :: Number, title :: String, visible :: Boolean, x :: Number, y :: Number)

#aRTText Source

aRTText :: forall attrs_ attrs. Union attrs attrs_ (ARTTextProps) => Record attrs -> JSX

#aRTText_ Source

#ActivityIndicatorIOSProps Source

type ActivityIndicatorIOSProps = (accessibilityActions :: Array String, accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessibilityViewIsModal :: Boolean, accessible :: Boolean, animating :: Boolean, children :: Array JSX, collapsable :: Boolean, color :: String, hasTVPreferredFocus :: Boolean, hidesWhenStopped :: Boolean, hitSlop :: Insets, importantForAccessibility :: String, isTVSelectable :: Boolean, key :: String, nativeID :: String, needsOffscreenAlphaCompositing :: Boolean, onAccessibilityAction :: Effect Unit, onAccessibilityTap :: Effect Unit, onLayout :: EffectFn1 { nativeEvent :: { layout :: { height :: Number, width :: Number, x :: Number, y :: Number } } } Unit, onMagicTap :: Effect Unit, onMoveShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onMoveShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onResponderEnd :: EffectFn1 GestureResponderEvent Unit, onResponderGrant :: EffectFn1 GestureResponderEvent Unit, onResponderMove :: EffectFn1 GestureResponderEvent Unit, onResponderReject :: EffectFn1 GestureResponderEvent Unit, onResponderRelease :: EffectFn1 GestureResponderEvent Unit, onResponderStart :: EffectFn1 GestureResponderEvent Unit, onResponderTerminate :: EffectFn1 GestureResponderEvent Unit, onResponderTerminationRequest :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onTouchCancel :: EffectFn1 GestureResponderEvent Unit, onTouchEnd :: EffectFn1 GestureResponderEvent Unit, onTouchEndCapture :: EffectFn1 GestureResponderEvent Unit, onTouchMove :: EffectFn1 GestureResponderEvent Unit, onTouchStart :: EffectFn1 GestureResponderEvent Unit, pointerEvents :: String, removeClippedSubviews :: Boolean, renderToHardwareTextureAndroid :: Boolean, shouldRasterizeIOS :: Boolean, size :: String, style :: CSS, testID :: String, tvParallaxMagnification :: Number, tvParallaxProperties :: { enabled :: Boolean, magnification :: Number, pressDelay :: Number, pressDuration :: Number, pressMagnification :: Number, shiftDistanceX :: Number, shiftDistanceY :: Number, tiltAngle :: Number }, tvParallaxShiftDistanceX :: Number, tvParallaxShiftDistanceY :: Number, tvParallaxTiltAngle :: Number)

see https://facebook.github.io/react-native/docs/activityindicatorios.html#props

  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • animating Whether to show the indicator (true, the default) or hide it (false).
  • collapsable 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.
  • color The foreground color of the spinner (default is gray).
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hidesWhenStopped Whether the indicator should hide when not animating (true by default).
  • hitSlop 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.
  • importantForAccessibility 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.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onLayout Invoked on mount and layout changes with
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • pointerEvents 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.
  • removeClippedSubviews 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).
  • renderToHardwareTextureAndroid 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.
  • shouldRasterizeIOS 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.
  • size Size of the indicator. Small has a height of 20, large has a height of 36. enum('small', 'large')
  • testID Used to locate this view in end-to-end tests.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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

#activityIndicatorIOS Source

activityIndicatorIOS :: forall attrs_ attrs. Union attrs attrs_ (ActivityIndicatorIOSProps) => Record attrs -> JSX

#activityIndicatorIOS_ Source

#ActivityIndicatorProps Source

type ActivityIndicatorProps = (accessibilityActions :: Array String, accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessibilityViewIsModal :: Boolean, accessible :: Boolean, animating :: Boolean, children :: Array JSX, collapsable :: Boolean, color :: String, hasTVPreferredFocus :: Boolean, hidesWhenStopped :: Boolean, hitSlop :: Insets, importantForAccessibility :: String, isTVSelectable :: Boolean, key :: String, nativeID :: String, needsOffscreenAlphaCompositing :: Boolean, onAccessibilityAction :: Effect Unit, onAccessibilityTap :: Effect Unit, onLayout :: EffectFn1 LayoutChangeEvent Unit, onMagicTap :: Effect Unit, onMoveShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onMoveShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onResponderEnd :: EffectFn1 GestureResponderEvent Unit, onResponderGrant :: EffectFn1 GestureResponderEvent Unit, onResponderMove :: EffectFn1 GestureResponderEvent Unit, onResponderReject :: EffectFn1 GestureResponderEvent Unit, onResponderRelease :: EffectFn1 GestureResponderEvent Unit, onResponderStart :: EffectFn1 GestureResponderEvent Unit, onResponderTerminate :: EffectFn1 GestureResponderEvent Unit, onResponderTerminationRequest :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onTouchCancel :: EffectFn1 GestureResponderEvent Unit, onTouchEnd :: EffectFn1 GestureResponderEvent Unit, onTouchEndCapture :: EffectFn1 GestureResponderEvent Unit, onTouchMove :: EffectFn1 GestureResponderEvent Unit, onTouchStart :: EffectFn1 GestureResponderEvent Unit, pointerEvents :: String, removeClippedSubviews :: Boolean, renderToHardwareTextureAndroid :: Boolean, shouldRasterizeIOS :: Boolean, size :: String, style :: CSS, testID :: String, tvParallaxMagnification :: Number, tvParallaxProperties :: { enabled :: Boolean, magnification :: Number, pressDelay :: Number, pressDuration :: Number, pressMagnification :: Number, shiftDistanceX :: Number, shiftDistanceY :: Number, tiltAngle :: Number }, tvParallaxShiftDistanceX :: Number, tvParallaxShiftDistanceY :: Number, tvParallaxTiltAngle :: Number)

see https://facebook.github.io/react-native/docs/activityindicator.html#props

  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • animating Whether to show the indicator (true, the default) or hide it (false).
  • collapsable 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.
  • color The foreground color of the spinner (default is gray).
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hidesWhenStopped Whether the indicator should hide when not animating (true by default).
  • hitSlop 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.
  • importantForAccessibility 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.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • pointerEvents 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.
  • removeClippedSubviews 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).
  • renderToHardwareTextureAndroid 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.
  • shouldRasterizeIOS 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.
  • size Size of the indicator. Small has a height of 20, large has a height of 36. enum('small', 'large')
  • testID Used to locate this view in end-to-end tests.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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

#activityIndicator Source

activityIndicator :: forall attrs_ attrs. Union attrs attrs_ (ActivityIndicatorProps) => Record attrs -> JSX

#activityIndicator_ Source

#ButtonProps_optional Source

type ButtonProps_optional = (accessibilityLabel :: String, children :: Array JSX, color :: String, disabled :: Boolean, key :: String, testID :: String)
  • testID Used to locate this button in end-to-end tests.

#ButtonProps_required Source

type ButtonProps_required optional = (onPress :: EffectFn1 (NativeSyntheticEvent NativeTouchEvent) Unit, title :: String | optional)
  • testID Used to locate this button in end-to-end tests.

#button Source

button :: forall attrs_ attrs. Union attrs attrs_ (ButtonProps_optional) => Record ((ButtonProps_required) attrs) -> JSX

#CheckBoxProps Source

type CheckBoxProps = (accessibilityActions :: Array String, accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessibilityViewIsModal :: Boolean, accessible :: Boolean, children :: Array JSX, collapsable :: Boolean, disabled :: Boolean, hasTVPreferredFocus :: Boolean, hitSlop :: Insets, importantForAccessibility :: String, isTVSelectable :: Boolean, key :: String, nativeID :: String, needsOffscreenAlphaCompositing :: Boolean, onAccessibilityAction :: Effect Unit, onAccessibilityTap :: Effect Unit, onChange :: EffectFn1 Boolean Unit, onLayout :: EffectFn1 LayoutChangeEvent Unit, onMagicTap :: Effect Unit, onMoveShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onMoveShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onResponderEnd :: EffectFn1 GestureResponderEvent Unit, onResponderGrant :: EffectFn1 GestureResponderEvent Unit, onResponderMove :: EffectFn1 GestureResponderEvent Unit, onResponderReject :: EffectFn1 GestureResponderEvent Unit, onResponderRelease :: EffectFn1 GestureResponderEvent Unit, onResponderStart :: EffectFn1 GestureResponderEvent Unit, onResponderTerminate :: EffectFn1 GestureResponderEvent Unit, onResponderTerminationRequest :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onTouchCancel :: EffectFn1 GestureResponderEvent Unit, onTouchEnd :: EffectFn1 GestureResponderEvent Unit, onTouchEndCapture :: EffectFn1 GestureResponderEvent Unit, onTouchMove :: EffectFn1 GestureResponderEvent Unit, onTouchStart :: EffectFn1 GestureResponderEvent Unit, onValueChange :: EffectFn1 Boolean Unit, pointerEvents :: String, removeClippedSubviews :: Boolean, renderToHardwareTextureAndroid :: Boolean, shouldRasterizeIOS :: Boolean, style :: CSS, testID :: String, tvParallaxMagnification :: Number, tvParallaxProperties :: { enabled :: Boolean, magnification :: Number, pressDelay :: Number, pressDuration :: Number, pressMagnification :: Number, shiftDistanceX :: Number, shiftDistanceY :: Number, tiltAngle :: Number }, tvParallaxShiftDistanceX :: Number, tvParallaxShiftDistanceY :: Number, tvParallaxTiltAngle :: Number, value :: Boolean)
  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • collapsable 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.
  • disabled If true the user won't be able to toggle the checkbox. Default value is false.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • importantForAccessibility 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.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onChange Used in case the props change removes the component.
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onValueChange Invoked with the new value when the value changes.
  • pointerEvents 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.
  • removeClippedSubviews 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).
  • renderToHardwareTextureAndroid 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.
  • shouldRasterizeIOS 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.
  • testID Used to locate this view in end-to-end tests.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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
  • value The value of the checkbox. If true the checkbox will be turned on. Default value is false.

#checkBox Source

checkBox :: forall attrs_ attrs. Union attrs attrs_ (CheckBoxProps) => Record attrs -> JSX

#checkBox_ Source

#DatePickerIOSProps_optional Source

type DatePickerIOSProps_optional = (accessibilityActions :: Array String, accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessibilityViewIsModal :: Boolean, accessible :: Boolean, children :: Array JSX, collapsable :: Boolean, hasTVPreferredFocus :: Boolean, hitSlop :: Insets, importantForAccessibility :: String, isTVSelectable :: Boolean, key :: String, locale :: String, maximumDate :: JSDate, minimumDate :: JSDate, minuteInterval :: Number, mode :: String, nativeID :: String, needsOffscreenAlphaCompositing :: Boolean, onAccessibilityAction :: Effect Unit, onAccessibilityTap :: Effect Unit, onLayout :: EffectFn1 LayoutChangeEvent Unit, onMagicTap :: Effect Unit, onMoveShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onMoveShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onResponderEnd :: EffectFn1 GestureResponderEvent Unit, onResponderGrant :: EffectFn1 GestureResponderEvent Unit, onResponderMove :: EffectFn1 GestureResponderEvent Unit, onResponderReject :: EffectFn1 GestureResponderEvent Unit, onResponderRelease :: EffectFn1 GestureResponderEvent Unit, onResponderStart :: EffectFn1 GestureResponderEvent Unit, onResponderTerminate :: EffectFn1 GestureResponderEvent Unit, onResponderTerminationRequest :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onTouchCancel :: EffectFn1 GestureResponderEvent Unit, onTouchEnd :: EffectFn1 GestureResponderEvent Unit, onTouchEndCapture :: EffectFn1 GestureResponderEvent Unit, onTouchMove :: EffectFn1 GestureResponderEvent Unit, onTouchStart :: EffectFn1 GestureResponderEvent Unit, pointerEvents :: String, removeClippedSubviews :: Boolean, renderToHardwareTextureAndroid :: Boolean, shouldRasterizeIOS :: Boolean, style :: CSS, testID :: String, timeZoneOffsetInMinutes :: Number, tvParallaxMagnification :: Number, tvParallaxProperties :: { enabled :: Boolean, magnification :: Number, pressDelay :: Number, pressDuration :: Number, pressMagnification :: Number, shiftDistanceX :: Number, shiftDistanceY :: Number, tiltAngle :: Number }, tvParallaxShiftDistanceX :: Number, tvParallaxShiftDistanceY :: Number, tvParallaxTiltAngle :: Number)
  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • collapsable 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.
  • date The currently selected date.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • importantForAccessibility 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.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • locale The date picker locale.
  • maximumDate Maximum date. Restricts the range of possible date/time values.
  • minimumDate Maximum date. Restricts the range of possible date/time values.
  • minuteInterval enum(1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30) The interval at which minutes can be selected.
  • mode enum('date', 'time', 'datetime') The date picker mode.
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onDateChange Date change handler. This is called when the user changes the date or time in the UI. The first and only argument is a Date object representing the new date and time.
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • pointerEvents 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.
  • removeClippedSubviews 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).
  • renderToHardwareTextureAndroid 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.
  • shouldRasterizeIOS 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.
  • testID Used to locate this view in end-to-end tests.
  • timeZoneOffsetInMinutes Timezone offset in minutes. By default, the date picker will use the device's timezone. With this parameter, it is possible to force a certain timezone offset. For instance, to show times in Pacific Standard Time, pass -7 * 60.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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

#DatePickerIOSProps_required Source

type DatePickerIOSProps_required optional = (date :: JSDate, onDateChange :: EffectFn1 JSDate Unit | optional)
  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • collapsable 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.
  • date The currently selected date.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • importantForAccessibility 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.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • locale The date picker locale.
  • maximumDate Maximum date. Restricts the range of possible date/time values.
  • minimumDate Maximum date. Restricts the range of possible date/time values.
  • minuteInterval enum(1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30) The interval at which minutes can be selected.
  • mode enum('date', 'time', 'datetime') The date picker mode.
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onDateChange Date change handler. This is called when the user changes the date or time in the UI. The first and only argument is a Date object representing the new date and time.
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • pointerEvents 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.
  • removeClippedSubviews 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).
  • renderToHardwareTextureAndroid 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.
  • shouldRasterizeIOS 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.
  • testID Used to locate this view in end-to-end tests.
  • timeZoneOffsetInMinutes Timezone offset in minutes. By default, the date picker will use the device's timezone. With this parameter, it is possible to force a certain timezone offset. For instance, to show times in Pacific Standard Time, pass -7 * 60.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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

#datePickerIOS Source

datePickerIOS :: forall attrs_ attrs. Union attrs attrs_ (DatePickerIOSProps_optional) => Record ((DatePickerIOSProps_required) attrs) -> JSX

#DocumentSelectionState Source

#DrawerLayoutAndroidProps_optional Source

type DrawerLayoutAndroidProps_optional = (accessibilityActions :: Array String, accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessibilityViewIsModal :: Boolean, accessible :: Boolean, children :: Array JSX, collapsable :: Boolean, drawerBackgroundColor :: String, drawerLockMode :: String, drawerPosition :: Number, drawerWidth :: Number, hasTVPreferredFocus :: Boolean, hitSlop :: Insets, importantForAccessibility :: String, isTVSelectable :: Boolean, key :: String, keyboardDismissMode :: String, nativeID :: String, needsOffscreenAlphaCompositing :: Boolean, onAccessibilityAction :: Effect Unit, onAccessibilityTap :: Effect Unit, onDrawerClose :: Effect Unit, onDrawerOpen :: Effect Unit, onDrawerSlide :: EffectFn1 DrawerSlideEvent Unit, onDrawerStateChanged :: EffectFn1 String Unit, onLayout :: EffectFn1 LayoutChangeEvent Unit, onMagicTap :: Effect Unit, onMoveShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onMoveShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onResponderEnd :: EffectFn1 GestureResponderEvent Unit, onResponderGrant :: EffectFn1 GestureResponderEvent Unit, onResponderMove :: EffectFn1 GestureResponderEvent Unit, onResponderReject :: EffectFn1 GestureResponderEvent Unit, onResponderRelease :: EffectFn1 GestureResponderEvent Unit, onResponderStart :: EffectFn1 GestureResponderEvent Unit, onResponderTerminate :: EffectFn1 GestureResponderEvent Unit, onResponderTerminationRequest :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onTouchCancel :: EffectFn1 GestureResponderEvent Unit, onTouchEnd :: EffectFn1 GestureResponderEvent Unit, onTouchEndCapture :: EffectFn1 GestureResponderEvent Unit, onTouchMove :: EffectFn1 GestureResponderEvent Unit, onTouchStart :: EffectFn1 GestureResponderEvent Unit, pointerEvents :: String, removeClippedSubviews :: Boolean, renderToHardwareTextureAndroid :: Boolean, shouldRasterizeIOS :: Boolean, statusBarBackgroundColor :: String, style :: CSS, testID :: String, tvParallaxMagnification :: Number, tvParallaxProperties :: { enabled :: Boolean, magnification :: Number, pressDelay :: Number, pressDuration :: Number, pressMagnification :: Number, shiftDistanceX :: Number, shiftDistanceY :: Number, tiltAngle :: Number }, tvParallaxShiftDistanceX :: Number, tvParallaxShiftDistanceY :: Number, tvParallaxTiltAngle :: Number)

see DrawerLayoutAndroid.android.js

  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • collapsable 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.
  • drawerBackgroundColor Specifies the background color of the drawer. The default value is white. If you want to set the opacity of the drawer, use rgba. Example: return ( <DrawerLayoutAndroid drawerBackgroundColor="rgba(0,0,0,0.5)"> </DrawerLayoutAndroid> );
  • drawerLockMode Specifies the lock mode of the drawer. The drawer can be locked in 3 states: - unlocked (default), meaning that the drawer will respond (open/close) to touch gestures. - locked-closed, meaning that the drawer will stay closed and not respond to gestures. - locked-open, meaning that the drawer will stay opened and not respond to gestures. The drawer may still be opened and closed programmatically (openDrawer/closeDrawer).
  • drawerPosition Specifies the side of the screen from which the drawer will slide in. enum(DrawerLayoutAndroid.positions.Left, DrawerLayoutAndroid.positions.Right)
  • drawerWidth Specifies the width of the drawer, more precisely the width of the view that be pulled in from the edge of the window.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • importantForAccessibility 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.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • keyboardDismissMode Determines whether the keyboard gets dismissed in response to a drag. - 'none' (the default), drags do not dismiss the keyboard. - 'on-drag', the keyboard is dismissed when a drag begins.
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onDrawerClose Function called whenever the navigation view has been closed.
  • onDrawerOpen Function called whenever the navigation view has been opened.
  • onDrawerSlide Function called whenever there is an interaction with the navigation view.
  • onDrawerStateChanged Function called when the drawer state has changed. The drawer can be in 3 states: - idle, meaning there is no interaction with the navigation view happening at the time - dragging, meaning there is currently an interaction with the navigation view - settling, meaning that there was an interaction with the navigation view, and the navigation view is now finishing it's closing or opening animation
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • pointerEvents 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.
  • removeClippedSubviews 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).
  • renderNavigationView The navigation view that will be rendered to the side of the screen and can be pulled in.
  • renderToHardwareTextureAndroid 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.
  • shouldRasterizeIOS 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.
  • statusBarBackgroundColor Make the drawer take the entire screen and draw the background of the status bar to allow it to open over the status bar. It will only have an effect on API 21+.
  • testID Used to locate this view in end-to-end tests.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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

#DrawerLayoutAndroidProps_required Source

type DrawerLayoutAndroidProps_required optional = (renderNavigationView :: Effect JSX | optional)

see DrawerLayoutAndroid.android.js

  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • collapsable 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.
  • drawerBackgroundColor Specifies the background color of the drawer. The default value is white. If you want to set the opacity of the drawer, use rgba. Example: return ( <DrawerLayoutAndroid drawerBackgroundColor="rgba(0,0,0,0.5)"> </DrawerLayoutAndroid> );
  • drawerLockMode Specifies the lock mode of the drawer. The drawer can be locked in 3 states: - unlocked (default), meaning that the drawer will respond (open/close) to touch gestures. - locked-closed, meaning that the drawer will stay closed and not respond to gestures. - locked-open, meaning that the drawer will stay opened and not respond to gestures. The drawer may still be opened and closed programmatically (openDrawer/closeDrawer).
  • drawerPosition Specifies the side of the screen from which the drawer will slide in. enum(DrawerLayoutAndroid.positions.Left, DrawerLayoutAndroid.positions.Right)
  • drawerWidth Specifies the width of the drawer, more precisely the width of the view that be pulled in from the edge of the window.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • importantForAccessibility 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.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • keyboardDismissMode Determines whether the keyboard gets dismissed in response to a drag. - 'none' (the default), drags do not dismiss the keyboard. - 'on-drag', the keyboard is dismissed when a drag begins.
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onDrawerClose Function called whenever the navigation view has been closed.
  • onDrawerOpen Function called whenever the navigation view has been opened.
  • onDrawerSlide Function called whenever there is an interaction with the navigation view.
  • onDrawerStateChanged Function called when the drawer state has changed. The drawer can be in 3 states: - idle, meaning there is no interaction with the navigation view happening at the time - dragging, meaning there is currently an interaction with the navigation view - settling, meaning that there was an interaction with the navigation view, and the navigation view is now finishing it's closing or opening animation
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • pointerEvents 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.
  • removeClippedSubviews 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).
  • renderNavigationView The navigation view that will be rendered to the side of the screen and can be pulled in.
  • renderToHardwareTextureAndroid 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.
  • shouldRasterizeIOS 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.
  • statusBarBackgroundColor Make the drawer take the entire screen and draw the background of the status bar to allow it to open over the status bar. It will only have an effect on API 21+.
  • testID Used to locate this view in end-to-end tests.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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

#drawerLayoutAndroid Source

#FlatListProps_optional Source

type FlatListProps_optional itemT = ("ItemSeparatorComponent" :: JSX, "ListEmptyComponent" :: JSX, "ListFooterComponent" :: JSX, "ListHeaderComponent" :: JSX, accessibilityActions :: Array String, accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessibilityViewIsModal :: Boolean, accessible :: Boolean, alwaysBounceHorizontal :: Boolean, alwaysBounceVertical :: Boolean, automaticallyAdjustContentInsets :: Boolean, bounces :: Boolean, bouncesZoom :: Boolean, canCancelContentTouches :: Boolean, centerContent :: Boolean, children :: Array JSX, collapsable :: Boolean, columnWrapperStyle :: CSS, contentContainerStyle :: CSS, contentInset :: Insets, contentInsetAdjustmentBehavior :: String, contentOffset :: PointPropType, debug :: Boolean, decelerationRate :: String, directionalLockEnabled :: Boolean, disableVirtualization :: Boolean, endFillColor :: String, extraData :: Foreign, getItem :: EffectFn2 Foreign Number itemT, getItemCount :: EffectFn1 Foreign Number, getItemLayout :: EffectFn2 (Array itemT) Number { index :: Number, length :: Number, offset :: Number }, hasTVPreferredFocus :: Boolean, hitSlop :: Insets, horizontal :: Boolean, importantForAccessibility :: String, indicatorStyle :: String, initialNumToRender :: Number, initialScrollIndex :: Number, invertStickyHeaders :: Boolean, inverted :: Boolean, isTVSelectable :: Boolean, key :: String, keyExtractor :: EffectFn2 itemT Number String, keyboardDismissMode :: String, keyboardShouldPersistTaps :: String, legacyImplementation :: Boolean, listKey :: String, maxToRenderPerBatch :: Number, maximumZoomScale :: Number, minimumZoomScale :: Number, nativeID :: String, needsOffscreenAlphaCompositing :: Boolean, nestedScrollEnabled :: Boolean, numColumns :: Number, onAccessibilityAction :: Effect Unit, onAccessibilityTap :: Effect Unit, onContentSizeChange :: EffectFn2 Number Number Unit, onEndReached :: EffectFn1 { distanceFromEnd :: Number } Unit, onEndReachedThreshold :: String, onLayout :: EffectFn1 LayoutChangeEvent Unit, onMagicTap :: Effect Unit, onMomentumScrollBegin :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onMomentumScrollEnd :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onMoveShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onMoveShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onRefresh :: Effect Unit, onResponderEnd :: EffectFn1 GestureResponderEvent Unit, onResponderGrant :: EffectFn1 GestureResponderEvent Unit, onResponderMove :: EffectFn1 GestureResponderEvent Unit, onResponderReject :: EffectFn1 GestureResponderEvent Unit, onResponderRelease :: EffectFn1 GestureResponderEvent Unit, onResponderStart :: EffectFn1 GestureResponderEvent Unit, onResponderTerminate :: EffectFn1 GestureResponderEvent Unit, onResponderTerminationRequest :: EffectFn1 GestureResponderEvent Boolean, onScroll :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onScrollAnimationEnd :: Effect Unit, onScrollBeginDrag :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onScrollEndDrag :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onScrollToIndexFailed :: EffectFn1 { averageItemLength :: Number, highestMeasuredFrameIndex :: Number, index :: Number } Unit, onStartShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onTouchCancel :: EffectFn1 GestureResponderEvent Unit, onTouchEnd :: EffectFn1 GestureResponderEvent Unit, onTouchEndCapture :: EffectFn1 GestureResponderEvent Unit, onTouchMove :: EffectFn1 GestureResponderEvent Unit, onTouchStart :: EffectFn1 GestureResponderEvent Unit, onViewableItemsChanged :: EffectFn1 { changed :: Array ViewToken, viewableItems :: Array ViewToken } Unit, overScrollMode :: String, pagingEnabled :: Boolean, pinchGestureEnabled :: Boolean, pointerEvents :: String, progressViewOffset :: Number, refreshControl :: JSX, refreshing :: String, removeClippedSubviews :: Boolean, renderScrollComponent :: EffectFn1 (Record ScrollViewProps) JSX, renderToHardwareTextureAndroid :: Boolean, scrollEnabled :: Boolean, scrollEventThrottle :: Number, scrollIndicatorInsets :: Insets, scrollPerfTag :: String, scrollsToTop :: Boolean, shouldRasterizeIOS :: Boolean, showsHorizontalScrollIndicator :: Boolean, showsVerticalScrollIndicator :: Boolean, snapToAlignment :: String, snapToEnd :: Boolean, snapToInterval :: Number, snapToOffsets :: Array Number, snapToStart :: Boolean, stickyHeaderIndices :: Array Number, style :: CSS, testID :: String, tvParallaxMagnification :: Number, tvParallaxProperties :: { enabled :: Boolean, magnification :: Number, pressDelay :: Number, pressDuration :: Number, pressMagnification :: Number, shiftDistanceX :: Number, shiftDistanceY :: Number, tiltAngle :: Number }, tvParallaxShiftDistanceX :: Number, tvParallaxShiftDistanceY :: Number, tvParallaxTiltAngle :: Number, updateCellsBatchingPeriod :: Number, viewabilityConfig :: Foreign, viewabilityConfigCallbackPairs :: Array ViewabilityConfigCallbackPair, windowSize :: Number, zoomScale :: Number)
  • ItemSeparatorComponent Rendered in between each item, but not at the top or bottom
  • ListEmptyComponent Rendered when the list is empty.
  • ListFooterComponent Rendered at the very end of the list.
  • ListHeaderComponent Rendered at the very beginning of the list.
  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • alwaysBounceHorizontal When true the scroll view bounces horizontally when it reaches the end even if the content is smaller than the scroll view itself. The default value is true when horizontal={true} and false otherwise.
  • alwaysBounceVertical When true the scroll view bounces vertically when it reaches the end even if the content is smaller than the scroll view itself. The default value is false when horizontal={true} and true otherwise.
  • automaticallyAdjustContentInsets Controls whether iOS should automatically adjust the content inset for scroll views that are placed behind a navigation bar or tab bar/ toolbar. The default value is true.
  • bounces When true the scroll view bounces when it reaches the end of the content if the content is larger then the scroll view along the axis of the scroll direction. When false it disables all bouncing even if the alwaysBounce* props are true. The default value is true.
  • bouncesZoom When true gestures can drive zoom past min/max and the zoom will animate to the min/max value at gesture end otherwise the zoom will not exceed the limits.
  • canCancelContentTouches When false once tracking starts won't try to drag if the touch moves. The default value is true.
  • centerContent When true the scroll view automatically centers the content when the content is smaller than the scroll view bounds; when the content is larger than the scroll view this property has no effect. The default value is false.
  • collapsable 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.
  • columnWrapperStyle Optional custom style for multi-item rows generated when numColumns > 1
  • contentContainerStyle These styles will be applied to the scroll view content container which wraps all of the child views. Example: return ( <ScrollView contentContainerStyle={styles.contentContainer}> </ScrollView> ); ... const styles = StyleSheet.create({ contentContainer: { paddingVertical: 20 } });
  • contentInset The amount by which the scroll view content is inset from the edges of the scroll view. Defaults to {0, 0, 0, 0}.
  • contentInsetAdjustmentBehavior This property specifies how the safe area insets are used to modify the content area of the scroll view. The default value of this property must be 'automatic'. But the default value is 'never' until RN@0.51.
  • contentOffset Used to manually set the starting scroll offset. The default value is {x: 0, y: 0}
  • data For simplicity, data is just a plain array. If you want to use something else, like an immutable list, use the underlying VirtualizedList directly.
  • debug debug will turn on extra logging and visual overlays to aid with debugging both usage and implementation, but with a significant perf hit.
  • decelerationRate A floating-point number that determines how quickly the scroll view decelerates after the user lifts their finger. Reasonable choices include - Normal: 0.998 (the default) - Fast: 0.9
  • directionalLockEnabled When true the ScrollView will try to lock to only vertical or horizontal scrolling while dragging. The default value is false.
  • disableVirtualization DEPRECATED: Virtualization provides significant performance and memory optimizations, but fully unmounts react instances that are outside of the render window. You should only need to disable this for debugging purposes.
  • endFillColor Sometimes a scrollview takes up more space than its content fills. When this is the case, this prop will fill the rest of the scrollview with a color to avoid setting a background and creating unnecessary overdraw. This is an advanced optimization that is not needed in the general case.
  • extraData A marker property for telling the list to re-render (since it implements PureComponent). If any of your renderItem, Header, Footer, etc. functions depend on anything outside of the data prop, stick it here and treat it immutably.
  • getItem A generic accessor for extracting an item from any sort of data blob.
  • getItemCount Determines how many items are in the data blob.
  • getItemLayout getItemLayout is an optional optimization that lets us skip measurement of dynamic content if you know the height of items a priori. getItemLayout is the most efficient, and is easy to use if you have fixed height items, for example: * getItemLayout={(data, index) => ( * {length: ITEM_HEIGHT, offset: ITEM_HEIGHT * index, index} * )} * Remember to include separator length (height or width) in your offset calculation if you specify ItemSeparatorComponent.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • horizontal If true, renders items next to each other horizontally instead of stacked vertically.
  • importantForAccessibility 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.
  • indicatorStyle The style of the scroll indicators. - default (the default), same as black. - black, scroll indicator is black. This style is good against a white content background. - white, scroll indicator is white. This style is good against a black content background.
  • initialNumToRender How many items to render in the initial batch
  • initialScrollIndex Instead of starting at the top with the first item, start at initialScrollIndex
  • invertStickyHeaders If sticky headers should stick at the bottom instead of the top of the ScrollView. This is usually used with inverted ScrollViews.
  • inverted Reverses the direction of scroll. Uses scale transforms of -1.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • keyExtractor Used to extract a unique key for a given item at the specified index. Key is used for caching and as the react key to track item re-ordering. The default extractor checks item.key, then falls back to using the index, like React does.
  • keyboardDismissMode Determines whether the keyboard gets dismissed in response to a drag. - 'none' (the default) drags do not dismiss the keyboard. - 'onDrag' the keyboard is dismissed when a drag begins. - 'interactive' the keyboard is dismissed interactively with the drag and moves in synchrony with the touch; dragging upwards cancels the dismissal.
  • keyboardShouldPersistTaps Determines when the keyboard should stay visible after a tap. - 'never' (the default), tapping outside of the focused text input when the keyboard is up dismisses the keyboard. When this happens, children won't receive the tap. - 'always', the keyboard will not dismiss automatically, and the scroll view will not catch taps, but children of the scroll view can catch taps. - 'handled', the keyboard will not dismiss automatically when the tap was handled by a children, (or captured by an ancestor). - false, deprecated, use 'never' instead - true, deprecated, use 'always' instead
  • legacyImplementation Uses legacy MetroListView instead of default VirtualizedSectionList
  • maxToRenderPerBatch The maximum number of items to render in each incremental render batch. The more rendered at once, the better the fill rate, but responsiveness my suffer because rendering content may interfere with responding to button taps or other interactions.
  • maximumZoomScale The maximum allowed zoom scale. The default value is 1.0.
  • minimumZoomScale The minimum allowed zoom scale. The default value is 1.0.
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • nestedScrollEnabled Enables nested scrolling for Android API level 21+. Nested scrolling is supported by default on iOS.
  • numColumns Multiple columns can only be rendered with horizontal={false} and will zig-zag like a flexWrap layout. Items should all be the same height - masonry layouts are not supported.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onContentSizeChange Called when scrollable content view of the ScrollView changes. Handler function is passed the content width and content height as parameters: (contentWidth, contentHeight) It's implemented using onLayout handler attached to the content container which this ScrollView renders.
  • onEndReached Called once when the scroll position gets within onEndReachedThreshold of the rendered content.
  • onEndReachedThreshold How far from the end (in units of visible length of the list) the bottom edge of the list must be from the end of the content to trigger the onEndReached callback. Thus a value of 0.5 will trigger onEndReached when the end of the content is within half the visible length of the list.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMomentumScrollBegin Fires when scroll view has begun moving
  • onMomentumScrollEnd Fires when scroll view has finished moving
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onRefresh If provided, a standard RefreshControl will be added for "Pull to Refresh" functionality. Make sure to also set the refreshing prop correctly.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onScroll Fires at most once per frame during scrolling. The frequency of the events can be contolled using the scrollEventThrottle prop.
  • onScrollAnimationEnd Called when a scrolling animation ends.
  • onScrollBeginDrag Fires if a user initiates a scroll gesture.
  • onScrollEndDrag Fires when a user has finished scrolling.
  • onScrollToIndexFailed Used to handle failures when scrolling to an index that has not been measured yet. Recommended action is to either compute your own offset and scrollTo it, or scroll as far as possible and then try again after more items have been rendered.
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onViewableItemsChanged Called when the viewability of rows changes, as defined by the viewablePercentThreshold prop.
  • overScrollMode Used to override default value of overScroll mode. Possible values: - 'auto' - Default value, allow a user to over-scroll this view only if the content is large enough to meaningfully scroll. - 'always' - Always allow a user to over-scroll this view. - 'never' - Never allow a user to over-scroll this view.
  • pagingEnabled When true the scroll view stops on multiples of the scroll view's size when scrolling. This can be used for horizontal pagination. The default value is false.
  • pinchGestureEnabled When true, ScrollView allows use of pinch gestures to zoom in and out. The default value is true.
  • pointerEvents 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.
  • progressViewOffset Set this when offset is needed for the loading indicator to show correctly. platform android
  • refreshControl A RefreshControl component, used to provide pull-to-refresh functionality for the ScrollView.
  • refreshing Set this true while waiting for new data from a refresh.
  • removeClippedSubviews Note: may have bugs (missing content) in some circumstances - use at your own risk. This may improve scroll performance for large lists.
  • renderItem Takes an item from data and renders it into the list. Typical usage: * _renderItem = ({item}) => ( * <TouchableOpacity onPress={() => this._onPress(item)}> * <Text>{item.title}</Text> * <TouchableOpacity/> * ); * ... * <FlatList data={[{title: 'Title Text', key: 'item1'}]} renderItem={this._renderItem} /> * Provides additional metadata like index if you need it.
  • renderScrollComponent Render a custom scroll component, e.g. with a differently styled RefreshControl.
  • renderToHardwareTextureAndroid 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.
  • scrollEnabled When false, the content does not scroll. The default value is true
  • scrollEventThrottle This controls how often the scroll event will be fired while scrolling (in events per seconds). A higher number yields better accuracy for code that is tracking the scroll position, but can lead to scroll performance problems due to the volume of information being send over the bridge. The default value is zero, which means the scroll event will be sent only once each time the view is scrolled.
  • scrollIndicatorInsets The amount by which the scroll view indicators are inset from the edges of the scroll view. This should normally be set to the same value as the contentInset. Defaults to {0, 0, 0, 0}.
  • scrollPerfTag Tag used to log scroll performance on this scroll view. Will force momentum events to be turned on (see sendMomentumEvents). This doesn't do anything out of the box and you need to implement a custom native FpsListener for it to be useful. platform android
  • scrollsToTop When true the scroll view scrolls to top when the status bar is tapped. The default value is true.
  • shouldRasterizeIOS 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.
  • showsHorizontalScrollIndicator When true, shows a horizontal scroll indicator.
  • showsVerticalScrollIndicator When true, shows a vertical scroll indicator.
  • snapToAlignment When snapToInterval is set, snapToAlignment will define the relationship of the the snapping to the scroll view. - start (the default) will align the snap at the left (horizontal) or top (vertical) - center will align the snap in the center - end will align the snap at the right (horizontal) or bottom (vertical)
  • snapToEnd Use in conjuction with snapToOffsets. By default, the end of the list counts as a snap offset. Set snapToEnd to false to disable this behavior and allow the list to scroll freely between its end and the last snapToOffsets offset. The default value is true.
  • snapToInterval When set, causes the scroll view to stop at multiples of the value of snapToInterval. This can be used for paginating through children that have lengths smaller than the scroll view. Used in combination with snapToAlignment and decelerationRate="fast". Overrides less configurable pagingEnabled prop.
  • snapToOffsets When set, causes the scroll view to stop at the defined offsets. This can be used for paginating through variously sized children that have lengths smaller than the scroll view. Typically used in combination with decelerationRate="fast". Overrides less configurable pagingEnabled and snapToInterval props.
  • snapToStart Use in conjuction with snapToOffsets. By default, the beginning of the list counts as a snap offset. Set snapToStart to false to disable this behavior and allow the list to scroll freely between its start and the first snapToOffsets offset. The default value is true.
  • stickyHeaderIndices An array of child indices determining which children get docked to the top of the screen when scrolling. For example passing stickyHeaderIndices={[0]} will cause the first child to be fixed to the top of the scroll view. This property is not supported in conjunction with horizontal={true}.
  • style Style
  • testID Used to locate this view in end-to-end tests.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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
  • updateCellsBatchingPeriod Amount of time between low-pri item render batches, e.g. for rendering items quite a ways off screen. Similar fill rate/responsiveness tradeoff as maxToRenderPerBatch.
  • viewabilityConfig See ViewabilityHelper for flow type and further documentation.
  • windowSize Determines the maximum number of items rendered outside of the visible area, in units of visible lengths. So if your list fills the screen, then windowSize={21} (the default) will render the visible screen area plus up to 10 screens above and 10 below the viewport. Reducing this number will reduce memory consumption and may improve performance, but will increase the chance that fast scrolling may reveal momentary blank areas of unrendered content.
  • zoomScale The current scale of the scroll view content. The default value is 1.0.

#FlatListProps_required Source

type FlatListProps_required itemT optional = (data :: Array itemT, renderItem :: EffectFn1 (ListRenderItemInfo itemT) JSX | optional)
  • ItemSeparatorComponent Rendered in between each item, but not at the top or bottom
  • ListEmptyComponent Rendered when the list is empty.
  • ListFooterComponent Rendered at the very end of the list.
  • ListHeaderComponent Rendered at the very beginning of the list.
  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • alwaysBounceHorizontal When true the scroll view bounces horizontally when it reaches the end even if the content is smaller than the scroll view itself. The default value is true when horizontal={true} and false otherwise.
  • alwaysBounceVertical When true the scroll view bounces vertically when it reaches the end even if the content is smaller than the scroll view itself. The default value is false when horizontal={true} and true otherwise.
  • automaticallyAdjustContentInsets Controls whether iOS should automatically adjust the content inset for scroll views that are placed behind a navigation bar or tab bar/ toolbar. The default value is true.
  • bounces When true the scroll view bounces when it reaches the end of the content if the content is larger then the scroll view along the axis of the scroll direction. When false it disables all bouncing even if the alwaysBounce* props are true. The default value is true.
  • bouncesZoom When true gestures can drive zoom past min/max and the zoom will animate to the min/max value at gesture end otherwise the zoom will not exceed the limits.
  • canCancelContentTouches When false once tracking starts won't try to drag if the touch moves. The default value is true.
  • centerContent When true the scroll view automatically centers the content when the content is smaller than the scroll view bounds; when the content is larger than the scroll view this property has no effect. The default value is false.
  • collapsable 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.
  • columnWrapperStyle Optional custom style for multi-item rows generated when numColumns > 1
  • contentContainerStyle These styles will be applied to the scroll view content container which wraps all of the child views. Example: return ( <ScrollView contentContainerStyle={styles.contentContainer}> </ScrollView> ); ... const styles = StyleSheet.create({ contentContainer: { paddingVertical: 20 } });
  • contentInset The amount by which the scroll view content is inset from the edges of the scroll view. Defaults to {0, 0, 0, 0}.
  • contentInsetAdjustmentBehavior This property specifies how the safe area insets are used to modify the content area of the scroll view. The default value of this property must be 'automatic'. But the default value is 'never' until RN@0.51.
  • contentOffset Used to manually set the starting scroll offset. The default value is {x: 0, y: 0}
  • data For simplicity, data is just a plain array. If you want to use something else, like an immutable list, use the underlying VirtualizedList directly.
  • debug debug will turn on extra logging and visual overlays to aid with debugging both usage and implementation, but with a significant perf hit.
  • decelerationRate A floating-point number that determines how quickly the scroll view decelerates after the user lifts their finger. Reasonable choices include - Normal: 0.998 (the default) - Fast: 0.9
  • directionalLockEnabled When true the ScrollView will try to lock to only vertical or horizontal scrolling while dragging. The default value is false.
  • disableVirtualization DEPRECATED: Virtualization provides significant performance and memory optimizations, but fully unmounts react instances that are outside of the render window. You should only need to disable this for debugging purposes.
  • endFillColor Sometimes a scrollview takes up more space than its content fills. When this is the case, this prop will fill the rest of the scrollview with a color to avoid setting a background and creating unnecessary overdraw. This is an advanced optimization that is not needed in the general case.
  • extraData A marker property for telling the list to re-render (since it implements PureComponent). If any of your renderItem, Header, Footer, etc. functions depend on anything outside of the data prop, stick it here and treat it immutably.
  • getItem A generic accessor for extracting an item from any sort of data blob.
  • getItemCount Determines how many items are in the data blob.
  • getItemLayout getItemLayout is an optional optimization that lets us skip measurement of dynamic content if you know the height of items a priori. getItemLayout is the most efficient, and is easy to use if you have fixed height items, for example: * getItemLayout={(data, index) => ( * {length: ITEM_HEIGHT, offset: ITEM_HEIGHT * index, index} * )} * Remember to include separator length (height or width) in your offset calculation if you specify ItemSeparatorComponent.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • horizontal If true, renders items next to each other horizontally instead of stacked vertically.
  • importantForAccessibility 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.
  • indicatorStyle The style of the scroll indicators. - default (the default), same as black. - black, scroll indicator is black. This style is good against a white content background. - white, scroll indicator is white. This style is good against a black content background.
  • initialNumToRender How many items to render in the initial batch
  • initialScrollIndex Instead of starting at the top with the first item, start at initialScrollIndex
  • invertStickyHeaders If sticky headers should stick at the bottom instead of the top of the ScrollView. This is usually used with inverted ScrollViews.
  • inverted Reverses the direction of scroll. Uses scale transforms of -1.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • keyExtractor Used to extract a unique key for a given item at the specified index. Key is used for caching and as the react key to track item re-ordering. The default extractor checks item.key, then falls back to using the index, like React does.
  • keyboardDismissMode Determines whether the keyboard gets dismissed in response to a drag. - 'none' (the default) drags do not dismiss the keyboard. - 'onDrag' the keyboard is dismissed when a drag begins. - 'interactive' the keyboard is dismissed interactively with the drag and moves in synchrony with the touch; dragging upwards cancels the dismissal.
  • keyboardShouldPersistTaps Determines when the keyboard should stay visible after a tap. - 'never' (the default), tapping outside of the focused text input when the keyboard is up dismisses the keyboard. When this happens, children won't receive the tap. - 'always', the keyboard will not dismiss automatically, and the scroll view will not catch taps, but children of the scroll view can catch taps. - 'handled', the keyboard will not dismiss automatically when the tap was handled by a children, (or captured by an ancestor). - false, deprecated, use 'never' instead - true, deprecated, use 'always' instead
  • legacyImplementation Uses legacy MetroListView instead of default VirtualizedSectionList
  • maxToRenderPerBatch The maximum number of items to render in each incremental render batch. The more rendered at once, the better the fill rate, but responsiveness my suffer because rendering content may interfere with responding to button taps or other interactions.
  • maximumZoomScale The maximum allowed zoom scale. The default value is 1.0.
  • minimumZoomScale The minimum allowed zoom scale. The default value is 1.0.
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • nestedScrollEnabled Enables nested scrolling for Android API level 21+. Nested scrolling is supported by default on iOS.
  • numColumns Multiple columns can only be rendered with horizontal={false} and will zig-zag like a flexWrap layout. Items should all be the same height - masonry layouts are not supported.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onContentSizeChange Called when scrollable content view of the ScrollView changes. Handler function is passed the content width and content height as parameters: (contentWidth, contentHeight) It's implemented using onLayout handler attached to the content container which this ScrollView renders.
  • onEndReached Called once when the scroll position gets within onEndReachedThreshold of the rendered content.
  • onEndReachedThreshold How far from the end (in units of visible length of the list) the bottom edge of the list must be from the end of the content to trigger the onEndReached callback. Thus a value of 0.5 will trigger onEndReached when the end of the content is within half the visible length of the list.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMomentumScrollBegin Fires when scroll view has begun moving
  • onMomentumScrollEnd Fires when scroll view has finished moving
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onRefresh If provided, a standard RefreshControl will be added for "Pull to Refresh" functionality. Make sure to also set the refreshing prop correctly.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onScroll Fires at most once per frame during scrolling. The frequency of the events can be contolled using the scrollEventThrottle prop.
  • onScrollAnimationEnd Called when a scrolling animation ends.
  • onScrollBeginDrag Fires if a user initiates a scroll gesture.
  • onScrollEndDrag Fires when a user has finished scrolling.
  • onScrollToIndexFailed Used to handle failures when scrolling to an index that has not been measured yet. Recommended action is to either compute your own offset and scrollTo it, or scroll as far as possible and then try again after more items have been rendered.
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onViewableItemsChanged Called when the viewability of rows changes, as defined by the viewablePercentThreshold prop.
  • overScrollMode Used to override default value of overScroll mode. Possible values: - 'auto' - Default value, allow a user to over-scroll this view only if the content is large enough to meaningfully scroll. - 'always' - Always allow a user to over-scroll this view. - 'never' - Never allow a user to over-scroll this view.
  • pagingEnabled When true the scroll view stops on multiples of the scroll view's size when scrolling. This can be used for horizontal pagination. The default value is false.
  • pinchGestureEnabled When true, ScrollView allows use of pinch gestures to zoom in and out. The default value is true.
  • pointerEvents 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.
  • progressViewOffset Set this when offset is needed for the loading indicator to show correctly. platform android
  • refreshControl A RefreshControl component, used to provide pull-to-refresh functionality for the ScrollView.
  • refreshing Set this true while waiting for new data from a refresh.
  • removeClippedSubviews Note: may have bugs (missing content) in some circumstances - use at your own risk. This may improve scroll performance for large lists.
  • renderItem Takes an item from data and renders it into the list. Typical usage: * _renderItem = ({item}) => ( * <TouchableOpacity onPress={() => this._onPress(item)}> * <Text>{item.title}</Text> * <TouchableOpacity/> * ); * ... * <FlatList data={[{title: 'Title Text', key: 'item1'}]} renderItem={this._renderItem} /> * Provides additional metadata like index if you need it.
  • renderScrollComponent Render a custom scroll component, e.g. with a differently styled RefreshControl.
  • renderToHardwareTextureAndroid 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.
  • scrollEnabled When false, the content does not scroll. The default value is true
  • scrollEventThrottle This controls how often the scroll event will be fired while scrolling (in events per seconds). A higher number yields better accuracy for code that is tracking the scroll position, but can lead to scroll performance problems due to the volume of information being send over the bridge. The default value is zero, which means the scroll event will be sent only once each time the view is scrolled.
  • scrollIndicatorInsets The amount by which the scroll view indicators are inset from the edges of the scroll view. This should normally be set to the same value as the contentInset. Defaults to {0, 0, 0, 0}.
  • scrollPerfTag Tag used to log scroll performance on this scroll view. Will force momentum events to be turned on (see sendMomentumEvents). This doesn't do anything out of the box and you need to implement a custom native FpsListener for it to be useful. platform android
  • scrollsToTop When true the scroll view scrolls to top when the status bar is tapped. The default value is true.
  • shouldRasterizeIOS 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.
  • showsHorizontalScrollIndicator When true, shows a horizontal scroll indicator.
  • showsVerticalScrollIndicator When true, shows a vertical scroll indicator.
  • snapToAlignment When snapToInterval is set, snapToAlignment will define the relationship of the the snapping to the scroll view. - start (the default) will align the snap at the left (horizontal) or top (vertical) - center will align the snap in the center - end will align the snap at the right (horizontal) or bottom (vertical)
  • snapToEnd Use in conjuction with snapToOffsets. By default, the end of the list counts as a snap offset. Set snapToEnd to false to disable this behavior and allow the list to scroll freely between its end and the last snapToOffsets offset. The default value is true.
  • snapToInterval When set, causes the scroll view to stop at multiples of the value of snapToInterval. This can be used for paginating through children that have lengths smaller than the scroll view. Used in combination with snapToAlignment and decelerationRate="fast". Overrides less configurable pagingEnabled prop.
  • snapToOffsets When set, causes the scroll view to stop at the defined offsets. This can be used for paginating through variously sized children that have lengths smaller than the scroll view. Typically used in combination with decelerationRate="fast". Overrides less configurable pagingEnabled and snapToInterval props.
  • snapToStart Use in conjuction with snapToOffsets. By default, the beginning of the list counts as a snap offset. Set snapToStart to false to disable this behavior and allow the list to scroll freely between its start and the first snapToOffsets offset. The default value is true.
  • stickyHeaderIndices An array of child indices determining which children get docked to the top of the screen when scrolling. For example passing stickyHeaderIndices={[0]} will cause the first child to be fixed to the top of the scroll view. This property is not supported in conjunction with horizontal={true}.
  • style Style
  • testID Used to locate this view in end-to-end tests.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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
  • updateCellsBatchingPeriod Amount of time between low-pri item render batches, e.g. for rendering items quite a ways off screen. Similar fill rate/responsiveness tradeoff as maxToRenderPerBatch.
  • viewabilityConfig See ViewabilityHelper for flow type and further documentation.
  • windowSize Determines the maximum number of items rendered outside of the visible area, in units of visible lengths. So if your list fills the screen, then windowSize={21} (the default) will render the visible screen area plus up to 10 screens above and 10 below the viewport. Reducing this number will reduce memory consumption and may improve performance, but will increase the chance that fast scrolling may reveal momentary blank areas of unrendered content.
  • zoomScale The current scale of the scroll view content. The default value is 1.0.

#flatList Source

flatList :: forall itemT attrs_ attrs. Union attrs attrs_ (FlatListProps_optional itemT) => Record ((FlatListProps_required itemT) attrs) -> JSX

#ImageBackgroundProps_optional Source

type ImageBackgroundProps_optional = (accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessible :: Boolean, blurRadius :: Number, borderBottomLeftRadius :: Number, borderBottomRightRadius :: Number, borderRadius :: Number, borderTopLeftRadius :: Number, borderTopRightRadius :: Number, capInsets :: Insets, children :: Array JSX, defaultSource :: ImageURISource, fadeDuration :: Number, height :: Number, imageStyle :: CSS, importantForAccessibility :: String, key :: String, loadingIndicatorSource :: ImageURISource, onAccessibilityTap :: Effect Unit, onError :: EffectFn1 (NativeSyntheticEvent ImageErrorEventData) Unit, onLayout :: EffectFn1 LayoutChangeEvent Unit, onLoad :: EffectFn1 (NativeSyntheticEvent ImageLoadEventData) Unit, onLoadEnd :: Effect Unit, onLoadStart :: Effect Unit, onMagicTap :: Effect Unit, onPartialLoad :: Effect Unit, onProgress :: EffectFn1 (NativeSyntheticEvent ImageProgressEventDataIOS) Unit, progressiveRenderingEnabled :: Boolean, resizeMethod :: String, resizeMode :: String, style :: CSS, testID :: String, width :: Number)
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • blurRadius blurRadius: the blur radius of the blur filter added to the image platform ios
  • capInsets When the image is resized, the corners of the size specified by capInsets will stay a fixed size, but the center content and borders of the image will be stretched. This is useful for creating resizable rounded buttons, shadows, and other resizable assets. More info on Apple documentation
  • defaultSource A static image to display while downloading the final image off the network.
  • fadeDuration Duration of fade in animation.
  • height Required if loading images via 'uri' from drawable folder on Android Explanation: https://medium.com/@adamjacobb/react-native-performance-images-adf5843e120
  • importantForAccessibility 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.
  • loadingIndicatorSource similarly to source, this property represents the resource used to render the loading indicator for the image, displayed until image is ready to be displayed, typically after when it got downloaded from network.
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onError Invoked on load error with {nativeEvent: {error}}
  • onLayout onLayout function Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height} }}.
  • onLoad Invoked when load completes successfully { source: { url, height, width } }.
  • onLoadEnd Invoked when load either succeeds or fails
  • onLoadStart Invoked on load start
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onPartialLoad Invoked when a partial load of the image is complete. The definition of what constitutes a "partial load" is loader specific though this is meant for progressive JPEG loads. platform ios
  • onProgress Invoked on download progress with {nativeEvent: {loaded, total}}
  • resizeMethod The mechanism that should be used to resize the image when the image's dimensions differ from the image view's dimensions. Defaults to auto. - auto: Use heuristics to pick between resize and scale. - resize: A software operation which changes the encoded image in memory before it gets decoded. This should be used instead of scale when the image is much larger than the view. - scale: The image gets drawn downscaled or upscaled. Compared to resize, scale is faster (usually hardware accelerated) and produces higher quality images. This should be used if the image is smaller than the view. It should also be used if the image is slightly bigger than the view. More details about resize and scale can be found at http://frescolib.org/docs/resizing-rotating.html. platform android
  • resizeMode Determines how to resize the image when the frame doesn't match the raw image dimensions. 'cover': Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the view (minus padding). 'contain': Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or less than the corresponding dimension of the view (minus padding). 'stretch': Scale width and height independently, This may change the aspect ratio of the src. 'repeat': Repeat the image to cover the frame of the view. The image will keep it's size and aspect ratio. (iOS only) 'center': Scale the image down so that it is completely visible, if bigger than the area of the view. The image will not be scaled up.
  • source The image source (either a remote URL or a local file resource). This prop can also contain several remote URLs, specified together with their width and height and potentially with scale/other URI arguments. The native side will then choose the best uri to display based on the measured size of the image container. A cache property can be added to control how networked request interacts with the local cache. The currently supported formats are png, jpg, jpeg, bmp, gif, webp (Android only), psd (iOS only).
  • testID A unique identifier for this element to be used in UI Automation testing scripts.
  • width Required if loading images via 'uri' from drawable folder on Android. Explanation: https://medium.com/@adamjacobb/react-native-performance-images-adf5843e120

#ImageBackgroundProps_required Source

type ImageBackgroundProps_required optional = (source :: Array ImageURISource | optional)
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • blurRadius blurRadius: the blur radius of the blur filter added to the image platform ios
  • capInsets When the image is resized, the corners of the size specified by capInsets will stay a fixed size, but the center content and borders of the image will be stretched. This is useful for creating resizable rounded buttons, shadows, and other resizable assets. More info on Apple documentation
  • defaultSource A static image to display while downloading the final image off the network.
  • fadeDuration Duration of fade in animation.
  • height Required if loading images via 'uri' from drawable folder on Android Explanation: https://medium.com/@adamjacobb/react-native-performance-images-adf5843e120
  • importantForAccessibility 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.
  • loadingIndicatorSource similarly to source, this property represents the resource used to render the loading indicator for the image, displayed until image is ready to be displayed, typically after when it got downloaded from network.
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onError Invoked on load error with {nativeEvent: {error}}
  • onLayout onLayout function Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height} }}.
  • onLoad Invoked when load completes successfully { source: { url, height, width } }.
  • onLoadEnd Invoked when load either succeeds or fails
  • onLoadStart Invoked on load start
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onPartialLoad Invoked when a partial load of the image is complete. The definition of what constitutes a "partial load" is loader specific though this is meant for progressive JPEG loads. platform ios
  • onProgress Invoked on download progress with {nativeEvent: {loaded, total}}
  • resizeMethod The mechanism that should be used to resize the image when the image's dimensions differ from the image view's dimensions. Defaults to auto. - auto: Use heuristics to pick between resize and scale. - resize: A software operation which changes the encoded image in memory before it gets decoded. This should be used instead of scale when the image is much larger than the view. - scale: The image gets drawn downscaled or upscaled. Compared to resize, scale is faster (usually hardware accelerated) and produces higher quality images. This should be used if the image is smaller than the view. It should also be used if the image is slightly bigger than the view. More details about resize and scale can be found at http://frescolib.org/docs/resizing-rotating.html. platform android
  • resizeMode Determines how to resize the image when the frame doesn't match the raw image dimensions. 'cover': Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the view (minus padding). 'contain': Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or less than the corresponding dimension of the view (minus padding). 'stretch': Scale width and height independently, This may change the aspect ratio of the src. 'repeat': Repeat the image to cover the frame of the view. The image will keep it's size and aspect ratio. (iOS only) 'center': Scale the image down so that it is completely visible, if bigger than the area of the view. The image will not be scaled up.
  • source The image source (either a remote URL or a local file resource). This prop can also contain several remote URLs, specified together with their width and height and potentially with scale/other URI arguments. The native side will then choose the best uri to display based on the measured size of the image container. A cache property can be added to control how networked request interacts with the local cache. The currently supported formats are png, jpg, jpeg, bmp, gif, webp (Android only), psd (iOS only).
  • testID A unique identifier for this element to be used in UI Automation testing scripts.
  • width Required if loading images via 'uri' from drawable folder on Android. Explanation: https://medium.com/@adamjacobb/react-native-performance-images-adf5843e120

#imageBackground Source

imageBackground :: forall attrs_ attrs. Union attrs attrs_ (ImageBackgroundProps_optional) => Record ((ImageBackgroundProps_required) attrs) -> JSX

#ImageErrorEventData Source

type ImageErrorEventData = { error :: Foreign }

#ImageLoadEventData Source

type ImageLoadEventData = { source :: { height :: Number, url :: String, width :: Number }, uri :: Undefinable String }

#ImageProgressEventDataIOS Source

type ImageProgressEventDataIOS = { loaded :: Number, total :: Number }

#ImageProps_optional Source

type ImageProps_optional = (accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessible :: Boolean, blurRadius :: Number, borderBottomLeftRadius :: Number, borderBottomRightRadius :: Number, borderRadius :: Number, borderTopLeftRadius :: Number, borderTopRightRadius :: Number, capInsets :: Insets, children :: Array JSX, defaultSource :: ImageURISource, fadeDuration :: Number, height :: Number, importantForAccessibility :: String, key :: String, loadingIndicatorSource :: ImageURISource, onAccessibilityTap :: Effect Unit, onError :: EffectFn1 (NativeSyntheticEvent ImageErrorEventData) Unit, onLayout :: EffectFn1 LayoutChangeEvent Unit, onLoad :: EffectFn1 (NativeSyntheticEvent ImageLoadEventData) Unit, onLoadEnd :: Effect Unit, onLoadStart :: Effect Unit, onMagicTap :: Effect Unit, onPartialLoad :: Effect Unit, onProgress :: EffectFn1 (NativeSyntheticEvent ImageProgressEventDataIOS) Unit, progressiveRenderingEnabled :: Boolean, resizeMethod :: String, resizeMode :: String, style :: CSS, testID :: String, width :: Number)
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • blurRadius blurRadius: the blur radius of the blur filter added to the image platform ios
  • capInsets When the image is resized, the corners of the size specified by capInsets will stay a fixed size, but the center content and borders of the image will be stretched. This is useful for creating resizable rounded buttons, shadows, and other resizable assets. More info on Apple documentation
  • defaultSource A static image to display while downloading the final image off the network.
  • fadeDuration Duration of fade in animation.
  • height Required if loading images via 'uri' from drawable folder on Android Explanation: https://medium.com/@adamjacobb/react-native-performance-images-adf5843e120
  • importantForAccessibility 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.
  • loadingIndicatorSource similarly to source, this property represents the resource used to render the loading indicator for the image, displayed until image is ready to be displayed, typically after when it got downloaded from network.
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onError Invoked on load error with {nativeEvent: {error}}
  • onLayout onLayout function Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height} }}.
  • onLoad Invoked when load completes successfully { source: { url, height, width } }.
  • onLoadEnd Invoked when load either succeeds or fails
  • onLoadStart Invoked on load start
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onPartialLoad Invoked when a partial load of the image is complete. The definition of what constitutes a "partial load" is loader specific though this is meant for progressive JPEG loads. platform ios
  • onProgress Invoked on download progress with {nativeEvent: {loaded, total}}
  • resizeMethod The mechanism that should be used to resize the image when the image's dimensions differ from the image view's dimensions. Defaults to auto. - auto: Use heuristics to pick between resize and scale. - resize: A software operation which changes the encoded image in memory before it gets decoded. This should be used instead of scale when the image is much larger than the view. - scale: The image gets drawn downscaled or upscaled. Compared to resize, scale is faster (usually hardware accelerated) and produces higher quality images. This should be used if the image is smaller than the view. It should also be used if the image is slightly bigger than the view. More details about resize and scale can be found at http://frescolib.org/docs/resizing-rotating.html. platform android
  • resizeMode Determines how to resize the image when the frame doesn't match the raw image dimensions. 'cover': Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the view (minus padding). 'contain': Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or less than the corresponding dimension of the view (minus padding). 'stretch': Scale width and height independently, This may change the aspect ratio of the src. 'repeat': Repeat the image to cover the frame of the view. The image will keep it's size and aspect ratio. (iOS only) 'center': Scale the image down so that it is completely visible, if bigger than the area of the view. The image will not be scaled up.
  • source The image source (either a remote URL or a local file resource). This prop can also contain several remote URLs, specified together with their width and height and potentially with scale/other URI arguments. The native side will then choose the best uri to display based on the measured size of the image container. A cache property can be added to control how networked request interacts with the local cache. The currently supported formats are png, jpg, jpeg, bmp, gif, webp (Android only), psd (iOS only).
  • style Style
  • testID A unique identifier for this element to be used in UI Automation testing scripts.
  • width Required if loading images via 'uri' from drawable folder on Android. Explanation: https://medium.com/@adamjacobb/react-native-performance-images-adf5843e120

#ImageProps_required Source

type ImageProps_required optional = (source :: Array ImageURISource | optional)
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • blurRadius blurRadius: the blur radius of the blur filter added to the image platform ios
  • capInsets When the image is resized, the corners of the size specified by capInsets will stay a fixed size, but the center content and borders of the image will be stretched. This is useful for creating resizable rounded buttons, shadows, and other resizable assets. More info on Apple documentation
  • defaultSource A static image to display while downloading the final image off the network.
  • fadeDuration Duration of fade in animation.
  • height Required if loading images via 'uri' from drawable folder on Android Explanation: https://medium.com/@adamjacobb/react-native-performance-images-adf5843e120
  • importantForAccessibility 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.
  • loadingIndicatorSource similarly to source, this property represents the resource used to render the loading indicator for the image, displayed until image is ready to be displayed, typically after when it got downloaded from network.
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onError Invoked on load error with {nativeEvent: {error}}
  • onLayout onLayout function Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height} }}.
  • onLoad Invoked when load completes successfully { source: { url, height, width } }.
  • onLoadEnd Invoked when load either succeeds or fails
  • onLoadStart Invoked on load start
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onPartialLoad Invoked when a partial load of the image is complete. The definition of what constitutes a "partial load" is loader specific though this is meant for progressive JPEG loads. platform ios
  • onProgress Invoked on download progress with {nativeEvent: {loaded, total}}
  • resizeMethod The mechanism that should be used to resize the image when the image's dimensions differ from the image view's dimensions. Defaults to auto. - auto: Use heuristics to pick between resize and scale. - resize: A software operation which changes the encoded image in memory before it gets decoded. This should be used instead of scale when the image is much larger than the view. - scale: The image gets drawn downscaled or upscaled. Compared to resize, scale is faster (usually hardware accelerated) and produces higher quality images. This should be used if the image is smaller than the view. It should also be used if the image is slightly bigger than the view. More details about resize and scale can be found at http://frescolib.org/docs/resizing-rotating.html. platform android
  • resizeMode Determines how to resize the image when the frame doesn't match the raw image dimensions. 'cover': Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the view (minus padding). 'contain': Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or less than the corresponding dimension of the view (minus padding). 'stretch': Scale width and height independently, This may change the aspect ratio of the src. 'repeat': Repeat the image to cover the frame of the view. The image will keep it's size and aspect ratio. (iOS only) 'center': Scale the image down so that it is completely visible, if bigger than the area of the view. The image will not be scaled up.
  • source The image source (either a remote URL or a local file resource). This prop can also contain several remote URLs, specified together with their width and height and potentially with scale/other URI arguments. The native side will then choose the best uri to display based on the measured size of the image container. A cache property can be added to control how networked request interacts with the local cache. The currently supported formats are png, jpg, jpeg, bmp, gif, webp (Android only), psd (iOS only).
  • style Style
  • testID A unique identifier for this element to be used in UI Automation testing scripts.
  • width Required if loading images via 'uri' from drawable folder on Android. Explanation: https://medium.com/@adamjacobb/react-native-performance-images-adf5843e120

#image Source

image :: forall attrs_ attrs. Union attrs attrs_ (ImageProps_optional) => Record ((ImageProps_required) attrs) -> JSX

#ImageURISource Source

type ImageURISource = { body :: Undefinable String, bundle :: Undefinable String, cache :: Undefinable String, headers :: Undefinable (Object Foreign), height :: Undefinable Number, method :: Undefinable String, scale :: Undefinable Number, uri :: Undefinable String, width :: Undefinable Number }

#InputAccessoryViewProps Source

type InputAccessoryViewProps = (backgroundColor :: String, children :: Array JSX, key :: String, nativeID :: String, style :: CSS)
  • nativeID An ID which is used to associate this InputAccessoryView to specified TextInput(s).

#inputAccessoryView Source

inputAccessoryView :: forall attrs_ attrs. Union attrs attrs_ (InputAccessoryViewProps) => Record attrs -> JSX

#inputAccessoryView_ Source

#Insets Source

type Insets = { bottom :: Undefinable Number, left :: Undefinable Number, right :: Undefinable Number, top :: Undefinable Number }

#KeyboardAvoidingViewProps Source

type KeyboardAvoidingViewProps = (accessibilityActions :: Array String, accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessibilityViewIsModal :: Boolean, accessible :: Boolean, behavior :: String, children :: Array JSX, collapsable :: Boolean, contentContainerStyle :: CSS, enabled :: Boolean, hasTVPreferredFocus :: Boolean, hitSlop :: Insets, importantForAccessibility :: String, isTVSelectable :: Boolean, key :: String, keyboardVerticalOffset :: Number, nativeID :: String, needsOffscreenAlphaCompositing :: Boolean, onAccessibilityAction :: Effect Unit, onAccessibilityTap :: Effect Unit, onLayout :: EffectFn1 LayoutChangeEvent Unit, onMagicTap :: Effect Unit, onMoveShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onMoveShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onResponderEnd :: EffectFn1 GestureResponderEvent Unit, onResponderGrant :: EffectFn1 GestureResponderEvent Unit, onResponderMove :: EffectFn1 GestureResponderEvent Unit, onResponderReject :: EffectFn1 GestureResponderEvent Unit, onResponderRelease :: EffectFn1 GestureResponderEvent Unit, onResponderStart :: EffectFn1 GestureResponderEvent Unit, onResponderTerminate :: EffectFn1 GestureResponderEvent Unit, onResponderTerminationRequest :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onTouchCancel :: EffectFn1 GestureResponderEvent Unit, onTouchEnd :: EffectFn1 GestureResponderEvent Unit, onTouchEndCapture :: EffectFn1 GestureResponderEvent Unit, onTouchMove :: EffectFn1 GestureResponderEvent Unit, onTouchStart :: EffectFn1 GestureResponderEvent Unit, pointerEvents :: String, removeClippedSubviews :: Boolean, renderToHardwareTextureAndroid :: Boolean, shouldRasterizeIOS :: Boolean, style :: CSS, testID :: String, tvParallaxMagnification :: Number, tvParallaxProperties :: { enabled :: Boolean, magnification :: Number, pressDelay :: Number, pressDuration :: Number, pressMagnification :: Number, shiftDistanceX :: Number, shiftDistanceY :: Number, tiltAngle :: Number }, tvParallaxShiftDistanceX :: Number, tvParallaxShiftDistanceY :: Number, tvParallaxTiltAngle :: Number)
  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • collapsable 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.
  • contentContainerStyle The style of the content container(View) when behavior is 'position'.
  • enabled Enables or disables the KeyboardAvoidingView. Default is true
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • importantForAccessibility 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.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • keyboardVerticalOffset This is the distance between the top of the user screen and the react native view, may be non-zero in some use cases.
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • pointerEvents 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.
  • removeClippedSubviews 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).
  • renderToHardwareTextureAndroid 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.
  • shouldRasterizeIOS 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.
  • testID Used to locate this view in end-to-end tests.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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

#keyboardAvoidingView Source

keyboardAvoidingView :: forall attrs_ attrs. Union attrs attrs_ (KeyboardAvoidingViewProps) => Record attrs -> JSX

#keyboardAvoidingView_ Source

#LayoutChangeEvent Source

type LayoutChangeEvent = { nativeEvent :: { layout :: LayoutRectangle } }

#LayoutRectangle Source

type LayoutRectangle = { height :: Number, width :: Number, x :: Number, y :: Number }

#ListRenderItemInfo Source

type ListRenderItemInfo itemT = { index :: Number, item :: itemT, separators :: { highlight :: Effect Unit, unhighlight :: Effect Unit, updateProps :: EffectFn2 String Foreign Unit } }

#ListViewDataSource Source

#ListViewProps_optional Source

type ListViewProps_optional = (accessibilityActions :: Array String, accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessibilityViewIsModal :: Boolean, accessible :: Boolean, alwaysBounceHorizontal :: Boolean, alwaysBounceVertical :: Boolean, automaticallyAdjustContentInsets :: Boolean, bounces :: Boolean, bouncesZoom :: Boolean, canCancelContentTouches :: Boolean, centerContent :: Boolean, children :: Array JSX, collapsable :: Boolean, contentContainerStyle :: CSS, contentInset :: Insets, contentInsetAdjustmentBehavior :: String, contentOffset :: PointPropType, decelerationRate :: String, directionalLockEnabled :: Boolean, enableEmptySections :: Boolean, endFillColor :: String, hasTVPreferredFocus :: Boolean, hitSlop :: Insets, horizontal :: Boolean, importantForAccessibility :: String, indicatorStyle :: String, initialListSize :: Number, invertStickyHeaders :: Boolean, isTVSelectable :: Boolean, key :: String, keyboardDismissMode :: String, keyboardShouldPersistTaps :: String, maximumZoomScale :: Number, minimumZoomScale :: Number, nativeID :: String, needsOffscreenAlphaCompositing :: Boolean, nestedScrollEnabled :: Boolean, onAccessibilityAction :: Effect Unit, onAccessibilityTap :: Effect Unit, onChangeVisibleRows :: EffectFn2 (Array (Object Foreign)) (Array (Object Foreign)) Unit, onContentSizeChange :: EffectFn2 Number Number Unit, onEndReached :: Effect Unit, onEndReachedThreshold :: Number, onLayout :: EffectFn1 LayoutChangeEvent Unit, onMagicTap :: Effect Unit, onMomentumScrollBegin :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onMomentumScrollEnd :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onMoveShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onMoveShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onResponderEnd :: EffectFn1 GestureResponderEvent Unit, onResponderGrant :: EffectFn1 GestureResponderEvent Unit, onResponderMove :: EffectFn1 GestureResponderEvent Unit, onResponderReject :: EffectFn1 GestureResponderEvent Unit, onResponderRelease :: EffectFn1 GestureResponderEvent Unit, onResponderStart :: EffectFn1 GestureResponderEvent Unit, onResponderTerminate :: EffectFn1 GestureResponderEvent Unit, onResponderTerminationRequest :: EffectFn1 GestureResponderEvent Boolean, onScroll :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onScrollAnimationEnd :: Effect Unit, onScrollBeginDrag :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onScrollEndDrag :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onStartShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onTouchCancel :: EffectFn1 GestureResponderEvent Unit, onTouchEnd :: EffectFn1 GestureResponderEvent Unit, onTouchEndCapture :: EffectFn1 GestureResponderEvent Unit, onTouchMove :: EffectFn1 GestureResponderEvent Unit, onTouchStart :: EffectFn1 GestureResponderEvent Unit, overScrollMode :: String, pageSize :: Number, pagingEnabled :: Boolean, pinchGestureEnabled :: Boolean, pointerEvents :: String, refreshControl :: JSX, removeClippedSubviews :: Boolean, renderFooter :: Effect JSX, renderHeader :: Effect JSX, renderScrollComponent :: EffectFn1 (Record ScrollViewProps) JSX, renderSectionHeader :: EffectFn2 Foreign String JSX, renderSeparator :: EffectFn3 String String Boolean JSX, renderToHardwareTextureAndroid :: Boolean, scrollEnabled :: Boolean, scrollEventThrottle :: Number, scrollIndicatorInsets :: Insets, scrollPerfTag :: String, scrollRenderAheadDistance :: Number, scrollsToTop :: Boolean, shouldRasterizeIOS :: Boolean, showsHorizontalScrollIndicator :: Boolean, showsVerticalScrollIndicator :: Boolean, snapToAlignment :: String, snapToEnd :: Boolean, snapToInterval :: Number, snapToOffsets :: Array Number, snapToStart :: Boolean, stickyHeaderIndices :: Array Number, stickySectionHeadersEnabled :: Boolean, style :: CSS, testID :: String, tvParallaxMagnification :: Number, tvParallaxProperties :: { enabled :: Boolean, magnification :: Number, pressDelay :: Number, pressDuration :: Number, pressMagnification :: Number, shiftDistanceX :: Number, shiftDistanceY :: Number, tiltAngle :: Number }, tvParallaxShiftDistanceX :: Number, tvParallaxShiftDistanceY :: Number, tvParallaxTiltAngle :: Number, zoomScale :: Number)

see https://facebook.github.io/react-native/docs/listview.html#props

  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • alwaysBounceHorizontal When true the scroll view bounces horizontally when it reaches the end even if the content is smaller than the scroll view itself. The default value is true when horizontal={true} and false otherwise.
  • alwaysBounceVertical When true the scroll view bounces vertically when it reaches the end even if the content is smaller than the scroll view itself. The default value is false when horizontal={true} and true otherwise.
  • automaticallyAdjustContentInsets Controls whether iOS should automatically adjust the content inset for scroll views that are placed behind a navigation bar or tab bar/ toolbar. The default value is true.
  • bounces When true the scroll view bounces when it reaches the end of the content if the content is larger then the scroll view along the axis of the scroll direction. When false it disables all bouncing even if the alwaysBounce* props are true. The default value is true.
  • bouncesZoom When true gestures can drive zoom past min/max and the zoom will animate to the min/max value at gesture end otherwise the zoom will not exceed the limits.
  • canCancelContentTouches When false once tracking starts won't try to drag if the touch moves. The default value is true.
  • centerContent When true the scroll view automatically centers the content when the content is smaller than the scroll view bounds; when the content is larger than the scroll view this property has no effect. The default value is false.
  • collapsable 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.
  • contentContainerStyle These styles will be applied to the scroll view content container which wraps all of the child views. Example: return ( <ScrollView contentContainerStyle={styles.contentContainer}> </ScrollView> ); ... const styles = StyleSheet.create({ contentContainer: { paddingVertical: 20 } });
  • contentInset The amount by which the scroll view content is inset from the edges of the scroll view. Defaults to {0, 0, 0, 0}.
  • contentInsetAdjustmentBehavior This property specifies how the safe area insets are used to modify the content area of the scroll view. The default value of this property must be 'automatic'. But the default value is 'never' until RN@0.51.
  • contentOffset Used to manually set the starting scroll offset. The default value is {x: 0, y: 0}
  • dataSource An instance of ListView.DataSource to use
  • decelerationRate A floating-point number that determines how quickly the scroll view decelerates after the user lifts their finger. Reasonable choices include - Normal: 0.998 (the default) - Fast: 0.9
  • directionalLockEnabled When true the ScrollView will try to lock to only vertical or horizontal scrolling while dragging. The default value is false.
  • enableEmptySections Flag indicating whether empty section headers should be rendered. In the future release empty section headers will be rendered by default, and the flag will be deprecated. If empty sections are not desired to be rendered their indices should be excluded from sectionID object.
  • endFillColor Sometimes a scrollview takes up more space than its content fills. When this is the case, this prop will fill the rest of the scrollview with a color to avoid setting a background and creating unnecessary overdraw. This is an advanced optimization that is not needed in the general case.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • horizontal When true the scroll view's children are arranged horizontally in a row instead of vertically in a column. The default value is false.
  • importantForAccessibility 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.
  • indicatorStyle The style of the scroll indicators. - default (the default), same as black. - black, scroll indicator is black. This style is good against a white content background. - white, scroll indicator is white. This style is good against a black content background.
  • initialListSize How many rows to render on initial component mount. Use this to make it so that the first screen worth of data apears at one time instead of over the course of multiple frames.
  • invertStickyHeaders If sticky headers should stick at the bottom instead of the top of the ScrollView. This is usually used with inverted ScrollViews.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • keyboardDismissMode Determines whether the keyboard gets dismissed in response to a drag. - 'none' (the default) drags do not dismiss the keyboard. - 'onDrag' the keyboard is dismissed when a drag begins. - 'interactive' the keyboard is dismissed interactively with the drag and moves in synchrony with the touch; dragging upwards cancels the dismissal.
  • keyboardShouldPersistTaps Determines when the keyboard should stay visible after a tap. - 'never' (the default), tapping outside of the focused text input when the keyboard is up dismisses the keyboard. When this happens, children won't receive the tap. - 'always', the keyboard will not dismiss automatically, and the scroll view will not catch taps, but children of the scroll view can catch taps. - 'handled', the keyboard will not dismiss automatically when the tap was handled by a children, (or captured by an ancestor). - false, deprecated, use 'never' instead - true, deprecated, use 'always' instead
  • maximumZoomScale The maximum allowed zoom scale. The default value is 1.0.
  • minimumZoomScale The minimum allowed zoom scale. The default value is 1.0.
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • nestedScrollEnabled Enables nested scrolling for Android API level 21+. Nested scrolling is supported by default on iOS.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onChangeVisibleRows (visibleRows, changedRows) => void Called when the set of visible rows changes. visibleRows maps { sectionID: { rowID: true }} for all the visible rows, and changedRows maps { sectionID: { rowID: true | false }} for the rows that have changed their visibility, with true indicating visible, and false indicating the view has moved out of view.
  • onContentSizeChange Called when scrollable content view of the ScrollView changes. Handler function is passed the content width and content height as parameters: (contentWidth, contentHeight) It's implemented using onLayout handler attached to the content container which this ScrollView renders.
  • onEndReached Called when all rows have been rendered and the list has been scrolled to within onEndReachedThreshold of the bottom. The native scroll event is provided.
  • onEndReachedThreshold Threshold in pixels for onEndReached.
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMomentumScrollBegin Fires when scroll view has begun moving
  • onMomentumScrollEnd Fires when scroll view has finished moving
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onScroll Fires at most once per frame during scrolling. The frequency of the events can be contolled using the scrollEventThrottle prop.
  • onScrollAnimationEnd Called when a scrolling animation ends.
  • onScrollBeginDrag Fires if a user initiates a scroll gesture.
  • onScrollEndDrag Fires when a user has finished scrolling.
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • overScrollMode Used to override default value of overScroll mode. Possible values: - 'auto' - Default value, allow a user to over-scroll this view only if the content is large enough to meaningfully scroll. - 'always' - Always allow a user to over-scroll this view. - 'never' - Never allow a user to over-scroll this view.
  • pageSize Number of rows to render per event loop.
  • pagingEnabled When true the scroll view stops on multiples of the scroll view's size when scrolling. This can be used for horizontal pagination. The default value is false.
  • pinchGestureEnabled When true, ScrollView allows use of pinch gestures to zoom in and out. The default value is true.
  • pointerEvents 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.
  • refreshControl A RefreshControl component, used to provide pull-to-refresh functionality for the ScrollView.
  • removeClippedSubviews A performance optimization for improving scroll perf of large lists, used in conjunction with overflow: 'hidden' on the row containers. Use at your own risk.
  • renderFooter () => renderable The header and footer are always rendered (if these props are provided) on every render pass. If they are expensive to re-render, wrap them in StaticContainer or other mechanism as appropriate. Footer is always at the bottom of the list, and header at the top, on every render pass.
  • renderHeader () => renderable The header and footer are always rendered (if these props are provided) on every render pass. If they are expensive to re-render, wrap them in StaticContainer or other mechanism as appropriate. Footer is always at the bottom of the list, and header at the top, on every render pass.
  • renderRow (rowData, sectionID, rowID) => renderable Takes a data entry from the data source and its ids and should return a renderable component to be rendered as the row. By default the data is exactly what was put into the data source, but it's also possible to provide custom extractors.
  • renderScrollComponent A function that returns the scrollable component in which the list rows are rendered. Defaults to returning a ScrollView with the given props.
  • renderSectionHeader (sectionData, sectionID) => renderable If provided, a sticky header is rendered for this section. The sticky behavior means that it will scroll with the content at the top of the section until it reaches the top of the screen, at which point it will stick to the top until it is pushed off the screen by the next section header.
  • renderSeparator (sectionID, rowID, adjacentRowHighlighted) => renderable If provided, a renderable component to be rendered as the separator below each row but not the last row if there is a section header below. Take a sectionID and rowID of the row above and whether its adjacent row is highlighted.
  • renderToHardwareTextureAndroid 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.
  • scrollEnabled When false, the content does not scroll. The default value is true
  • scrollEventThrottle This controls how often the scroll event will be fired while scrolling (in events per seconds). A higher number yields better accuracy for code that is tracking the scroll position, but can lead to scroll performance problems due to the volume of information being send over the bridge. The default value is zero, which means the scroll event will be sent only once each time the view is scrolled.
  • scrollIndicatorInsets The amount by which the scroll view indicators are inset from the edges of the scroll view. This should normally be set to the same value as the contentInset. Defaults to {0, 0, 0, 0}.
  • scrollPerfTag Tag used to log scroll performance on this scroll view. Will force momentum events to be turned on (see sendMomentumEvents). This doesn't do anything out of the box and you need to implement a custom native FpsListener for it to be useful. platform android
  • scrollRenderAheadDistance How early to start rendering rows before they come on screen, in pixels.
  • scrollsToTop When true the scroll view scrolls to top when the status bar is tapped. The default value is true.
  • shouldRasterizeIOS 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.
  • showsHorizontalScrollIndicator When true, shows a horizontal scroll indicator.
  • showsVerticalScrollIndicator When true, shows a vertical scroll indicator.
  • snapToAlignment When snapToInterval is set, snapToAlignment will define the relationship of the the snapping to the scroll view. - start (the default) will align the snap at the left (horizontal) or top (vertical) - center will align the snap in the center - end will align the snap at the right (horizontal) or bottom (vertical)
  • snapToEnd Use in conjuction with snapToOffsets. By default, the end of the list counts as a snap offset. Set snapToEnd to false to disable this behavior and allow the list to scroll freely between its end and the last snapToOffsets offset. The default value is true.
  • snapToInterval When set, causes the scroll view to stop at multiples of the value of snapToInterval. This can be used for paginating through children that have lengths smaller than the scroll view. Used in combination with snapToAlignment and decelerationRate="fast". Overrides less configurable pagingEnabled prop.
  • snapToOffsets When set, causes the scroll view to stop at the defined offsets. This can be used for paginating through variously sized children that have lengths smaller than the scroll view. Typically used in combination with decelerationRate="fast". Overrides less configurable pagingEnabled and snapToInterval props.
  • snapToStart Use in conjuction with snapToOffsets. By default, the beginning of the list counts as a snap offset. Set snapToStart to false to disable this behavior and allow the list to scroll freely between its start and the first snapToOffsets offset. The default value is true.
  • stickyHeaderIndices An array of child indices determining which children get docked to the top of the screen when scrolling. For example, passing stickyHeaderIndices={[0]} will cause the first child to be fixed to the top of the scroll view. This property is not supported in conjunction with horizontal={true}. platform ios
  • stickySectionHeadersEnabled Makes the sections headers sticky. The sticky behavior means that it will scroll with the content at the top of the section until it reaches the top of the screen, at which point it will stick to the top until it is pushed off the screen by the next section header. This property is not supported in conjunction with horizontal={true}. Only enabled by default on iOS because of typical platform standards.
  • style Style
  • testID Used to locate this view in end-to-end tests.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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
  • zoomScale The current scale of the scroll view content. The default value is 1.0.

#ListViewProps_required Source

type ListViewProps_required optional = (dataSource :: ListViewDataSource, renderRow :: EffectFn4 Foreign String String Boolean JSX | optional)

see https://facebook.github.io/react-native/docs/listview.html#props

  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • alwaysBounceHorizontal When true the scroll view bounces horizontally when it reaches the end even if the content is smaller than the scroll view itself. The default value is true when horizontal={true} and false otherwise.
  • alwaysBounceVertical When true the scroll view bounces vertically when it reaches the end even if the content is smaller than the scroll view itself. The default value is false when horizontal={true} and true otherwise.
  • automaticallyAdjustContentInsets Controls whether iOS should automatically adjust the content inset for scroll views that are placed behind a navigation bar or tab bar/ toolbar. The default value is true.
  • bounces When true the scroll view bounces when it reaches the end of the content if the content is larger then the scroll view along the axis of the scroll direction. When false it disables all bouncing even if the alwaysBounce* props are true. The default value is true.
  • bouncesZoom When true gestures can drive zoom past min/max and the zoom will animate to the min/max value at gesture end otherwise the zoom will not exceed the limits.
  • canCancelContentTouches When false once tracking starts won't try to drag if the touch moves. The default value is true.
  • centerContent When true the scroll view automatically centers the content when the content is smaller than the scroll view bounds; when the content is larger than the scroll view this property has no effect. The default value is false.
  • collapsable 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.
  • contentContainerStyle These styles will be applied to the scroll view content container which wraps all of the child views. Example: return ( <ScrollView contentContainerStyle={styles.contentContainer}> </ScrollView> ); ... const styles = StyleSheet.create({ contentContainer: { paddingVertical: 20 } });
  • contentInset The amount by which the scroll view content is inset from the edges of the scroll view. Defaults to {0, 0, 0, 0}.
  • contentInsetAdjustmentBehavior This property specifies how the safe area insets are used to modify the content area of the scroll view. The default value of this property must be 'automatic'. But the default value is 'never' until RN@0.51.
  • contentOffset Used to manually set the starting scroll offset. The default value is {x: 0, y: 0}
  • dataSource An instance of ListView.DataSource to use
  • decelerationRate A floating-point number that determines how quickly the scroll view decelerates after the user lifts their finger. Reasonable choices include - Normal: 0.998 (the default) - Fast: 0.9
  • directionalLockEnabled When true the ScrollView will try to lock to only vertical or horizontal scrolling while dragging. The default value is false.
  • enableEmptySections Flag indicating whether empty section headers should be rendered. In the future release empty section headers will be rendered by default, and the flag will be deprecated. If empty sections are not desired to be rendered their indices should be excluded from sectionID object.
  • endFillColor Sometimes a scrollview takes up more space than its content fills. When this is the case, this prop will fill the rest of the scrollview with a color to avoid setting a background and creating unnecessary overdraw. This is an advanced optimization that is not needed in the general case.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • horizontal When true the scroll view's children are arranged horizontally in a row instead of vertically in a column. The default value is false.
  • importantForAccessibility 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.
  • indicatorStyle The style of the scroll indicators. - default (the default), same as black. - black, scroll indicator is black. This style is good against a white content background. - white, scroll indicator is white. This style is good against a black content background.
  • initialListSize How many rows to render on initial component mount. Use this to make it so that the first screen worth of data apears at one time instead of over the course of multiple frames.
  • invertStickyHeaders If sticky headers should stick at the bottom instead of the top of the ScrollView. This is usually used with inverted ScrollViews.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • keyboardDismissMode Determines whether the keyboard gets dismissed in response to a drag. - 'none' (the default) drags do not dismiss the keyboard. - 'onDrag' the keyboard is dismissed when a drag begins. - 'interactive' the keyboard is dismissed interactively with the drag and moves in synchrony with the touch; dragging upwards cancels the dismissal.
  • keyboardShouldPersistTaps Determines when the keyboard should stay visible after a tap. - 'never' (the default), tapping outside of the focused text input when the keyboard is up dismisses the keyboard. When this happens, children won't receive the tap. - 'always', the keyboard will not dismiss automatically, and the scroll view will not catch taps, but children of the scroll view can catch taps. - 'handled', the keyboard will not dismiss automatically when the tap was handled by a children, (or captured by an ancestor). - false, deprecated, use 'never' instead - true, deprecated, use 'always' instead
  • maximumZoomScale The maximum allowed zoom scale. The default value is 1.0.
  • minimumZoomScale The minimum allowed zoom scale. The default value is 1.0.
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • nestedScrollEnabled Enables nested scrolling for Android API level 21+. Nested scrolling is supported by default on iOS.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onChangeVisibleRows (visibleRows, changedRows) => void Called when the set of visible rows changes. visibleRows maps { sectionID: { rowID: true }} for all the visible rows, and changedRows maps { sectionID: { rowID: true | false }} for the rows that have changed their visibility, with true indicating visible, and false indicating the view has moved out of view.
  • onContentSizeChange Called when scrollable content view of the ScrollView changes. Handler function is passed the content width and content height as parameters: (contentWidth, contentHeight) It's implemented using onLayout handler attached to the content container which this ScrollView renders.
  • onEndReached Called when all rows have been rendered and the list has been scrolled to within onEndReachedThreshold of the bottom. The native scroll event is provided.
  • onEndReachedThreshold Threshold in pixels for onEndReached.
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMomentumScrollBegin Fires when scroll view has begun moving
  • onMomentumScrollEnd Fires when scroll view has finished moving
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onScroll Fires at most once per frame during scrolling. The frequency of the events can be contolled using the scrollEventThrottle prop.
  • onScrollAnimationEnd Called when a scrolling animation ends.
  • onScrollBeginDrag Fires if a user initiates a scroll gesture.
  • onScrollEndDrag Fires when a user has finished scrolling.
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • overScrollMode Used to override default value of overScroll mode. Possible values: - 'auto' - Default value, allow a user to over-scroll this view only if the content is large enough to meaningfully scroll. - 'always' - Always allow a user to over-scroll this view. - 'never' - Never allow a user to over-scroll this view.
  • pageSize Number of rows to render per event loop.
  • pagingEnabled When true the scroll view stops on multiples of the scroll view's size when scrolling. This can be used for horizontal pagination. The default value is false.
  • pinchGestureEnabled When true, ScrollView allows use of pinch gestures to zoom in and out. The default value is true.
  • pointerEvents 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.
  • refreshControl A RefreshControl component, used to provide pull-to-refresh functionality for the ScrollView.
  • removeClippedSubviews A performance optimization for improving scroll perf of large lists, used in conjunction with overflow: 'hidden' on the row containers. Use at your own risk.
  • renderFooter () => renderable The header and footer are always rendered (if these props are provided) on every render pass. If they are expensive to re-render, wrap them in StaticContainer or other mechanism as appropriate. Footer is always at the bottom of the list, and header at the top, on every render pass.
  • renderHeader () => renderable The header and footer are always rendered (if these props are provided) on every render pass. If they are expensive to re-render, wrap them in StaticContainer or other mechanism as appropriate. Footer is always at the bottom of the list, and header at the top, on every render pass.
  • renderRow (rowData, sectionID, rowID) => renderable Takes a data entry from the data source and its ids and should return a renderable component to be rendered as the row. By default the data is exactly what was put into the data source, but it's also possible to provide custom extractors.
  • renderScrollComponent A function that returns the scrollable component in which the list rows are rendered. Defaults to returning a ScrollView with the given props.
  • renderSectionHeader (sectionData, sectionID) => renderable If provided, a sticky header is rendered for this section. The sticky behavior means that it will scroll with the content at the top of the section until it reaches the top of the screen, at which point it will stick to the top until it is pushed off the screen by the next section header.
  • renderSeparator (sectionID, rowID, adjacentRowHighlighted) => renderable If provided, a renderable component to be rendered as the separator below each row but not the last row if there is a section header below. Take a sectionID and rowID of the row above and whether its adjacent row is highlighted.
  • renderToHardwareTextureAndroid 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.
  • scrollEnabled When false, the content does not scroll. The default value is true
  • scrollEventThrottle This controls how often the scroll event will be fired while scrolling (in events per seconds). A higher number yields better accuracy for code that is tracking the scroll position, but can lead to scroll performance problems due to the volume of information being send over the bridge. The default value is zero, which means the scroll event will be sent only once each time the view is scrolled.
  • scrollIndicatorInsets The amount by which the scroll view indicators are inset from the edges of the scroll view. This should normally be set to the same value as the contentInset. Defaults to {0, 0, 0, 0}.
  • scrollPerfTag Tag used to log scroll performance on this scroll view. Will force momentum events to be turned on (see sendMomentumEvents). This doesn't do anything out of the box and you need to implement a custom native FpsListener for it to be useful. platform android
  • scrollRenderAheadDistance How early to start rendering rows before they come on screen, in pixels.
  • scrollsToTop When true the scroll view scrolls to top when the status bar is tapped. The default value is true.
  • shouldRasterizeIOS 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.
  • showsHorizontalScrollIndicator When true, shows a horizontal scroll indicator.
  • showsVerticalScrollIndicator When true, shows a vertical scroll indicator.
  • snapToAlignment When snapToInterval is set, snapToAlignment will define the relationship of the the snapping to the scroll view. - start (the default) will align the snap at the left (horizontal) or top (vertical) - center will align the snap in the center - end will align the snap at the right (horizontal) or bottom (vertical)
  • snapToEnd Use in conjuction with snapToOffsets. By default, the end of the list counts as a snap offset. Set snapToEnd to false to disable this behavior and allow the list to scroll freely between its end and the last snapToOffsets offset. The default value is true.
  • snapToInterval When set, causes the scroll view to stop at multiples of the value of snapToInterval. This can be used for paginating through children that have lengths smaller than the scroll view. Used in combination with snapToAlignment and decelerationRate="fast". Overrides less configurable pagingEnabled prop.
  • snapToOffsets When set, causes the scroll view to stop at the defined offsets. This can be used for paginating through variously sized children that have lengths smaller than the scroll view. Typically used in combination with decelerationRate="fast". Overrides less configurable pagingEnabled and snapToInterval props.
  • snapToStart Use in conjuction with snapToOffsets. By default, the beginning of the list counts as a snap offset. Set snapToStart to false to disable this behavior and allow the list to scroll freely between its start and the first snapToOffsets offset. The default value is true.
  • stickyHeaderIndices An array of child indices determining which children get docked to the top of the screen when scrolling. For example, passing stickyHeaderIndices={[0]} will cause the first child to be fixed to the top of the scroll view. This property is not supported in conjunction with horizontal={true}. platform ios
  • stickySectionHeadersEnabled Makes the sections headers sticky. The sticky behavior means that it will scroll with the content at the top of the section until it reaches the top of the screen, at which point it will stick to the top until it is pushed off the screen by the next section header. This property is not supported in conjunction with horizontal={true}. Only enabled by default on iOS because of typical platform standards.
  • style Style
  • testID Used to locate this view in end-to-end tests.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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
  • zoomScale The current scale of the scroll view content. The default value is 1.0.

#listView Source

listView :: forall attrs_ attrs. Union attrs attrs_ (ListViewProps_optional) => Record ((ListViewProps_required) attrs) -> JSX

#MaskedViewIOSProps_optional Source

type MaskedViewIOSProps_optional = (accessibilityActions :: Array String, accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessibilityViewIsModal :: Boolean, accessible :: Boolean, children :: Array JSX, collapsable :: Boolean, hasTVPreferredFocus :: Boolean, hitSlop :: Insets, importantForAccessibility :: String, isTVSelectable :: Boolean, key :: String, nativeID :: String, needsOffscreenAlphaCompositing :: Boolean, onAccessibilityAction :: Effect Unit, onAccessibilityTap :: Effect Unit, onLayout :: EffectFn1 LayoutChangeEvent Unit, onMagicTap :: Effect Unit, onMoveShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onMoveShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onResponderEnd :: EffectFn1 GestureResponderEvent Unit, onResponderGrant :: EffectFn1 GestureResponderEvent Unit, onResponderMove :: EffectFn1 GestureResponderEvent Unit, onResponderReject :: EffectFn1 GestureResponderEvent Unit, onResponderRelease :: EffectFn1 GestureResponderEvent Unit, onResponderStart :: EffectFn1 GestureResponderEvent Unit, onResponderTerminate :: EffectFn1 GestureResponderEvent Unit, onResponderTerminationRequest :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onTouchCancel :: EffectFn1 GestureResponderEvent Unit, onTouchEnd :: EffectFn1 GestureResponderEvent Unit, onTouchEndCapture :: EffectFn1 GestureResponderEvent Unit, onTouchMove :: EffectFn1 GestureResponderEvent Unit, onTouchStart :: EffectFn1 GestureResponderEvent Unit, pointerEvents :: String, removeClippedSubviews :: Boolean, renderToHardwareTextureAndroid :: Boolean, shouldRasterizeIOS :: Boolean, style :: CSS, testID :: String, tvParallaxMagnification :: Number, tvParallaxProperties :: { enabled :: Boolean, magnification :: Number, pressDelay :: Number, pressDuration :: Number, pressMagnification :: Number, shiftDistanceX :: Number, shiftDistanceY :: Number, tiltAngle :: Number }, tvParallaxShiftDistanceX :: Number, tvParallaxShiftDistanceY :: Number, tvParallaxTiltAngle :: Number)
  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • collapsable 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.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • importantForAccessibility 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.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • pointerEvents 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.
  • removeClippedSubviews 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).
  • renderToHardwareTextureAndroid 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.
  • shouldRasterizeIOS 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.
  • testID Used to locate this view in end-to-end tests.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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

#MaskedViewIOSProps_required Source

type MaskedViewIOSProps_required optional = (maskElement :: JSX | optional)
  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • collapsable 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.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • importantForAccessibility 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.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • pointerEvents 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.
  • removeClippedSubviews 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).
  • renderToHardwareTextureAndroid 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.
  • shouldRasterizeIOS 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.
  • testID Used to locate this view in end-to-end tests.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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

#maskedView Source

maskedView :: forall attrs_ attrs. Union attrs attrs_ (MaskedViewIOSProps_optional) => Record ((MaskedViewIOSProps_required) attrs) -> JSX

#NativeScrollEvent Source

type NativeScrollEvent = { contentInset :: NativeScrollRectangle, contentOffset :: NativeScrollPoint, contentSize :: NativeScrollSize, layoutMeasurement :: NativeScrollSize, velocity :: Undefinable NativeScrollVelocity, zoomScale :: Number }

#NativeScrollPoint Source

type NativeScrollPoint = { x :: Number, y :: Number }

#NativeScrollRectangle Source

type NativeScrollRectangle = { bottom :: Number, left :: Number, right :: Number, top :: Number }

#NativeScrollSize Source

type NativeScrollSize = { height :: Number, width :: Number }

#NativeScrollVelocity Source

type NativeScrollVelocity = { x :: Number, y :: Number }

#NativeSegmentedControlIOSChangeEvent Source

type NativeSegmentedControlIOSChangeEvent = { selectedSegmentIndex :: Number, target :: Number, value :: String }

#NativeTouchEvent Source

newtype NativeTouchEvent

Constructors

#NavState Source

type NavState = { canGoBack :: Undefinable Boolean, canGoForward :: Undefinable Boolean, loading :: Undefinable Boolean, title :: Undefinable String, url :: Undefinable String }

#NavigatorIOSProps_optional Source

type NavigatorIOSProps_optional = (barTintColor :: String, children :: Array JSX, interactivePopGestureEnabled :: Boolean, itemWrapperStyle :: CSS, key :: String, navigationBarHidden :: Boolean, shadowHidden :: Boolean, style :: CSS, tintColor :: String, titleTextColor :: String, translucent :: Boolean)
  • barTintColor The default background color of the navigation bar.
  • initialRoute NavigatorIOS uses "route" objects to identify child views, their props, and navigation bar configuration. "push" and all the other navigation operations expect routes to be like this
  • interactivePopGestureEnabled Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture. If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
  • itemWrapperStyle The default wrapper style for components in the navigator. A common use case is to set the backgroundColor for every page
  • navigationBarHidden A Boolean value that indicates whether the navigation bar is hidden
  • shadowHidden A Boolean value that indicates whether to hide the 1px hairline shadow
  • style NOT IN THE DOC BUT IN THE EXAMPLES
  • tintColor The color used for buttons in the navigation bar
  • titleTextColor The text color of the navigation bar title
  • translucent A Boolean value that indicates whether the navigation bar is translucent

#NavigatorIOSProps_required Source

type NavigatorIOSProps_required optional = (initialRoute :: Route | optional)
  • barTintColor The default background color of the navigation bar.
  • initialRoute NavigatorIOS uses "route" objects to identify child views, their props, and navigation bar configuration. "push" and all the other navigation operations expect routes to be like this
  • interactivePopGestureEnabled Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture. If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
  • itemWrapperStyle The default wrapper style for components in the navigator. A common use case is to set the backgroundColor for every page
  • navigationBarHidden A Boolean value that indicates whether the navigation bar is hidden
  • shadowHidden A Boolean value that indicates whether to hide the 1px hairline shadow
  • style NOT IN THE DOC BUT IN THE EXAMPLES
  • tintColor The color used for buttons in the navigation bar
  • titleTextColor The text color of the navigation bar title
  • translucent A Boolean value that indicates whether the navigation bar is translucent

#navigatorIOS Source

navigatorIOS :: forall attrs_ attrs. Union attrs attrs_ (NavigatorIOSProps_optional) => Record ((NavigatorIOSProps_required) attrs) -> JSX

#PickerIOSItemProps Source

type PickerIOSItemProps = (children :: Array JSX, key :: String, label :: String, value :: String)

see PickerIOS.ios.js

#pickerIOSItem Source

pickerIOSItem :: forall attrs_ attrs. Union attrs attrs_ (PickerIOSItemProps) => Record attrs -> JSX

#pickerIOSItem_ Source

#PickerIOSProps Source

type PickerIOSProps = (accessibilityActions :: Array String, accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessibilityViewIsModal :: Boolean, accessible :: Boolean, children :: Array JSX, collapsable :: Boolean, hasTVPreferredFocus :: Boolean, hitSlop :: Insets, importantForAccessibility :: String, isTVSelectable :: Boolean, itemStyle :: CSS, key :: String, nativeID :: String, needsOffscreenAlphaCompositing :: Boolean, onAccessibilityAction :: Effect Unit, onAccessibilityTap :: Effect Unit, onLayout :: EffectFn1 LayoutChangeEvent Unit, onMagicTap :: Effect Unit, onMoveShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onMoveShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onResponderEnd :: EffectFn1 GestureResponderEvent Unit, onResponderGrant :: EffectFn1 GestureResponderEvent Unit, onResponderMove :: EffectFn1 GestureResponderEvent Unit, onResponderReject :: EffectFn1 GestureResponderEvent Unit, onResponderRelease :: EffectFn1 GestureResponderEvent Unit, onResponderStart :: EffectFn1 GestureResponderEvent Unit, onResponderTerminate :: EffectFn1 GestureResponderEvent Unit, onResponderTerminationRequest :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onTouchCancel :: EffectFn1 GestureResponderEvent Unit, onTouchEnd :: EffectFn1 GestureResponderEvent Unit, onTouchEndCapture :: EffectFn1 GestureResponderEvent Unit, onTouchMove :: EffectFn1 GestureResponderEvent Unit, onTouchStart :: EffectFn1 GestureResponderEvent Unit, onValueChange :: EffectFn1 String Unit, pointerEvents :: String, removeClippedSubviews :: Boolean, renderToHardwareTextureAndroid :: Boolean, selectedValue :: String, shouldRasterizeIOS :: Boolean, style :: CSS, testID :: String, tvParallaxMagnification :: Number, tvParallaxProperties :: { enabled :: Boolean, magnification :: Number, pressDelay :: Number, pressDuration :: Number, pressMagnification :: Number, shiftDistanceX :: Number, shiftDistanceY :: Number, tiltAngle :: Number }, tvParallaxShiftDistanceX :: Number, tvParallaxShiftDistanceY :: Number, tvParallaxTiltAngle :: Number)

see https://facebook.github.io/react-native/docs/pickerios.html see PickerIOS.ios.js

  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • collapsable 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.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • importantForAccessibility 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.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • pointerEvents 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.
  • removeClippedSubviews 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).
  • renderToHardwareTextureAndroid 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.
  • shouldRasterizeIOS 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.
  • testID Used to locate this view in end-to-end tests.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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

#pickerIOS Source

pickerIOS :: forall attrs_ attrs. Union attrs attrs_ (PickerIOSProps) => Record attrs -> JSX

#pickerIOS_ Source

#PickerItemProps_optional Source

type PickerItemProps_optional = (children :: Array JSX, color :: String, key :: String, testID :: String, value :: Foreign)

see Picker.js

#PickerItemProps_required Source

type PickerItemProps_required optional = (label :: String | optional)

see Picker.js

#pickerItem Source

pickerItem :: forall attrs_ attrs. Union attrs attrs_ (PickerItemProps_optional) => Record ((PickerItemProps_required) attrs) -> JSX

#PickerProps Source

type PickerProps = (accessibilityActions :: Array String, accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessibilityViewIsModal :: Boolean, accessible :: Boolean, children :: Array JSX, collapsable :: Boolean, enabled :: Boolean, hasTVPreferredFocus :: Boolean, hitSlop :: Insets, importantForAccessibility :: String, isTVSelectable :: Boolean, itemStyle :: CSS, key :: String, mode :: String, nativeID :: String, needsOffscreenAlphaCompositing :: Boolean, onAccessibilityAction :: Effect Unit, onAccessibilityTap :: Effect Unit, onLayout :: EffectFn1 LayoutChangeEvent Unit, onMagicTap :: Effect Unit, onMoveShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onMoveShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onResponderEnd :: EffectFn1 GestureResponderEvent Unit, onResponderGrant :: EffectFn1 GestureResponderEvent Unit, onResponderMove :: EffectFn1 GestureResponderEvent Unit, onResponderReject :: EffectFn1 GestureResponderEvent Unit, onResponderRelease :: EffectFn1 GestureResponderEvent Unit, onResponderStart :: EffectFn1 GestureResponderEvent Unit, onResponderTerminate :: EffectFn1 GestureResponderEvent Unit, onResponderTerminationRequest :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onTouchCancel :: EffectFn1 GestureResponderEvent Unit, onTouchEnd :: EffectFn1 GestureResponderEvent Unit, onTouchEndCapture :: EffectFn1 GestureResponderEvent Unit, onTouchMove :: EffectFn1 GestureResponderEvent Unit, onTouchStart :: EffectFn1 GestureResponderEvent Unit, onValueChange :: EffectFn2 Foreign Number Unit, pointerEvents :: String, prompt :: String, removeClippedSubviews :: Boolean, renderToHardwareTextureAndroid :: Boolean, selectedValue :: Foreign, shouldRasterizeIOS :: Boolean, style :: CSS, testID :: String, testId :: String, tvParallaxMagnification :: Number, tvParallaxProperties :: { enabled :: Boolean, magnification :: Number, pressDelay :: Number, pressDuration :: Number, pressMagnification :: Number, shiftDistanceX :: Number, shiftDistanceY :: Number, tiltAngle :: Number }, tvParallaxShiftDistanceX :: Number, tvParallaxShiftDistanceY :: Number, tvParallaxTiltAngle :: Number)

see https://facebook.github.io/react-native/docs/picker.html see Picker.js

  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • collapsable 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.
  • enabled If set to false, the picker will be disabled, i.e. the user will not be able to make a selection. platform android
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • importantForAccessibility 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.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • itemStyle Style to apply to each of the item labels. platform ios
  • mode On Android, specifies how to display the selection items when the user taps on the picker: - 'dialog': Show a modal dialog. This is the default. - 'dropdown': Shows a dropdown anchored to the picker view platform android
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onValueChange Callback for when an item is selected. This is called with the following parameters: - itemValue: the value prop of the item that was selected - itemPosition: the index of the selected item in this picker
  • pointerEvents 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.
  • prompt Prompt string for this picker, used on Android in dialog mode as the title of the dialog. platform android
  • removeClippedSubviews 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).
  • renderToHardwareTextureAndroid 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.
  • selectedValue Value matching value of one of the items. Can be a string or an integer.
  • shouldRasterizeIOS 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.
  • testID Used to locate this view in end-to-end tests.
  • testId Used to locate this view in end-to-end tests.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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

#picker Source

picker :: forall attrs_ attrs. Union attrs attrs_ (PickerProps) => Record attrs -> JSX

#picker_ Source

#PointPropType Source

type PointPropType = { x :: Number, y :: Number }

#ProgressBarAndroidProps Source

type ProgressBarAndroidProps = (accessibilityActions :: Array String, accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessibilityViewIsModal :: Boolean, accessible :: Boolean, children :: Array JSX, collapsable :: Boolean, color :: String, hasTVPreferredFocus :: Boolean, hitSlop :: Insets, importantForAccessibility :: String, indeterminate :: Boolean, isTVSelectable :: Boolean, key :: String, nativeID :: String, needsOffscreenAlphaCompositing :: Boolean, onAccessibilityAction :: Effect Unit, onAccessibilityTap :: Effect Unit, onLayout :: EffectFn1 LayoutChangeEvent Unit, onMagicTap :: Effect Unit, onMoveShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onMoveShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onResponderEnd :: EffectFn1 GestureResponderEvent Unit, onResponderGrant :: EffectFn1 GestureResponderEvent Unit, onResponderMove :: EffectFn1 GestureResponderEvent Unit, onResponderReject :: EffectFn1 GestureResponderEvent Unit, onResponderRelease :: EffectFn1 GestureResponderEvent Unit, onResponderStart :: EffectFn1 GestureResponderEvent Unit, onResponderTerminate :: EffectFn1 GestureResponderEvent Unit, onResponderTerminationRequest :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onTouchCancel :: EffectFn1 GestureResponderEvent Unit, onTouchEnd :: EffectFn1 GestureResponderEvent Unit, onTouchEndCapture :: EffectFn1 GestureResponderEvent Unit, onTouchMove :: EffectFn1 GestureResponderEvent Unit, onTouchStart :: EffectFn1 GestureResponderEvent Unit, pointerEvents :: String, progress :: Number, removeClippedSubviews :: Boolean, renderToHardwareTextureAndroid :: Boolean, shouldRasterizeIOS :: Boolean, style :: CSS, styleAttr :: String, testID :: String, tvParallaxMagnification :: Number, tvParallaxProperties :: { enabled :: Boolean, magnification :: Number, pressDelay :: Number, pressDuration :: Number, pressMagnification :: Number, shiftDistanceX :: Number, shiftDistanceY :: Number, tiltAngle :: Number }, tvParallaxShiftDistanceX :: Number, tvParallaxShiftDistanceY :: Number, tvParallaxTiltAngle :: Number)

see https://facebook.github.io/react-native/docs/progressbarandroid.html see ProgressBarAndroid.android.js

  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • collapsable 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.
  • color Color of the progress bar.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • importantForAccessibility 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.
  • indeterminate If the progress bar will show indeterminate progress. Note that this can only be false if styleAttr is Horizontal.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • pointerEvents 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.
  • progress The progress value (between 0 and 1).
  • removeClippedSubviews 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).
  • renderToHardwareTextureAndroid 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.
  • shouldRasterizeIOS 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.
  • styleAttr Style of the ProgressBar. One of: Horizontal Normal (default) Small Large Inverse SmallInverse LargeInverse
  • testID Used to locate this view in end-to-end tests.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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

#progressBarAndroid Source

progressBarAndroid :: forall attrs_ attrs. Union attrs attrs_ (ProgressBarAndroidProps) => Record attrs -> JSX

#progressBarAndroid_ Source

#ProgressViewIOSProps Source

type ProgressViewIOSProps = (accessibilityActions :: Array String, accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessibilityViewIsModal :: Boolean, accessible :: Boolean, children :: Array JSX, collapsable :: Boolean, hasTVPreferredFocus :: Boolean, hitSlop :: Insets, importantForAccessibility :: String, isTVSelectable :: Boolean, key :: String, nativeID :: String, needsOffscreenAlphaCompositing :: Boolean, onAccessibilityAction :: Effect Unit, onAccessibilityTap :: Effect Unit, onLayout :: EffectFn1 LayoutChangeEvent Unit, onMagicTap :: Effect Unit, onMoveShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onMoveShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onResponderEnd :: EffectFn1 GestureResponderEvent Unit, onResponderGrant :: EffectFn1 GestureResponderEvent Unit, onResponderMove :: EffectFn1 GestureResponderEvent Unit, onResponderReject :: EffectFn1 GestureResponderEvent Unit, onResponderRelease :: EffectFn1 GestureResponderEvent Unit, onResponderStart :: EffectFn1 GestureResponderEvent Unit, onResponderTerminate :: EffectFn1 GestureResponderEvent Unit, onResponderTerminationRequest :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onTouchCancel :: EffectFn1 GestureResponderEvent Unit, onTouchEnd :: EffectFn1 GestureResponderEvent Unit, onTouchEndCapture :: EffectFn1 GestureResponderEvent Unit, onTouchMove :: EffectFn1 GestureResponderEvent Unit, onTouchStart :: EffectFn1 GestureResponderEvent Unit, pointerEvents :: String, progress :: Number, progressImage :: Array ImageURISource, progressTintColor :: String, progressViewStyle :: String, removeClippedSubviews :: Boolean, renderToHardwareTextureAndroid :: Boolean, shouldRasterizeIOS :: Boolean, style :: CSS, testID :: String, trackImage :: Array ImageURISource, trackTintColor :: String, tvParallaxMagnification :: Number, tvParallaxProperties :: { enabled :: Boolean, magnification :: Number, pressDelay :: Number, pressDuration :: Number, pressMagnification :: Number, shiftDistanceX :: Number, shiftDistanceY :: Number, tiltAngle :: Number }, tvParallaxShiftDistanceX :: Number, tvParallaxShiftDistanceY :: Number, tvParallaxTiltAngle :: Number)

see https://facebook.github.io/react-native/docs/progressviewios.html see ProgressViewIOS.ios.js

  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • collapsable 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.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • importantForAccessibility 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.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • pointerEvents 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.
  • progress The progress value (between 0 and 1).
  • progressImage A stretchable image to display as the progress bar.
  • progressTintColor The tint color of the progress bar itself.
  • progressViewStyle The progress bar style.
  • removeClippedSubviews 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).
  • renderToHardwareTextureAndroid 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.
  • shouldRasterizeIOS 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.
  • testID Used to locate this view in end-to-end tests.
  • trackImage A stretchable image to display behind the progress bar.
  • trackTintColor The tint color of the progress bar track.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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

#progressViewIOS Source

progressViewIOS :: forall attrs_ attrs. Union attrs attrs_ (ProgressViewIOSProps) => Record attrs -> JSX

#progressViewIOS_ Source

#RecyclerViewBackedScrollViewProps Source

type RecyclerViewBackedScrollViewProps = (accessibilityActions :: Array String, accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessibilityViewIsModal :: Boolean, accessible :: Boolean, alwaysBounceHorizontal :: Boolean, alwaysBounceVertical :: Boolean, automaticallyAdjustContentInsets :: Boolean, bounces :: Boolean, bouncesZoom :: Boolean, canCancelContentTouches :: Boolean, centerContent :: Boolean, children :: Array JSX, collapsable :: Boolean, contentContainerStyle :: CSS, contentInset :: Insets, contentInsetAdjustmentBehavior :: String, contentOffset :: PointPropType, decelerationRate :: String, directionalLockEnabled :: Boolean, endFillColor :: String, hasTVPreferredFocus :: Boolean, hitSlop :: Insets, horizontal :: Boolean, importantForAccessibility :: String, indicatorStyle :: String, invertStickyHeaders :: Boolean, isTVSelectable :: Boolean, key :: String, keyboardDismissMode :: String, keyboardShouldPersistTaps :: String, maximumZoomScale :: Number, minimumZoomScale :: Number, nativeID :: String, needsOffscreenAlphaCompositing :: Boolean, nestedScrollEnabled :: Boolean, onAccessibilityAction :: Effect Unit, onAccessibilityTap :: Effect Unit, onContentSizeChange :: EffectFn2 Number Number Unit, onLayout :: EffectFn1 LayoutChangeEvent Unit, onMagicTap :: Effect Unit, onMomentumScrollBegin :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onMomentumScrollEnd :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onMoveShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onMoveShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onResponderEnd :: EffectFn1 GestureResponderEvent Unit, onResponderGrant :: EffectFn1 GestureResponderEvent Unit, onResponderMove :: EffectFn1 GestureResponderEvent Unit, onResponderReject :: EffectFn1 GestureResponderEvent Unit, onResponderRelease :: EffectFn1 GestureResponderEvent Unit, onResponderStart :: EffectFn1 GestureResponderEvent Unit, onResponderTerminate :: EffectFn1 GestureResponderEvent Unit, onResponderTerminationRequest :: EffectFn1 GestureResponderEvent Boolean, onScroll :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onScrollAnimationEnd :: Effect Unit, onScrollBeginDrag :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onScrollEndDrag :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onStartShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onTouchCancel :: EffectFn1 GestureResponderEvent Unit, onTouchEnd :: EffectFn1 GestureResponderEvent Unit, onTouchEndCapture :: EffectFn1 GestureResponderEvent Unit, onTouchMove :: EffectFn1 GestureResponderEvent Unit, onTouchStart :: EffectFn1 GestureResponderEvent Unit, overScrollMode :: String, pagingEnabled :: Boolean, pinchGestureEnabled :: Boolean, pointerEvents :: String, refreshControl :: JSX, removeClippedSubviews :: Boolean, renderToHardwareTextureAndroid :: Boolean, scrollEnabled :: Boolean, scrollEventThrottle :: Number, scrollIndicatorInsets :: Insets, scrollPerfTag :: String, scrollsToTop :: Boolean, shouldRasterizeIOS :: Boolean, showsHorizontalScrollIndicator :: Boolean, showsVerticalScrollIndicator :: Boolean, snapToAlignment :: String, snapToEnd :: Boolean, snapToInterval :: Number, snapToOffsets :: Array Number, snapToStart :: Boolean, stickyHeaderIndices :: Array Number, style :: CSS, testID :: String, tvParallaxMagnification :: Number, tvParallaxProperties :: { enabled :: Boolean, magnification :: Number, pressDelay :: Number, pressDuration :: Number, pressMagnification :: Number, shiftDistanceX :: Number, shiftDistanceY :: Number, tiltAngle :: Number }, tvParallaxShiftDistanceX :: Number, tvParallaxShiftDistanceY :: Number, tvParallaxTiltAngle :: Number, zoomScale :: Number)
  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • alwaysBounceHorizontal When true the scroll view bounces horizontally when it reaches the end even if the content is smaller than the scroll view itself. The default value is true when horizontal={true} and false otherwise.
  • alwaysBounceVertical When true the scroll view bounces vertically when it reaches the end even if the content is smaller than the scroll view itself. The default value is false when horizontal={true} and true otherwise.
  • automaticallyAdjustContentInsets Controls whether iOS should automatically adjust the content inset for scroll views that are placed behind a navigation bar or tab bar/ toolbar. The default value is true.
  • bounces When true the scroll view bounces when it reaches the end of the content if the content is larger then the scroll view along the axis of the scroll direction. When false it disables all bouncing even if the alwaysBounce* props are true. The default value is true.
  • bouncesZoom When true gestures can drive zoom past min/max and the zoom will animate to the min/max value at gesture end otherwise the zoom will not exceed the limits.
  • canCancelContentTouches When false once tracking starts won't try to drag if the touch moves. The default value is true.
  • centerContent When true the scroll view automatically centers the content when the content is smaller than the scroll view bounds; when the content is larger than the scroll view this property has no effect. The default value is false.
  • collapsable 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.
  • contentContainerStyle These styles will be applied to the scroll view content container which wraps all of the child views. Example: return ( <ScrollView contentContainerStyle={styles.contentContainer}> </ScrollView> ); ... const styles = StyleSheet.create({ contentContainer: { paddingVertical: 20 } });
  • contentInset The amount by which the scroll view content is inset from the edges of the scroll view. Defaults to {0, 0, 0, 0}.
  • contentInsetAdjustmentBehavior This property specifies how the safe area insets are used to modify the content area of the scroll view. The default value of this property must be 'automatic'. But the default value is 'never' until RN@0.51.
  • contentOffset Used to manually set the starting scroll offset. The default value is {x: 0, y: 0}
  • decelerationRate A floating-point number that determines how quickly the scroll view decelerates after the user lifts their finger. Reasonable choices include - Normal: 0.998 (the default) - Fast: 0.9
  • directionalLockEnabled When true the ScrollView will try to lock to only vertical or horizontal scrolling while dragging. The default value is false.
  • endFillColor Sometimes a scrollview takes up more space than its content fills. When this is the case, this prop will fill the rest of the scrollview with a color to avoid setting a background and creating unnecessary overdraw. This is an advanced optimization that is not needed in the general case.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • horizontal When true the scroll view's children are arranged horizontally in a row instead of vertically in a column. The default value is false.
  • importantForAccessibility 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.
  • indicatorStyle The style of the scroll indicators. - default (the default), same as black. - black, scroll indicator is black. This style is good against a white content background. - white, scroll indicator is white. This style is good against a black content background.
  • invertStickyHeaders If sticky headers should stick at the bottom instead of the top of the ScrollView. This is usually used with inverted ScrollViews.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • keyboardDismissMode Determines whether the keyboard gets dismissed in response to a drag. - 'none' (the default) drags do not dismiss the keyboard. - 'onDrag' the keyboard is dismissed when a drag begins. - 'interactive' the keyboard is dismissed interactively with the drag and moves in synchrony with the touch; dragging upwards cancels the dismissal.
  • keyboardShouldPersistTaps Determines when the keyboard should stay visible after a tap. - 'never' (the default), tapping outside of the focused text input when the keyboard is up dismisses the keyboard. When this happens, children won't receive the tap. - 'always', the keyboard will not dismiss automatically, and the scroll view will not catch taps, but children of the scroll view can catch taps. - 'handled', the keyboard will not dismiss automatically when the tap was handled by a children, (or captured by an ancestor). - false, deprecated, use 'never' instead - true, deprecated, use 'always' instead
  • maximumZoomScale The maximum allowed zoom scale. The default value is 1.0.
  • minimumZoomScale The minimum allowed zoom scale. The default value is 1.0.
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • nestedScrollEnabled Enables nested scrolling for Android API level 21+. Nested scrolling is supported by default on iOS.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onContentSizeChange Called when scrollable content view of the ScrollView changes. Handler function is passed the content width and content height as parameters: (contentWidth, contentHeight) It's implemented using onLayout handler attached to the content container which this ScrollView renders.
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMomentumScrollBegin Fires when scroll view has begun moving
  • onMomentumScrollEnd Fires when scroll view has finished moving
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onScroll Fires at most once per frame during scrolling. The frequency of the events can be contolled using the scrollEventThrottle prop.
  • onScrollAnimationEnd Called when a scrolling animation ends.
  • onScrollBeginDrag Fires if a user initiates a scroll gesture.
  • onScrollEndDrag Fires when a user has finished scrolling.
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • overScrollMode Used to override default value of overScroll mode. Possible values: - 'auto' - Default value, allow a user to over-scroll this view only if the content is large enough to meaningfully scroll. - 'always' - Always allow a user to over-scroll this view. - 'never' - Never allow a user to over-scroll this view.
  • pagingEnabled When true the scroll view stops on multiples of the scroll view's size when scrolling. This can be used for horizontal pagination. The default value is false.
  • pinchGestureEnabled When true, ScrollView allows use of pinch gestures to zoom in and out. The default value is true.
  • pointerEvents 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.
  • refreshControl A RefreshControl component, used to provide pull-to-refresh functionality for the ScrollView.
  • removeClippedSubviews Experimental: When true offscreen child views (whose overflow value is hidden) are removed from their native backing superview when offscreen. This canimprove scrolling performance on long lists. The default value is false.
  • renderToHardwareTextureAndroid 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.
  • scrollEnabled When false, the content does not scroll. The default value is true
  • scrollEventThrottle This controls how often the scroll event will be fired while scrolling (in events per seconds). A higher number yields better accuracy for code that is tracking the scroll position, but can lead to scroll performance problems due to the volume of information being send over the bridge. The default value is zero, which means the scroll event will be sent only once each time the view is scrolled.
  • scrollIndicatorInsets The amount by which the scroll view indicators are inset from the edges of the scroll view. This should normally be set to the same value as the contentInset. Defaults to {0, 0, 0, 0}.
  • scrollPerfTag Tag used to log scroll performance on this scroll view. Will force momentum events to be turned on (see sendMomentumEvents). This doesn't do anything out of the box and you need to implement a custom native FpsListener for it to be useful. platform android
  • scrollsToTop When true the scroll view scrolls to top when the status bar is tapped. The default value is true.
  • shouldRasterizeIOS 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.
  • showsHorizontalScrollIndicator When true, shows a horizontal scroll indicator.
  • showsVerticalScrollIndicator When true, shows a vertical scroll indicator.
  • snapToAlignment When snapToInterval is set, snapToAlignment will define the relationship of the the snapping to the scroll view. - start (the default) will align the snap at the left (horizontal) or top (vertical) - center will align the snap in the center - end will align the snap at the right (horizontal) or bottom (vertical)
  • snapToEnd Use in conjuction with snapToOffsets. By default, the end of the list counts as a snap offset. Set snapToEnd to false to disable this behavior and allow the list to scroll freely between its end and the last snapToOffsets offset. The default value is true.
  • snapToInterval When set, causes the scroll view to stop at multiples of the value of snapToInterval. This can be used for paginating through children that have lengths smaller than the scroll view. Used in combination with snapToAlignment and decelerationRate="fast". Overrides less configurable pagingEnabled prop.
  • snapToOffsets When set, causes the scroll view to stop at the defined offsets. This can be used for paginating through variously sized children that have lengths smaller than the scroll view. Typically used in combination with decelerationRate="fast". Overrides less configurable pagingEnabled and snapToInterval props.
  • snapToStart Use in conjuction with snapToOffsets. By default, the beginning of the list counts as a snap offset. Set snapToStart to false to disable this behavior and allow the list to scroll freely between its start and the first snapToOffsets offset. The default value is true.
  • stickyHeaderIndices An array of child indices determining which children get docked to the top of the screen when scrolling. For example passing stickyHeaderIndices={[0]} will cause the first child to be fixed to the top of the scroll view. This property is not supported in conjunction with horizontal={true}.
  • style Style
  • testID Used to locate this view in end-to-end tests.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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
  • zoomScale The current scale of the scroll view content. The default value is 1.0.

#recyclerViewBackedScrollView Source

recyclerViewBackedScrollView :: forall attrs_ attrs. Union attrs attrs_ (RecyclerViewBackedScrollViewProps) => Record attrs -> JSX

#recyclerViewBackedScrollView_ Source

#RefreshControlProps_optional Source

type RefreshControlProps_optional = (accessibilityActions :: Array String, accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessibilityViewIsModal :: Boolean, accessible :: Boolean, children :: Array JSX, collapsable :: Boolean, colors :: Array String, enabled :: Boolean, hasTVPreferredFocus :: Boolean, hitSlop :: Insets, importantForAccessibility :: String, isTVSelectable :: Boolean, key :: String, nativeID :: String, needsOffscreenAlphaCompositing :: Boolean, onAccessibilityAction :: Effect Unit, onAccessibilityTap :: Effect Unit, onLayout :: EffectFn1 LayoutChangeEvent Unit, onMagicTap :: Effect Unit, onMoveShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onMoveShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onRefresh :: Effect Unit, onResponderEnd :: EffectFn1 GestureResponderEvent Unit, onResponderGrant :: EffectFn1 GestureResponderEvent Unit, onResponderMove :: EffectFn1 GestureResponderEvent Unit, onResponderReject :: EffectFn1 GestureResponderEvent Unit, onResponderRelease :: EffectFn1 GestureResponderEvent Unit, onResponderStart :: EffectFn1 GestureResponderEvent Unit, onResponderTerminate :: EffectFn1 GestureResponderEvent Unit, onResponderTerminationRequest :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onTouchCancel :: EffectFn1 GestureResponderEvent Unit, onTouchEnd :: EffectFn1 GestureResponderEvent Unit, onTouchEndCapture :: EffectFn1 GestureResponderEvent Unit, onTouchMove :: EffectFn1 GestureResponderEvent Unit, onTouchStart :: EffectFn1 GestureResponderEvent Unit, pointerEvents :: String, progressBackgroundColor :: String, progressViewOffset :: Number, removeClippedSubviews :: Boolean, renderToHardwareTextureAndroid :: Boolean, shouldRasterizeIOS :: Boolean, size :: Number, style :: CSS, testID :: String, tintColor :: String, title :: String, titleColor :: String, tvParallaxMagnification :: Number, tvParallaxProperties :: { enabled :: Boolean, magnification :: Number, pressDelay :: Number, pressDuration :: Number, pressMagnification :: Number, shiftDistanceX :: Number, shiftDistanceY :: Number, tiltAngle :: Number }, tvParallaxShiftDistanceX :: Number, tvParallaxShiftDistanceY :: Number, tvParallaxTiltAngle :: Number)
  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • collapsable 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.
  • colors The colors (at least one) that will be used to draw the refresh indicator.
  • enabled Whether the pull to refresh functionality is enabled.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • importantForAccessibility 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.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onRefresh Called when the view starts refreshing.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • pointerEvents 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.
  • progressBackgroundColor The background color of the refresh indicator.
  • progressViewOffset Progress view top offset platform android
  • refreshing Whether the view should be indicating an active refresh.
  • removeClippedSubviews 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).
  • renderToHardwareTextureAndroid 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.
  • shouldRasterizeIOS 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.
  • size Size of the refresh indicator, see RefreshControl.SIZE.
  • testID Used to locate this view in end-to-end tests.
  • tintColor The color of the refresh indicator.
  • title The title displayed under the refresh indicator.
  • titleColor Title color.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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

#RefreshControlProps_required Source

type RefreshControlProps_required optional = (refreshing :: Boolean | optional)
  • accessibilityActions Provides an array of custom actions available for accessibility. platform ios
  • accessibilityComponentType 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
  • accessibilityElementsHidden A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. platform ios
  • accessibilityHint 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.
  • accessibilityIgnoresInvertColors https://facebook.github.io/react-native/docs/accessibility#accessibilityignoresinvertcolorsios platform ios
  • accessibilityLabel 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.
  • accessibilityLiveRegion 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
  • accessibilityRole Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
  • accessibilityStates Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
  • accessibilityTraits 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
  • accessibilityViewIsModal A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. platform ios
  • accessible When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
  • collapsable 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.
  • colors The colors (at least one) that will be used to draw the refresh indicator.
  • enabled Whether the pull to refresh functionality is enabled.
  • hasTVPreferredFocus (Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view. platform ios
  • hitSlop 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.
  • importantForAccessibility 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.
  • isTVSelectable (Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote. platform ios
  • nativeID Used to reference react managed views from native code.
  • needsOffscreenAlphaCompositing 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.
  • onAccessibilityAction When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action. platform ios
  • onAccessibilityTap When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture. platform ios
  • onLayout Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}.
  • onMagicTap When accessible is true, the system will invoke this function when the user performs the magic tap gesture. platform ios
  • onMoveShouldSetResponder Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
  • onMoveShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • onRefresh Called when the view starts refreshing.
  • onResponderEnd If the View returns true and attempts to become the responder, one of the following will happen:
  • onResponderGrant The View is now responding for touch events. This is the time to highlight and show the user what is happening
  • onResponderMove If the view is responding, the following handlers can be called: The user is moving their finger
  • onResponderReject Something else is the responder right now and will not release it
  • onResponderRelease Fired at the end of the touch, ie "touchUp"
  • onResponderTerminate 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)
  • onResponderTerminationRequest Something else wants to become responder. Should this view release the responder? Returning true allows release
  • onStartShouldSetResponder A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder: Does this view want to become responder on the start of a touch?
  • onStartShouldSetResponderCapture 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 onShouldSetResponderCapture. 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.
  • pointerEvents 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.
  • progressBackgroundColor The background color of the refresh indicator.
  • progressViewOffset Progress view top offset platform android
  • refreshing Whether the view should be indicating an active refresh.
  • removeClippedSubviews 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).
  • renderToHardwareTextureAndroid 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.
  • shouldRasterizeIOS 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.
  • size Size of the refresh indicator, see RefreshControl.SIZE.
  • testID Used to locate this view in end-to-end tests.
  • tintColor The color of the refresh indicator.
  • title The title displayed under the refresh indicator.
  • titleColor Title color.
  • tvParallaxMagnification (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
  • tvParallaxProperties (Apple TV only) Object with properties to control Apple TV parallax effects. platform ios
  • tvParallaxShiftDistanceX (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
  • tvParallaxShiftDistanceY (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
  • tvParallaxTiltAngle (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

#refreshControl Source

refreshControl :: forall attrs_ attrs. Union attrs attrs_ (RefreshControlProps_optional) => Record ((RefreshControlProps_required) attrs) -> JSX

#Route Source

type Route = { backButtonTitle :: Undefinable String, component :: Undefinable JSX, content :: Undefinable String, id :: Undefinable String, index :: Undefinable Number, message :: Undefinable String, onRightButtonPress :: Undefinable (Effect Unit), passProps :: Undefinable (Object Foreign), rightButtonTitle :: Undefinable String, title :: Undefinable String, wrapperStyle :: Undefinable Foreign }

#ScrollViewProps Source

type ScrollViewProps = (accessibilityActions :: Array String, accessibilityComponentType :: String, accessibilityElementsHidden :: Boolean, accessibilityHint :: String, accessibilityIgnoresInvertColors :: Boolean, accessibilityLabel :: String, accessibilityLiveRegion :: String, accessibilityRole :: String, accessibilityStates :: Array String, accessibilityTraits :: Array String, accessibilityViewIsModal :: Boolean, accessible :: Boolean, alwaysBounceHorizontal :: Boolean, alwaysBounceVertical :: Boolean, automaticallyAdjustContentInsets :: Boolean, bounces :: Boolean, bouncesZoom :: Boolean, canCancelContentTouches :: Boolean, centerContent :: Boolean, children :: Array JSX, collapsable :: Boolean, contentContainerStyle :: CSS, contentInset :: Insets, contentInsetAdjustmentBehavior :: String, contentOffset :: PointPropType, decelerationRate :: String, directionalLockEnabled :: Boolean, endFillColor :: String, hasTVPreferredFocus :: Boolean, hitSlop :: Insets, horizontal :: Boolean, importantForAccessibility :: String, indicatorStyle :: String, invertStickyHeaders :: Boolean, isTVSelectable :: Boolean, key :: String, keyboardDismissMode :: String, keyboardShouldPersistTaps :: String, maximumZoomScale :: Number, minimumZoomScale :: Number, nativeID :: String, needsOffscreenAlphaCompositing :: Boolean, nestedScrollEnabled :: Boolean, onAccessibilityAction :: Effect Unit, onAccessibilityTap :: Effect Unit, onContentSizeChange :: EffectFn2 Number Number Unit, onLayout :: EffectFn1 LayoutChangeEvent Unit, onMagicTap :: Effect Unit, onMomentumScrollBegin :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onMomentumScrollEnd :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onMoveShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onMoveShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onResponderEnd :: EffectFn1 GestureResponderEvent Unit, onResponderGrant :: EffectFn1 GestureResponderEvent Unit, onResponderMove :: EffectFn1 GestureResponderEvent Unit, onResponderReject :: EffectFn1 GestureResponderEvent Unit, onResponderRelease :: EffectFn1 GestureResponderEvent Unit, onResponderStart :: EffectFn1 GestureResponderEvent Unit, onResponderTerminate :: EffectFn1 GestureResponderEvent Unit, onResponderTerminationRequest :: EffectFn1 GestureResponderEvent Boolean, onScroll :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onScrollAnimationEnd :: Effect Unit, onScrollBeginDrag :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onScrollEndDrag :: EffectFn1 (NativeSyntheticEvent NativeScrollEvent) Unit, onStartShouldSetResponder :: EffectFn1 GestureResponderEvent Boolean, onStartShouldSetResponderCapture :: EffectFn1 GestureResponderEvent Boolean, onTouchCancel :: EffectFn1 GestureResponderEvent Unit, onTouchEnd :: EffectFn1 GestureResponderEvent Unit, onTouchEndCapture :: EffectFn1 GestureResponderEvent Unit, onTouchMove :: EffectFn1 GestureResponderEvent Unit, onTouchStart