TextInput

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 most basic 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 minimal example:

import React from 'react';
import {StyleSheet, TextInput} from 'react-native';
import {SafeAreaView, SafeAreaProvider} from 'react-native-safe-area-context';

const TextInputExample = () => {
  const [text, onChangeText] = React.useState('Useless Text');
  const [number, onChangeNumber] = React.useState('');

  return (
    <SafeAreaProvider>
      <SafeAreaView>
        <TextInput
          style={styles.input}
          onChangeText={onChangeText}
          value={text}
        />
        <TextInput
          style={styles.input}
          onChangeText={onChangeNumber}
          value={number}
          placeholder="useless placeholder"
          keyboardType="numeric"
        />
      </SafeAreaView>
    </SafeAreaProvider>
  );
};

const styles = StyleSheet.create({
  input: {
    height: 40,
    margin: 12,
    borderWidth: 1,
    padding: 10,
  },
});

export default TextInputExample;

Two methods exposed via the native element are .focus() and .blur() that will focus or blur the TextInput programmatically.

Note that some props are only available with multiline={true/false}. Additionally, border styles that apply to only one side of the element (e.g., borderBottomColor, borderLeftWidth, etc.) will not be applied if multiline=true. To achieve the same effect, you can wrap your TextInput in a View:

import React from 'react';
import {TextInput, StyleSheet} from 'react-native';
import {SafeAreaView, SafeAreaProvider} from 'react-native-safe-area-context';

const MultilineTextInputExample = () => {
  const [value, onChangeText] = React.useState('Useless Multiline Placeholder');

  // If you type something in the text box that is a color,
  // the background will change to that color.
  return (
    <SafeAreaProvider>
      <SafeAreaView
        style={{
          flex: 1,
          backgroundColor: value.toLowerCase(),
        }}>
        <TextInput
          editable
          multiline
          numberOfLines={4}
          maxLength={40}
          onChangeText={text => onChangeText(text)}
          value={value}
          style={styles.textInput}
        />
      </SafeAreaView>
    </SafeAreaProvider>
  );
};

const styles = StyleSheet.create({
  textInput: {
    padding: 10,
    borderColor: '#000',
    borderWidth: 1,
    margin: 12,
  },
});

export default MultilineTextInputExample;

TextInput has a border at the bottom of its view by default. This border has its padding set by the background image provided by the system, and it cannot be changed. Solutions to avoid this are to either not set height explicitly, in which case the system will take care of displaying the border in the correct position, or to not display the border by setting underlineColorAndroid to transparent.

Note that on Android performing text selection in an input can change the app's activity windowSoftInputMode param to adjustResize. This may cause issues with components that have position: 'absolute' while the keyboard is active. To avoid this behavior either specify windowSoftInputMode in AndroidManifest.xml ( https://developer.android.com/guide/topics/manifest/activity-element.html ) or control this param programmatically with native code.

Reference

Props

View Props

Inherits View Props.

allowFontScaling

Specifies whether fonts should scale to respect Text Size accessibility settings. The default is true.

aria-labelledby AndroidVega

Identifies the element that labels the element it is applied to. The value of aria-labelledby should match the nativeID of the related element:

<View>
  <Text nativeID="formLabel">Label for Input Field</Text>
  <TextInput aria-label="input" aria-labelledby="formLabel" />
</View>

autoCapitalize

Tells TextInput to automatically capitalize certain characters. This property is not supported by some keyboard types such as name-phone-pad.

• characters: all characters.
• words: first letter of each word.
• sentences: first letter of each sentence (default).
• none: don't auto capitalize anything.

autoComplete

Specifies autocomplete hints for the system, so it can provide autofill. On Android, the system will always attempt to offer autofill by using heuristics to identify the type of content. To disable autocomplete, set autoComplete to off.

The following values work across iOS, and Android platforms:

• additional-name
• address-line1
• address-line2
• birthdate-day (iOS 17+)
• birthdate-full (iOS 17+)
• birthdate-month (iOS 17+)
• birthdate-year (iOS 17+)
• cc-csc (iOS 17+)
• cc-exp (iOS 17+)
• cc-exp-day (iOS 17+)
• cc-exp-month (iOS 17+)
• cc-exp-year (iOS 17+)
• cc-number
• country
• current-password
• email
• family-name
• given-name
• honorific-prefix
• honorific-suffix
• name
• new-password
• off
• one-time-code
• postal-code
• street-address
• tel
• username

