React NativeTextInput
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}:
Edit on GitHubProps #
autoCapitalize enum('none', 'sentences', 'words', 'characters') #
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
autoCorrect bool #
If false, disables auto-correct. The default value is true.
autoFocus bool #
If true, focuses the input on componentDidMount. The default value is false.
defaultValue string #
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.
editable bool #
If false, text is not editable. The default value is true.
keyboardType enum("default", 'numeric', 'email-address', "ascii-capable", 'numbers-and-punctuation', 'url', 'number-pad', 'phone-pad', 'name-phone-pad', 'decimal-pad', 'twitter', 'web-search') #
Determines which keyboard to open, e.g.numeric.
The following values work across platforms: - default - numeric - email-address
maxLength number #
Limits the maximum number of characters that can be entered. Use this instead of implementing the logic in JS to avoid flicker.
multiline bool #
If true, the text input can be multiple lines. The default value is false.
onBlur function #
Callback that is called when the text input is blurred
onChange function #
Callback that is called when the text input's text changes.
onChangeText function #
Callback that is called when the text input's text changes. Changed text is passed as an argument to the callback handler.
onEndEditing function #
Callback that is called when text input ends.
onFocus function #
Callback that is called when the text input is focused
onLayout function #
Invoked on mount and layout changes with {x, y, width, height}.
onSubmitEditing function #
Callback that is called when the text input's submit button is pressed. Invalid if multiline={true} is specified.
placeholder string #
The string that will be rendered before text input has been entered
placeholderTextColor string #
The text color of the placeholder string
secureTextEntry bool #
If true, the text input obscures the text entered so that sensitive text like passwords stay secure. The default value is false.
style Text#style #
Styles
testID string #
Used to locate this view in end-to-end tests
value string #
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.
iosblurOnSubmit bool #
If true, the text field will blur when submitted. The default value is true for single-line fields and false for multiline fields. Note that for multiline fields, setting blurOnSubmit to true means that pressing return will blur the field and trigger the onSubmitEditing event instead of inserting a newline into the field.
iosclearButtonMode enum('never', 'while-editing', 'unless-editing', 'always') #
When the clear button should appear on the right side of the text view
iosclearTextOnFocus bool #
If true, clears the text field automatically when editing begins
iosenablesReturnKeyAutomatically bool #
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.
ioskeyboardAppearance enum('default', 'light', 'dark') #
Determines the color of the keyboard.
androidnumberOfLines number #
Sets the number of lines for a TextInput. Use it with multiline set to true to be able to fill the lines.
iosonKeyPress function #
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.
iosreturnKeyType enum('default', 'go', 'google', 'join', 'next', 'route', 'search', 'send', 'yahoo', 'done', 'emergency-call') #
Determines how the return key should look.
iosselectTextOnFocus bool #
If true, all text will automatically be selected on focus
iosselectionState DocumentSelectionState #
See DocumentSelectionState.js, some state that is responsible for maintaining selection information for a document
androidtextAlign enum('start', 'center', 'end') #
Set the position of the cursor from where editing will begin.
androidtextAlignVertical enum('top', 'center', 'bottom') #
Aligns text vertically within the TextInput.
androidunderlineColorAndroid string #
The color of the textInput underline.