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.
A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader.
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.
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.
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.
Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
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.
Represents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, it contains range information (minimum, current, and maximum).
A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
Specifies whether fonts should scale to respect Text Size accessibility settings.
The default is true.
Can tell TextInput to automatically capitalize certain characters. characters: all characters, words: first letter of each word sentences: first letter of each sentence (default) none: don't auto capitalize anything
https://facebook.github.io/react-native/docs/textinput.html#autocapitalize
Determines which content to suggest on auto complete, e.g.username.
To disable auto complete, use off.
Android Only
The following values work on Android only:
usernamepasswordemailnametelstreet-addresspostal-codecc-numbercc-csccc-expcc-exp-monthcc-exp-yearoffIf false, disables auto-correct. The default value is true.
If true, focuses the input on componentDidMount. The default value is false.
If true, the text field will blur when submitted. The default value is true.
If true, caret is hidden. The default value is false.
enum('never', 'while-editing', 'unless-editing', 'always') When the clear button should appear on the right side of the text view
If true, clears the text field automatically when editing begins
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.
If true, context menu is hidden. The default value is false.
Determines the types of data converted to clickable URLs in the text input.
Only valid if multiline={true} and editable={false}.
By default no data types are detected.
You can provide one type or an array of many types.
Possible values for dataDetectorTypes are:
'phoneNumber''link''address''calendarEvent''none''all'Provides an initial value that will change when the user starts typing. Useful for simple use-cases where you don't want to deal with listening to events and updating the value prop to keep the controlled state in sync.
When false, if there is a small amount of space available around a text input (e.g. landscape orientation on a phone), the OS may choose to have the user edit the text inside of a full screen text input mode. When true, this feature is disabled and users will always edit the text directly inside of the text input. Defaults to false.
If false, text is not editable. The default value is true.
If true, the keyboard disables the return key when there is no text and automatically enables it when there is text. The default value is false.
Whether this View should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
(Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view.
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.
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.
Determines whether the individual fields in your app should be included in a
view structure for autofill purposes on Android API Level 26+. Defaults to auto.
To disable auto complete, use off.
Android Only
The following values work on Android only:
auto - let Android decideno - not important for autofillnoExcludeDescendants - this view and its children aren't important for autofillyes - is important for autofillyesExcludeDescendants - this view is important for autofill but its children aren'tIf defined, the provided image resource will be rendered on the left.
Padding between the inline image, if any, and the text input itself.
Used to connect to an InputAccessoryView. Not part of react-natives documentation, but present in examples and code. See https://facebook.github.io/react-native/docs/inputaccessoryview.html for more information.
(Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote.
Determines the color of the keyboard.
enum("default", 'numeric', 'email-address', "ascii-capable", 'numbers-and-punctuation', 'url', 'number-pad', 'phone-pad', 'name-phone-pad', 'decimal-pad', 'twitter', 'web-search', 'visible-password') Determines which keyboard to open, e.g.numeric. The following values work across platforms: - default - numeric - email-address - phone-pad The following values work on iOS: - ascii-capable - numbers-and-punctuation - url - number-pad - name-phone-pad - decimal-pad - twitter - web-search The following values work on Android: - visible-password
Specifies largest possible scale a font can reach when allowFontScaling is enabled. Possible values:
= 1: sets the maxFontSizeMultiplier of this node to this value
Limits the maximum number of characters that can be entered. Use this instead of implementing the logic in JS to avoid flicker.
If true, the text input can be multiple lines. The default value is false.
Used to reference react managed views from native code.
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.
Sets the number of lines for a TextInput. Use it with multiline set to true to be able to fill the lines.
When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action.
When accessibile is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).
When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture.
Callback that is called when the text input is blurred
Callback that is called when the text input's text changes.
Callback that is called when the text input's text changes. Changed text is passed as an argument to the callback handler.
Callback that is called when the text input's content size changes.
This will be called with
{ nativeEvent: { contentSize: { width, height } } }.
Only called for multiline text inputs.
Callback that is called when text input ends.
Callback that is called when the text input is focused
Callback that is called when a key is pressed.
This will be called with
{ nativeEvent: { key: keyValue } }
where keyValue is 'Enter' or 'Backspace' for respective keys and the typed-in character otherwise including ' ' for space.
Fires before onChange callbacks. Note: on Android only the inputs from soft keyboard are handled, not the hardware keyboard inputs.
Invoked on mount and layout changes with
{nativeEvent: { layout: {x, y, width, height}}}.
When accessible is true, the system will invoke this function when the user performs the magic tap gesture.
Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.
However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.
If the View returns true and attempts to become the responder, one of the following will happen:
The View is now responding for touch events. This is the time to highlight and show the user what is happening
The user is moving their finger
Something else is the responder right now and will not release it
Fired at the end of the touch, ie "touchUp"
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)
Something else wants to become responder. Should this view release the responder? Returning true allows release
Invoked on content scroll with
{ nativeEvent: { contentOffset: { x, y } } }.
May also contain other properties from ScrollEvent but on Android contentSize is not provided for performance reasons.
Callback that is called when the text input selection is changed.
Does this view want to become responder on the start of a touch?
onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.
However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.
Callback that is called when the text input's submit button is pressed.
Callback that is called on new text input with the argument
{ nativeEvent: { text, previousText, range: { start, end } } }.
This prop requires multiline={true} to be set.
Provide rules for your password. For example, say you want to require a password with at least eight characters consisting of a mix of uppercase and lowercase letters, at least one number, and at most two consecutive characters. "required: upper; required: lower; required: digit; max-consecutive: 2; minlength: 8;"
The string that will be rendered before text input has been entered
The text color of the placeholder string
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.
If true, allows TextInput to pass touch events to the parent component.
This allows components to be swipeable from the TextInput on iOS,
as is the case on Android by default.
If false, TextInput always asks to handle the input (except when disabled).
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).
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.
Sets the return key to the label. Use it instead of returnKeyType.
enum('default', 'go', 'google', 'join', 'next', 'route', 'search', 'send', 'yahoo', 'done', 'emergency-call') Determines how the return key should look.
If false, scrolling of the text view will be disabled. The default value is true. Only works with multiline={true}
If true, the text input obscures the text entered so that sensitive text like passwords stay secure. The default value is false.
If true, all text will automatically be selected on focus
The start and end of the text input's selection. Set start and end to the same value to position the cursor.
The highlight (and cursor on ios) color of the text input
See DocumentSelectionState.js, some state that is responsible for maintaining selection information for a document
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.
When false, it will prevent the soft keyboard from showing when the field is focused. The default value is true
If false, disables spell-check style (i.e. red underlines). The default value is inherited from autoCorrect
Styles
Used to locate this view in end-to-end tests
Vertically align text when multiline is set to true
Set text break strategy on Android API Level 23+, possible values are simple, highQuality, balanced The default value is simple.
Give the keyboard and the system information about the expected semantic meaning for the content that users enter.
For iOS 11+ you can set textContentType to username or password to
enable autofill of login details from the device keychain.
For iOS 12+ newPassword can be used to indicate a new password input the
user may want to save in the keychain, and oneTimeCode can be used to indicate
that a field can be autofilled by a code arriving in an SMS.
To disable autofill, set textContentType to none.
Possible values for textContentType are:
'none''URL''addressCity''addressCityAndState''addressState''countryName''creditCardNumber''emailAddress''familyName''fullStreetAddress''givenName''jobTitle''location''middleName''name''namePrefix''nameSuffix''nickname''organizationName''postalCode''streetAddressLine1''streetAddressLine2''sublocality''telephoneNumber''username''password''newPassword''oneTimeCode'(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.
(Apple TV only) Object with properties to control Apple TV parallax effects.
(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.
(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.
(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.
The color of the textInput underline.
The value to show for the text input. TextInput is a controlled component, which means the native value will be forced to match this value prop if provided. For most uses this works great, but in some cases this may cause flickering - one common cause is preventing edits by keeping value the same. In addition to simply setting the same value, either set editable={false}, or set/update maxLength to prevent unwanted edits without flicker.
Provides an array of custom actions available for accessibility.