iOS

The following values work on iOS only:

• cc-family-name (iOS 17+)
• cc-given-name (iOS 17+)
• cc-middle-name (iOS 17+)
• cc-name (iOS 17+)
• cc-type (iOS 17+)
• nickname
• organization
• organization-title
• url

Android

The following values work on Android only:

• gender
• name-family
• name-given
• name-middle
• name-middle-initial
• name-prefix
• name-suffix
• password
• password-new
• postal-address
• postal-address-country
• postal-address-extended
• postal-address-extended-postal-code
• postal-address-locality
• postal-address-region
• sms-otp
• tel-country-code
• tel-device
• tel-national
• username-new

autoCorrect

If false, disables auto-correct. The default value is true.

autoFocus

If true, focuses the input. The default value is false.

auxOptions Vega + TV Only

Optional set of key:value pairs, to provide additional context to a TV-based keyboard.

e.g: Include a title in your keyboard auxOptions="title:Search for Videos"

Set wifi special keyboard options auxOptions="wifi:true"

Show validation error message using wifi keyboard auxOptions="title:Enter Wireless Password,wifi:true"

keyboardUiMode Vega + TV Only

Determines the display mode for on-screen keyboard window, e.g.half-screen.

The following values work across Vega and TV platforms:

• 'system-default'
• 'half-screen'
• 'full-screen'

Note: At the moment, floating is only supported on TV platforms and not on Vega.

blurOnSubmit

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.

caretHidden Vega Not Available

If true, caret is hidden. The default value is false.

clearButtonMode iOS Vega Not Available

When the clear button should appear on the right side of the text view. This property is supported only for single-line TextInput component. The default value is never.

clearTextOnFocus iOS Vega Not Available

If true, clears the text field automatically when editing begins.

contextMenuHidden Vega Not Available

If true, context menu is hidden. The default value is false.

dataDetectorTypes iOS Vega Not Available

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'

defaultValue

Provides an initial value that will change when the user starts typing. Useful for use-cases where you do not want to deal with listening to events and updating the value prop to keep the controlled state in sync.

disableKeyboardShortcuts iOS

If true, the keyboard shortcuts (undo/redo and copy buttons) are disabled.

cursorColor Android

When provided it will set the color of the cursor (or "caret") in the component. Unlike the behavior of selectionColor the cursor color will be set independently from the color of the text selection box.

disableFullscreenUI Android Vega Not Available

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.

editable

If false, text is not editable. The default value is true.

enablesReturnKeyAutomatically iOS Vega

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.

enterKeyHint

Determines what text should be shown to the return key. Has precedence over the returnKeyType prop.

The following values work across platforms:

• done
• next
• search
• send
• go

Android Only

The following values work on Android only:

• previous

iOS Only

The following values work on iOS only:

• enter

importantForAutofill Android Vega Not Available

Tells the operating system whether the individual fields in your app should be included in a view structure for autofill purposes on Android API Level 26+. Possible values are auto, no, noExcludeDescendants, yes, and yesExcludeDescendants. The default value is auto.

• auto: Let the Android System use its heuristics to determine if the view is important for autofill.
• no: This view isn't important for autofill.
• noExcludeDescendants: This view and its children aren't important for autofill.
• yes: This view is important for autofill.
• yesExcludeDescendants: This view is important for autofill, but its children aren't important for autofill.

inlineImageLeft Android Vega Not Available

If defined, the provided image resource will be rendered on the left. The image resource must be inside /android/app/src/main/res/drawable and referenced like

<TextInput
 inlineImageLeft='search_icon'
/>

inlineImagePadding Android Vega Not Available

Padding between the inline image, if any, and the text input itself.

inputAccessoryViewID iOS Vega Not Available

An optional identifier which links a custom InputAccessoryView to this text input. The InputAccessoryView is rendered above the keyboard when this text input is focused.

inputAccessoryViewButtonLabel iOS

An optional label that overrides the default InputAccessoryView button label.

By default, the default button label is not localized. Use this property to provide a localized version.

inputMode

Works like the inputmode attribute in HTML, it determines which keyboard to open, e.g. numeric and has precedence over keyboardType.

Support the following values:

• none
• text
• decimal
• numeric
• tel
• search
• email
• url

keyboardAppearance iOS Vega Not Available

Determines the color of the keyboard.

keyboardType

Determines which keyboard to open, e.g.numeric.

