跳到主要内容
版本:0.81

TextInput

一个用于通过键盘在应用中输入文本的基础组件。Props 提供了多种功能的可配置性,例如自动纠正、自动首字母大写、占位符文本以及不同的键盘类型,例如数字键盘。

最基本的用法是放置一个 TextInput,并订阅 onChangeText 事件来读取用户输入。还可以订阅其他事件,例如 onSubmitEditingonFocus。下面是一个最小示例:

原生元素暴露了两个方法 .focus().blur(),可以通过编程方式让 TextInput 获得焦点或失去焦点。

请注意,某些 props 只有在 multiline={true/false} 时可用。此外,只应用于元素单侧的边框样式(例如 borderBottomColorborderLeftWidth 等)在 multiline=true 时不会生效。若要达到相同效果,可以将 TextInput 包裹在一个 View 中:

TextInput 默认在其视图底部有一条边框。这条边框的内边距由系统提供的背景图像设置,且无法更改。避免这种情况的方案要么是不显式设置 height,此时系统会负责将边框显示在正确位置;要么通过将 underlineColorAndroid 设为透明来隐藏边框。

请注意,在 Android 上对输入框执行文本选择可能会将应用 activity 的 windowSoftInputMode 参数改为 adjustResize。这可能会导致在键盘激活时,具有 position: 'absolute' 的组件出现问题。要避免这种行为,可以在 AndroidManifest.xml 中指定 windowSoftInputModehttps://developer.android.com/guide/topics/manifest/activity-element.html),或者使用原生代码以编程方式控制此参数。


参考

Props

View Props

继承 View Props


allowFontScaling

指定字体是否应缩放以适配“文字大小”辅助功能设置。默认值为 true

类型
bool

autoCapitalize

告诉 TextInput 自动将某些字符大写。某些键盘类型不支持此属性,例如 name-phone-pad

  • characters:所有字符。
  • words:每个单词的首字母。
  • sentences:每个句子的首字母(默认)。
  • none:不自动将任何内容大写。
类型
enum('none', 'sentences', 'words', 'characters')

autoComplete

为系统指定自动完成提示,以便提供自动填充。在 Android 上,系统会始终尝试通过启发式方法识别内容类型来提供自动填充。要禁用自动完成,请将 autoComplete 设为 off

以下值适用于所有平台:

  • 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

以下值仅适用于 iOS:

  • 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

以下值仅适用于 Android:

  • 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
