A foundational component for inputting text into the app via a keyboard. Props provide configurability for several features, such as auto-correction, auto-capitalization, placeholder text, and different keyboard types, such as a numeric keypad.
The simplest use case is to plop down a TextInput and subscribe to the
onChangeText events to read the user input. There are also other events,
such as onSubmitEditing and onFocus that can be subscribed to. A simple
example:
Note that some props are only available with multiline={true/false}:
Can tell TextInput to automatically capitalize certain characters.
If false, disables auto-correct. The default value is true.
If true, focuses the input on componentDidMount. The default value is false.
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.
If false, text is not editable. The default value is true.
Determines which keyboard to open, e.g.numeric.
The following values work across platforms: - default - numeric - email-address
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.
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 text input ends.
Callback that is called when the text input is focused
Invoked on mount and layout changes with {x, y, width, height}.
Callback that is called when the text input's submit button is pressed. Invalid if multiline={true} is specified.
The string that will be rendered before text input has been entered
The text color of the placeholder string
If true, the text input obscures the text entered so that sensitive text like passwords stay secure. The default value is false.
Styles
Used to locate this view in end-to-end tests
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.
If true, the text field will blur when submitted. The default value is true.
When the clear button should appear on the right side of the text view
If true, clears the text field automatically when editing begins
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.
Determines the color of the keyboard.
Sets the number of lines for a TextInput. Use it with multiline set to true to be able to fill the lines.
Callback that is called when a key is pressed. Pressed key value is passed as an argument to the callback handler. Fires before onChange callbacks.
Determines how the return key should look.
If true, all text will automatically be selected on focus
See DocumentSelectionState.js, some state that is responsible for maintaining selection information for a document
Set the position of the cursor from where editing will begin.
Aligns text vertically within the TextInput.
The color of the textInput underline.