See screenshots of all the types here.

The following values work across platforms:

• default
• number-pad
• decimal-pad
• numeric
• email-address
• phone-pad
• url

iOS Only

The following values work on iOS only:

• ascii-capable
• numbers-and-punctuation
• name-phone-pad
• twitter
• web-search

Android Only

The following values work on Android only:

• visible-password

Vega TV Only

The following values work on Vega for TV only:

• pin

lineBreakStrategyIOS iOS Vega Not Available

Set line break strategy on iOS 14+. Possible values are none, standard, hangul-word and push-out.

lineBreakModeIOS iOS

Set line break mode on iOS. Possible values are wordWrapping, char, clip, head, middle and tail.

maxFontSizeMultiplier Vega Not Available

Specifies largest possible scale a font can reach when allowFontScaling is enabled. Possible values:

• null/undefined (default): inherit from the parent node or the global default (0)
• 0: no max, ignore parent/global default
• >= 1: sets the maxFontSizeMultiplier of this node to this value

maxLength

Limits the maximum number of characters that can be entered. Use this instead of implementing the logic in JS to avoid flicker.

multiline

If true, the text input can be multiple lines. The default value is false.

numberOfLines Vega

Sets the maximum number of lines for a TextInput. Use it with multiline set to true to be able to fill the lines.

onBlur

Callback that is called when the text input is blurred.

onChange

Callback that is called when the text input's text changes.

onChangeText

Callback that is called when the text input's text changes. Changed text is passed as a single string argument to the callback handler.

onContentSizeChange Vega + TV Not Available

Callback that is called when the text input's content size changes.

Only called for multiline text inputs.

onEndEditing

Callback that is called when text input ends.

onPressIn Vega Not Available

Callback that is called when a touch is engaged.

onPressOut Vega Not Available

Callback that is called when a touch is released.

onFocus

Callback that is called when the text input is focused.

enableSynchronousFocusEventsKepler

When set to true, onFocus/onBlur events will be dispatched synchronously, blocking the UI Thread until the JavaScript execution of onFocus/onBlur completes.

onKeyPress

Callback that is called when a key is pressed. This will be called with object 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. On Vega it is called when the characters are pressed on the soft keyboard and 'Enter' or 'Backspace' are not handled.

onLayout

Invoked on mount and on layout changes.

onScroll

Invoked on content scroll. May also contain other properties from ScrollEvent but on Android contentSize is not provided for performance reasons.

onSelectionChange

Callback that is called when the text input selection is changed.

onSubmitEditing

Callback that is called when the text input's submit button is pressed.

Note that on iOS this method isn't called when using keyboardType="phone-pad".

Note: On Vega platform, onSubmitEditing event also contains submitAction. The value of submitAction is the action string(similar to returnKeyType) or any numeric value which is set by the user in auxOptions prop. Note: On Vega platform, onSubmitEditing only works when returnKeyType is also set. Set returnKeyType to work around this. Note: On Vega platform, onSubmitEditing will sometimes not fire on the first mount if autofocus is true. Set autofocus to false to work around this.

placeholder

The string that will be rendered before text input has been entered.

placeholderTextColor

The text color of the placeholder string.

readOnly

If true, text is not editable. The default value is false.

returnKeyLabel Android Vega Not Available

Sets the return key to the label. Use it instead of returnKeyType.

returnKeyType

Determines how the return key should look. On Android you can also use returnKeyLabel.

Cross platform

The following values work across platforms:

• done
• go
• next
• search
• send

Android Only

The following values work on Android only:

• none
• previous

iOS Only

The following values work on iOS only:

• default
• emergency-call
• google
• join
• route
• yahoo

rejectResponderTermination iOS Vega Not Available

If true, allows TextInput to pass touch events to the parent component. This allows components such as SwipeableListView 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). The default value is true.

rows Android Vega

Sets the number of lines for a TextInput. Use it with multiline set to true to be able to fill the lines.

scrollEnabled iOS Vega Not Available

If false, scrolling of the text view will be disabled. The default value is true. Only works with multiline={true}.

secureTextEntry

If true, the text input obscures the text entered so that sensitive text like passwords stay secure. The default value is false. Does not work with multiline={true}.

selection

The start and end of the text input's selection. Set start and end to the same value to position the cursor.

selectionColor

The highlight, selection handle and cursor color of the text input.

selectionHandleColor Android Vega Not Available

