TextInput
一个用于通过键盘向应用中输入文本的基础组件。Props 提供了多种功能的可配置性,例如自动纠错、自动首字母大写、占位符文本,以及不同的键盘类型,比如数字键盘。
最基本的用法是放置一个 TextInput,并订阅 onChangeText 事件来读取用户输入。也可以订阅其他事件,例如 onSubmitEditing 和 onFocus。下面是一个最小示例:
原生元素暴露了两个方法 .focus() 和 .blur(),可用于以编程方式让 TextInput 获得或失去焦点。
请注意,某些 props 仅在 multiline={true/false} 时可用。此外,只作用于元素单侧的边框样式(例如 borderBottomColor、borderLeftWidth 等)在 multiline=true 时不会生效。要实现相同效果,可以将 TextInput 包裹在 View 中:
TextInput 默认在其视图底部有一条边框。这个边框的内边距由系统提供的背景图像设置,且无法更改。避免这一问题的方法有两种:要么不要显式设置高度,这样系统会负责在正确位置显示边框;要么将 underlineColorAndroid 设置为透明,以不显示边框。
请注意,在 Android 上对输入框中的文本进行选择时,应用的活动 windowSoftInputMode 参数可能会被更改为 adjustResize。当键盘处于激活状态时,这可能会导致 position: 'absolute' 的组件出现问题。为了避免这种行为,可以在 AndroidManifest.xml 中指定 windowSoftInputMode( https://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-nameaddress-line1address-line2birthdate-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-numbercountrycurrent-passwordemailfamily-namegiven-namehonorific-prefixhonorific-suffixnamenew-passwordoffone-time-codepostal-codestreet-addresstelusername
以下值仅适用于 iOS:
cc-family-name(iOS 17+)cc-given-name(iOS 17+)cc-middle-name(iOS 17+)cc-name(iOS 17+)cc-type(iOS 17+)nicknameorganizationorganization-titleurl
以下值仅适用于 Android:
gendername-familyname-givenname-middlename-middle-initialname-prefixname-suffixpasswordpassword-newpostal-addresspostal-address-countrypostal-address-extendedpostal-address-extended-postal-codepostal-address-localitypostal-address-regionsms-otptel-country-codetel-devicetel-nationalusername-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,则禁用键盘快捷键(撤销/重做和复制按钮)。
| 类型 | 默认值 |
|---|---|
| bool | false |
cursorColor Android
提供此属性时,它会设置组件中光标(或“插入点”)的颜色。不同于 selectionColor 的行为,光标颜色将独立于文本选择框的颜色进行设置。
| 类型 |
|---|
| color |
disableFullscreenUI Android
当为 false 时,如果文本输入周围可用空间较小(例如手机横屏时),系统可能会选择让用户在全屏文本输入模式中编辑文本。当为 true 时,此功能将被禁用,用户将始终直接在文本输入中编辑文本。默认值为 false。
| 类型 |
|---|
| bool |
editable
如果为 false,文本不可编辑。默认值为 true。
| 类型 |
|---|
| bool |
enablesReturnKeyAutomatically iOS
如果为 true,当没有文本时键盘会禁用回车键,并在有文本时自动启用它。默认值为 false。
| 类型 |
|---|
| bool |
enterKeyHint
决定回车键应显示的文本。优先级高于 returnKeyType prop。
以下值适用于所有平台:
donenextsearchsendgo
仅 Android
以下值仅适用于 Android:
previous
仅 iOS
以下值仅适用于 iOS:
enter
| 类型 |
|---|
| enum('enter', 'done', 'next', 'previous', 'search', 'send', 'go') |
importantForAutofill Android
告知操作系统在 Android API Level 26+ 上,你应用中的单个字段是否应包含在用于自动填充的视图结构中。可选值为 auto、no、noExcludeDescendants、yes 和 yesExcludeDescendants。默认值为 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。
支持以下值:
nonetextdecimalnumerictelsearchemailurl
| 类型 |
|---|
| enum('decimal', 'email', 'none', 'numeric', 'search', 'tel', 'text', 'url') |
keyboardAppearance iOS
决定键盘的颜色。
| 类型 |
|---|
| enum('default', 'light', 'dark') |
keyboardType
决定打开哪种键盘,例如 numeric。
可在此处查看所有类型的截图 here。
以下值适用于所有平台:
defaultnumber-paddecimal-padnumericemail-addressphone-padurl
仅 iOS
以下值仅适用于 iOS:
ascii-capablenumbers-and-punctuationname-phone-padtwitterweb-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+ 上设置换行策略。可选值为 none、standard、hangul-word 和 push-out。
| 类型 | 默认值 |
|---|---|
enum('none', 'standard', 'hangul-word', 'push-out') | 'none' |
lineBreakModeIOS iOS
在 iOS 上设置换行模式。可选值为 wordWrapping、char、clip、head、middle 和 tail。
| 类型 | 默认值 |
|---|---|
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。
跨平台
以下值适用于所有平台:
donegonextsearchsend
仅 Android
以下值仅适用于 Android:
noneprevious
仅 iOS
以下值仅适用于 iOS:
defaultemergency-callgooglejoinrouteyahoo
| 类型 |
|---|
| enum('done', 'go', 'next', 'search', 'send', 'none', 'previous', 'default', 'emergency-call', 'google', 'join', 'route', 'yahoo') |
rejectResponderTermination iOS
如果为 true,允许 TextInput 将触摸事件传递给父组件。这使得诸如 SwipeableListView 之类的组件在 iOS 上可以像 Android 默认那样从 TextInput 中滑动。如果为 false,TextInput 总是请求处理输入(禁用时除外)。默认值为 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 系统在粘贴后不会额外插入一个空格,也不会在剪切或删除后删除一个或两个空格。
| 类型 | 默认值 |
|---|---|
| bool | true |
spellCheck iOS
如果为 false,则禁用拼写检查样式(即红色下划线)。默认值继承自 autoCorrect。
| 类型 |
|---|
| bool |
submitBehavior
当按下回车键时,
对于单行输入:
'newline'默认值为'blurAndSubmit'undefined默认值为'blurAndSubmit'
对于多行输入:
'newline'会添加一个换行符undefined默认值为'newline'
对于单行和多行输入:
'submit'只会发送提交事件,不会使输入失去焦点'blurAndSubmit'会同时使输入失去焦点并发送提交事件
| 类型 |
|---|
| enum('submit', 'blurAndSubmit', 'newline') |
textAlign
将输入文本对齐到输入框的左侧、居中或右侧。
textAlign 的可选值为:
leftcenterright
| 类型 |
|---|
| enum('left', 'center', 'right') |
textContentType iOS
向键盘和系统提供有关用户输入内容预期语义含义的信息。
autoComplete 提供相同功能,并且适用于所有平台。你可以使用 Platform.select 来实现不同平台的行为。
请避免同时使用 textContentType 和 autoComplete。为了向后兼容,当两者都设置时,textContentType 优先。
你可以将 textContentType 设置为 username 或 password,以启用从设备钥匙串自动填充登录详情。
newPassword 可用于表示用户可能想要保存在钥匙串中的新密码输入,而 oneTimeCode 可用于表示某个字段可以通过短信中收到的验证码自动填充。
要禁用自动填充,请将 textContentType 设置为 none。
textContentType 的可选值为:
noneaddressCityaddressCityAndStateaddressStatebirthdate(iOS 17+)birthdateDay(iOS 17+)birthdateMonth(iOS 17+)birthdateYear(iOS 17+)countryNamecreditCardExpiration(iOS 17+)creditCardExpirationMonth(iOS 17+)creditCardExpirationYear(iOS 17+)creditCardFamilyName(iOS 17+)creditCardGivenName(iOS 17+)creditCardMiddleName(iOS 17+)creditCardName(iOS 17+)creditCardNumbercreditCardSecurityCode(iOS 17+)creditCardType(iOS 17+)emailAddressfamilyNamefullStreetAddressgivenNamejobTitlelocationmiddleNamenamenamePrefixnameSuffixnewPasswordnicknameoneTimeCodeorganizationNamepasswordpostalCodestreetAddressLine1streetAddressLine2sublocalitytelephoneNumberURLusername
| 类型 |
|---|
| 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 文档。
如果密码生成对话框没有出现,请确保:
- 已启用 AutoFill:Settings → Passwords & Accounts → 将 AutoFill Passwords 切换为“On”;
- 正在使用 iCloud Keychain:Settings → Apple ID → iCloud → Keychain → 将 iCloud Keychain 切换为“On”。
| 类型 |
|---|
| string |
style
请注意,并非所有 Text 样式都受支持,以下是不受支持内容的不完整列表:
borderLeftWidthborderTopWidthborderRightWidthborderBottomWidthborderTopLeftRadiusborderTopRightRadiusborderBottomRightRadiusborderBottomLeftRadius
| 类型 |
|---|
| Text |
textBreakStrategy Android
在 Android API Level 23+ 上设置文本换行策略,可选值为 simple、highQuality、balanced。默认值为 highQuality。
| 类型 |
|---|
| enum('simple', 'highQuality', 'balanced') |
underlineColorAndroid Android
TextInput 下划线的颜色。
| 类型 |
|---|
| color |
value
要显示在文本输入中的值。TextInput 是一个受控组件,这意味着如果提供了该值,原生值将被强制与此 value prop 保持一致。对于大多数用法,这都很好用,但在某些情况下可能会导致闪烁——一个常见原因是通过保持值不变来阻止编辑。除了设置相同的值外,还可以设置 editable={false},或者设置/更新 maxLength,以在不闪烁的情况下阻止不需要的编辑。
| 类型 |
|---|
| string |
方法
.focus()
focus();
使原生输入请求焦点。
.blur()
blur();
使原生输入失去焦点。
clear()
clear();
从 TextInput 中移除所有文本。
isFocused()
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。