类型
enum('additional-name', 'address-line1', 'address-line2', 'birthdate-day', 'birthdate-full', 'birthdate-month', 'birthdate-year', 'cc-csc', 'cc-exp', 'cc-exp-day', 'cc-exp-month', 'cc-exp-year', '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', 'cc-family-name', 'cc-given-name', 'cc-middle-name', 'cc-name', 'cc-type', 'nickname', 'organization', 'organization-title', 'url', '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

如果为 false,则禁用自动纠正。默认值为 true

类型
bool

autoFocus

如果为 true,则自动聚焦输入框。默认值为 false

类型
bool

blurOnSubmit

已弃用。 请注意,submitBehavior 现在取代了 blurOnSubmit,并会覆盖 blurOnSubmit 定义的任何行为。参见 submitBehavior

如果为 true,提交时文本字段将失去焦点。单行字段的默认值为 true,多行字段的默认值为 false。请注意,对于多行字段,将 blurOnSubmit 设为 true 意味着按回车键会使字段失去焦点并触发 onSubmitEditing 事件,而不是在字段中插入换行符。

类型
bool

caretHidden

如果为 true,则隐藏插入光标。默认值为 false

类型
bool

clearButtonMode
iOS

清除按钮应何时显示在文本视图右侧。此属性仅支持单行 TextInput 组件。默认值为 never

类型
enum('never', 'while-editing', 'unless-editing', 'always')

clearTextOnFocus
iOS

如果为 true,则在开始编辑时自动清空文本字段。

类型
bool

contextMenuHidden

如果为 true,则隐藏上下文菜单。默认值为 false

类型
bool

dataDetectorTypes
iOS

确定在文本输入中转换为可点击 URL 的数据类型。仅在 multiline={true}editable={false} 时有效。默认情况下不会检测任何数据类型。

你可以提供一种类型或多种类型的数组。

dataDetectorTypes 的可选值为:

  • 'phoneNumber'
  • 'link'
  • 'address'
  • 'calendarEvent'
  • 'none'
  • 'all'
类型
enum('phoneNumber', 'link', 'address', 'calendarEvent', 'none', 'all'), ,array of enum('phoneNumber', 'link', 'address', 'calendarEvent', 'none', 'all')

defaultValue

提供一个初始值,当用户开始输入时该值会发生变化。适用于不想通过监听事件并更新 value prop 来保持受控状态同步的场景。

类型
string

disableKeyboardShortcuts
iOS

如果为 true,则禁用键盘快捷键(撤销/重做和复制按钮)。

类型默认值
boolfalse

cursorColor
Android

提供后会设置组件中光标(或“插入光标”)的颜色。与 selectionColor 的行为不同,光标颜色将独立于文本选择框的颜色设置。

类型
color

disableFullscreenUI
Android

当为 false 时,如果文本输入周围可用空间很小(例如手机横屏),操作系统可能会选择让用户在全屏文本输入模式中编辑文本。当为 true 时,此功能会被禁用,用户将始终直接在文本输入框内编辑文本。默认值为 false

类型
bool

editable

如果为 false,文本不可编辑。默认值为 true

类型
bool

enablesReturnKeyAutomatically
iOS

如果为 true,当没有文本时键盘会禁用回车键,并在有文本时自动启用它。默认值为 false

类型
bool

enterKeyHint

确定应在回车键上显示什么文本。其优先级高于 returnKeyType prop。

以下值适用于所有平台:

  • done
  • next
  • search
  • send
  • go

仅限 Android

以下值仅适用于 Android:

  • previous

仅限 iOS

以下值仅适用于 iOS:

  • enter
类型
enum('enter', 'done', 'next', 'previous', 'search', 'send', 'go')

importantForAutofill
Android

告知操作系统在 Android API Level 26+ 上,应用中的单个字段是否应包含在用于自动填充的视图结构中。可选值为 autononoExcludeDescendantsyesyesExcludeDescendants。默认值为 auto

  • auto:让 Android 系统使用其启发式方法判断该视图是否对自动填充重要。
  • no:该视图对自动填充不重要。
  • noExcludeDescendants:该视图及其子级对自动填充不重要。
  • yes:该视图对自动填充重要。
  • yesExcludeDescendants:该视图对自动填充重要,但其子级对自动填充不重要。
类型
enum('auto', 'no', 'noExcludeDescendants', 'yes', 'yesExcludeDescendants')

inlineImageLeft
Android

如果已定义,提供的图片资源将渲染在左侧。图片资源必须位于 /android/app/src/main/res/drawable 中,并按如下方式引用:

<TextInput
inlineImageLeft='search_icon'
/>
类型
string

inlineImagePadding
Android

内联图片(如果有)与文本输入本身之间的内边距。

类型
number

inputAccessoryViewID
iOS

一个可选标识符,用于将自定义 InputAccessoryView 关联到此文本输入。该 InputAccessoryView 会在此文本输入获得焦点时显示在键盘上方。

类型
string

inputAccessoryViewButtonLabel
iOS

一个可选标签,用于覆盖默认的 InputAccessoryView 按钮标签。

默认情况下,默认按钮标签未进行本地化。请使用此属性提供本地化版本。

类型
string

inputMode

其作用类似于 HTML 中的 inputmode 属性,用于确定打开哪种键盘,例如 numeric,并且其优先级高于 keyboardType

支持以下值:

  • none
  • text
  • decimal
  • numeric
  • tel
  • search
  • email
  • url
类型
enum('decimal', 'email', 'none', 'numeric', 'search', 'tel', 'text', 'url')

keyboardAppearance
iOS

确定键盘的颜色。

类型
enum('default', 'light', 'dark')

keyboardType

确定要打开哪种键盘,例如 numeric

查看所有类型的截图 这里

以下值适用于所有平台:

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

仅限 iOS

以下值仅适用于 iOS:

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

仅限 Android

以下值仅适用于 Android:

  • visible-password
类型
enum('default', 'email-address', 'numeric', 'phone-pad', 'ascii-capable', 'numbers-and-punctuation', 'url', 'number-pad', 'name-phone-pad', 'decimal-pad', 'twitter', 'web-search', 'visible-password')

lineBreakStrategyIOS
iOS

在 iOS 14+ 上设置换行策略。可选值为 nonestandardhangul-wordpush-out

类型默认值
enum('none', 'standard', 'hangul-word', 'push-out')'none'

lineBreakModeIOS
iOS

设置 iOS 上的换行模式。可选值为 wordWrappingcharclipheadmiddletail

类型默认值
enum('wordWrapping', 'char', 'clip', 'head', 'middle', 'tail')'wordWrapping'

maxFontSizeMultiplier

指定在启用 allowFontScaling 时字体可达到的最大缩放比例。可选值:

  • null/undefined(默认):从父节点或全局默认值(0)继承
  • 0:无最大值,忽略父级/全局默认值
  • >= 1:将此节点的 maxFontSizeMultiplier 设为该值
类型
number

maxLength

限制可输入的最大字符数。请使用此属性代替在 JS 中实现逻辑,以避免闪烁。

类型
number

multiline

如果为 true,文本输入可以为多行。默认值为 false

备注

需要注意的是,这会在 iOS 上将文本对齐到顶部,而在 Android 上则居中。将 textAlignVertical 设为 top 可在两个平台上获得相同的行为。

类型
bool

numberOfLines

备注

iOS 上的 numberOfLines 仅在新架构中可用

设置 TextInput 的最大行数。将其与 multiline 设为 true 一起使用,以便能够填充多行。

类型
number

onBlur

文本输入失去焦点时调用的回调。

注意:如果你试图从 nativeEvent 中访问 text 值,请记住你得到的结果值可能是 undefined,这可能会导致意外错误。如果你想获取 TextInput 的最后一个值,可以使用 onEndEditing 事件,它会在编辑完成时触发。

类型
({nativeEvent: TargetEvent}) => void

onChange

文本输入文本发生变化时调用的回调。

类型
({nativeEvent: {eventCount, target, text}}) => void

onChangeText

文本输入文本发生变化时调用的回调。更改后的文本会作为单个字符串参数传递给回调处理函数。

类型
function

onContentSizeChange

文本输入内容大小发生变化时调用的回调。

仅在多行文本输入时调用。

类型
({nativeEvent: {contentSize: {width, height} }}) => void

onEndEditing

文本输入结束时调用的回调。

类型
function

onPressIn

触摸开始时调用的回调。

类型
({nativeEvent: PressEvent}) => void

onPressOut

触摸释放时调用的回调。

类型
({nativeEvent: PressEvent}) => void

onFocus

文本输入获得焦点时调用的回调。

类型
({nativeEvent: TargetEvent}) => void

onKeyPress

按下按键时调用的回调。此回调会传入一个对象,其中 keyValue 对于相应按键是 'Enter''Backspace',否则为输入的字符,包括空格的 ' '。在 onChange 回调之前触发。注意:在 Android 上仅处理来自软键盘的输入,不处理硬件键盘输入。

类型
({nativeEvent: {key: keyValue} }) => void

onLayout

在挂载和布局变化时触发。

类型
({nativeEvent: LayoutEvent}) => void

onScroll

在内容滚动时触发。也可能包含 ScrollEvent 的其他属性,但在 Android 上出于性能原因不提供 contentSize

类型
({nativeEvent: {contentOffset: {x, y} }}) => void

onSelectionChange

文本输入的选择范围发生变化时调用的回调。

类型
({nativeEvent: {selection: {start, end} }}) => void

onSubmitEditing

文本输入的提交按钮被按下时调用的回调。

类型
({nativeEvent: {text, eventCount, target}}) => void

请注意,在 iOS 上使用 keyboardType="phone-pad" 时不会调用此方法。


placeholder

在输入文本之前将要渲染的字符串。

类型
string

placeholderTextColor

占位符字符串的文本颜色。

类型
color

readOnly

如果为 true,文本不可编辑。默认值为 false

类型
bool

returnKeyLabel
Android

将回车键设置为该标签。请用它代替 returnKeyType

类型
string

returnKeyType

确定回车键应如何显示。在 Android 上你也可以使用 returnKeyLabel

跨平台

以下值适用于所有平台:

  • done
  • go
  • next
  • search
  • send

仅限 Android

以下值仅适用于 Android:

  • none
  • previous

仅限 iOS

以下值仅适用于 iOS:

  • default
  • emergency-call
  • google
  • join
  • route
  • yahoo
类型
enum('done', 'go', 'next', 'search', 'send', 'none', 'previous', 'default', 'emergency-call', 'google', 'join', 'route', 'yahoo')

rejectResponderTermination
iOS

如果为 true,则允许 TextInput 将触摸事件传递给父组件。这使得诸如 SwipeableListView 之类的组件在 iOS 上也能像 Android 默认那样从 TextInput 上滑动。如果为 falseTextInput 总是请求处理输入(除非被禁用)。默认值为 true

类型
bool

rows
Android

设置 TextInput 的行数。将其与 multiline 设为 true 一起使用,以便能够填充多行。

类型
number

scrollEnabled
iOS

如果为 false,将禁用文本视图的滚动。默认值为 true。仅适用于 multiline={true}

类型
bool

secureTextEntry

如果为 true,文本输入会隐藏已输入的文本,以确保密码等敏感文本的安全。默认值为 false。不适用于 multiline={true}

类型
bool

selection

文本输入选择范围的起始和结束位置。将起始和结束设为相同值即可定位光标。

类型
object: {start: number,end: number}

selectionColor

文本输入的高亮、选择手柄和光标颜色。

类型
color

selectionHandleColor
Android

设置选择手柄的颜色。与 selectionColor 不同,它允许单独自定义选择手柄颜色,而不受选择区域颜色影响。

类型
color

selectTextOnFocus

如果为 true,获得焦点时会自动选择所有文本。

类型
bool

showSoftInputOnFocus

当为 false 时,字段获得焦点时将阻止软键盘显示。默认值为 true

类型
bool

smartInsertDelete
iOS

如果为 false,iOS 系统在粘贴操作后不会额外插入一个空格,也不会在剪切或删除操作后删除一个或两个空格。

类型默认值
booltrue

spellCheck
iOS

如果为 false,则禁用拼写检查样式(即红色下划线)。默认值继承自 autoCorrect

类型
bool

submitBehavior

当按下回车键时,

对于单行输入:

  • 'newline' 默认等同于 'blurAndSubmit'
  • undefined 默认等同于 'blurAndSubmit'

对于多行输入:

  • 'newline' 会插入换行符
  • undefined 默认等同于 'newline'

对于单行和多行输入都适用:

  • 'submit' 只会发送提交事件,不会使输入失去焦点
  • 'blurAndSubmit' 会同时使输入失去焦点并发送提交事件
类型
enum('submit', 'blurAndSubmit', 'newline')

textAlign

将输入文本对齐到输入框的左侧、居中或右侧。

textAlign 的可选值为:

  • left
  • center
  • right
类型
enum('left', 'center', 'right')

textContentType
iOS

向键盘和系统提供有关用户输入内容预期语义含义的信息。

备注

autoComplete 提供相同功能,且适用于所有平台。你可以使用 Platform.select 来区分平台行为。

避免同时使用 textContentTypeautoComplete。为了向后兼容,当两者都设置时,textContentType 优先。

你可以将 textContentType 设为 usernamepassword,以启用从设备钥匙串自动填充登录信息。

newPassword 可用于表示用户可能想要保存到钥匙串中的新密码输入,oneTimeCode 可用于表示某个字段可以通过短信中的验证码自动填充。

要禁用自动填充,请将 textContentType 设为 none

textContentType 的可选值为:

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

passwordRules
iOS

在 iOS 上将 textContentType 设为 newPassword 时,我们可以让系统知道密码的最低要求,从而生成一个满足这些要求的密码。要创建符合 PasswordRules 的有效字符串,请查看 Apple 文档

如果密码生成对话框没有出现,请确保:

  • 已启用自动填充:设置密码与账户 → 将 自动填充密码 开关设为“开启”;
  • 正在使用 iCloud 钥匙串:设置Apple IDiCloud钥匙串 → 将 iCloud 钥匙串 开关设为“开启”。
类型
string

style

请注意,并非所有 Text 样式都受支持,以下是不支持项的不完整列表:

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

样式

类型
Text

textBreakStrategy
Android

在 Android API Level 23+ 上设置文本换行策略,可选值为 simplehighQualitybalanced。默认值为 highQuality

类型
enum('simple', 'highQuality', 'balanced')

underlineColorAndroid
Android

TextInput 下划线的颜色。

类型
color

value

文本输入中显示的值。TextInput 是一个受控组件,这意味着如果提供了此 value prop,原生值将被强制与之匹配。对于大多数用例,这都能很好地工作,但在某些情况下可能会导致闪烁——一个常见原因是通过保持 value 不变来阻止编辑。除了设置相同的值外,还可以设置 editable={false},或者设置/更新 maxLength 以防止不必要的编辑而不产生闪烁。

类型
string

方法

.focus()

React TSX
focus();

使原生输入框请求焦点。

.blur()

React TSX
blur();

使原生输入框失去焦点。

clear()

React TSX
clear();

移除 TextInput 中的所有文本。


isFocused()

React TSX
isFocused(): boolean;

如果输入框当前已获得焦点,则返回 true;否则返回 false

已知问题

  • react-native#19096:不支持 Android 的 onKeyPreIme
  • react-native#19366:通过返回键关闭 Android 键盘后再调用 .focus(),不会再次弹出键盘。
  • react-native#26799:当 keyboardType="email-address"keyboardType="phone-pad" 时,不支持 Android 的 secureTextEntry