Sets the color of the selection handle. Unlike selectionColor, it allows the selection handle color to be customized independently of the selection's color.

selectTextOnFocus

If true, all text will automatically be selected on focus.

showSoftInputOnFocus

When false, it will prevent the soft keyboard from showing when the field is focused. The default value is true.

Note: On Vega, when autoFocus is set to true, showSoftInputOnFocus will not prevent soft keyboard from opening on first mount, regardless of its value. As a workaround, remove autoFocus or set autoFocus to false.

smartInsertDelete iOS

If false, the iOS system will not insert an extra space after a paste operation neither delete one or two spaces after a cut or delete operation.

spellCheck iOS Vega Not Available

If false, disables spell-check style (i.e. red underlines). The default value is inherited from autoCorrect.

submitBehavior

When the return key is pressed,

For single line inputs:

• 'newline' defaults to 'blurAndSubmit'
• undefined defaults to 'blurAndSubmit'

For multiline inputs:

• 'newline' adds a newline
• undefined defaults to 'newline'

For both single line and multiline inputs:

• 'submit' will only send a submit event and not blur the input
• 'blurAndSubmit' will both blur the input and send a submit event

textAlign

Align the input text to the left, center, or right sides of the input field.

Possible values for textAlign are:

• left
• center
• right

textContentType iOS Vega Not Available

Give the keyboard and the system information about the expected semantic meaning for the content that users enter.

You can set textContentType to username or password to enable autofill of login details from the device keychain.

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
• addressCity
• addressCityAndState
• addressState
• birthdate (iOS 17+)
• birthdateDay (iOS 17+)
• birthdateMonth (iOS 17+)
• birthdateYear (iOS 17+)
• countryName
• creditCardExpiration (iOS 17+)
• creditCardExpirationMonth (iOS 17+)
• creditCardExpirationYear (iOS 17+)
• creditCardFamilyName (iOS 17+)
• creditCardGivenName (iOS 17+)
• creditCardMiddleName (iOS 17+)
• creditCardName (iOS 17+)
• creditCardNumber
• creditCardSecurityCode (iOS 17+)
• creditCardType (iOS 17+)
• emailAddress
• familyName
• fullStreetAddress
• givenName
• jobTitle
• location
• middleName
• name
• namePrefix
• nameSuffix
• newPassword
• nickname
• oneTimeCode
• organizationName
• password
• postalCode
• streetAddressLine1
• streetAddressLine2
• sublocality
• telephoneNumber
• URL
• username

passwordRules iOS Vega Not Available

When using textContentType as newPassword on iOS we can let the OS know the minimum requirements of the password so that it can generate one that will satisfy them. In order to create a valid string for PasswordRules take a look to the Apple Docs.

style

Note that not all Text styles are supported, an incomplete list of what is not supported includes:

• borderLeftWidth
• borderTopWidth
• borderRightWidth
• borderBottomWidth
• borderTopLeftRadius
• borderTopRightRadius
• borderBottomRightRadius
• borderBottomLeftRadius

Styles

textBreakStrategy Android Vega Not Available

Set text break strategy on Android API Level 23+, possible values are simple, highQuality, balanced The default value is highQuality.

underlineColorAndroid Android Vega Not Available

The color of the TextInput underline.

the same functionality is provided by underlineColorKepler

underlineColorKepler

The color of the TextInput underline.

value

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 setting the same value, either set editable={false}, or set/update maxLength to prevent unwanted edits without flicker.

Methods

.focus()

focus();

Makes the native input request focus.

.blur()

blur();

Makes the native input lose focus.

Note: Recently a bug fix has been made to the blur() command, it was to fix an issue where Focus were not being cleared from native view component. App might found different experience on focus navigation after blur() is called. For instances, given the following composition of components

[Button 1]

[Text Input]

[Button 2]

After invoking .blur() on text input, if Dpad Down is pressed, prior to the fix, focus will go to [Button 2], after the fix, focus will go to [Button 1]

clear()

clear();

Removes all text from the TextInput.

isFocused()

isFocused(): boolean;

Returns true if the input is currently focused; false otherwise.

Known issues

• react-native#19096: Doesn't support Android's onKeyPreIme.
• react-native#19366: Calling .focus() after closing Android's keyboard via back button doesn't bring keyboard up again.
• react-native#26799: Doesn't support Android's secureTextEntry when keyboardType="email-address" or keyboardType="phone-pad".

Last updated: May 13, 2026