TextInput
TextInput 是一个允许用户在应用中通过键盘输入文本的基本组件。本组件的属性提供了多种特性的配置,譬如自动完成、自动大小写、占位文字,以及多种不同的键盘类型(如纯数字键盘)等等。
最简单的用法就是丢一个TextInput
到应用里,然后订阅它的onChangeText
事件来读取用户的输入。注意,从 TextInput 里取值这就是目前唯一的做法!也就是使用在onChangeText
中用setState
把用户的输入写入到 state 中,然后在需要取值的地方从 this.state 中取出值。它还有一些其它的事件,譬如onSubmitEditing
和onFocus
。一个简单的例子如下:
Two methods exposed via the native element are .focus() and .blur() that will focus or blur the TextInput programmatically.
注意有些属性仅在multiline
为 true 或者为 false 的时候有效。此外,当multiline=false
时,为元素的某一个边添加边框样式(例如:borderBottomColor
,borderLeftWidth
等)将不会生效。为了能够实现效果你可以使用一个View
来包裹TextInput
:
TextInput
在安卓上默认有一个底边框,同时会有一些 padding。如果要想使其看起来和 iOS 上尽量一致,则需要设置padding: 0
。
又又,在安卓上长按选择文本会导致windowSoftInputMode
设置变为adjustResize
,这样可能导致绝对定位的元素被键盘给顶起来。要解决这一问题你需要在 AndroidManifest.xml 中明确指定合适的windowSoftInputMode
(https://developer.android.com/guide/topics/manifest/activity-element.html)值,或是自己监听事件来处理布局变化。
Reference
Props
allowFontScaling
控制字体是否要根据系统的“字体大小”辅助选项来进行缩放。默认值为true
。
类型 | 必需 |
---|---|
bool | No |
autoCapitalize
控制 TextInput 是否要自动将特定字符切换为大写,This property is not supported by some keyboard types such as name-phone-pad
.
characters
: 所有的字符。words
: 每个单词的第一个字符。sentences
: 每句话的第一个字符(默认)。none
: 不切换。
类型 | 必需 |
---|---|
enum('none', 'sentences', 'words', 'characters') | No |
autoComplete
Specifies autocomplete hints for the system, so it can provide autofill. On Android, the system will aways attempt to offer autofill by using heuristics to identify the type of content. To disable autocomplete, set autoComplete
to off
.
Possible values for autoComplete
are:
off
username
password
email
name
tel
street-address
postal-code
cc-number
cc-csc
cc-exp
cc-exp-month
cc-exp-year
类型 | 必需 | 平台 |
---|---|---|
enum('off', 'username', 'password', 'email', 'name', 'tel', 'street-address', 'postal-code', 'cc-number', 'cc-csc', 'cc-exp', 'cc-exp-month', 'cc-exp-year') | 否 | Android |
autoCorrect
如果为 false,会关闭拼写自动修正。默认值是 true。
类型 | 必需 |
---|---|
bool | No |
autoFocus
如果为 true,在componentDidMount
后会获得焦点。默认值为 false。
类型 | 必需 |
---|---|
bool | No |
blurOnSubmit
如果为 true,文本框会在提交的时候失焦。对于单行输入框默认值为 true,多行则为 false。注意:对于多行输入框来说,如果将blurOnSubmit
设为 true,则在按下回车键时就会失去焦点同时触发onSubmitEditing
事件,而不会换行。
类型 | 必需 |
---|---|
bool | No |
caretHidden
如果为 true,则隐藏光标。默认值为 false。
类型 | 必需 |
---|---|
bool | No |
clearButtonMode
是否要在文本框右侧显示“清除”按钮。仅在单行模式下可用。默认值为never
。
类型 | 必需 | 平台 |
---|---|---|
enum('never', 'while-editing', 'unless-editing', 'always') | No | iOS |
clearTextOnFocus
如果为 true,每次开始输入的时候都会清除文本框的内容。
类型 | 必需 | 平台 |
---|---|---|
bool | No | iOS |
contextMenuHidden
If true
, context menu is hidden. The default value is false
.
类型 | 必需 |
---|---|
bool | No |
dataDetectorTypes
设置 text input 内能被转化为可点击 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') | No | iOS |
defaultValue
提供一个文本框中的初始值。当用户开始输入的时候,值就可以改变。在一些简单的使用情形下,如果你不想用监听消息然后更新 value 属性的方法来保持属性和状态同步的时候,就可以用 defaultValue 来代替。
类型 | 必需 |
---|---|
string | No |
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.
类型 |
---|
color |
disableFullscreenUI
当值为 false 时, 如果 text input 的周围有少量可用空间的话(比如说,当手机横过来 时),操作系统可能会将这个 text input 设置为全屏模式。当值为 true 时, 这个特性不可用,text input 就是普通的模式。默认为 false。
类型 | 必需 | 平台 |
---|---|---|
bool | No | Android |
editable
如果为 false,文本框是不可编辑的。默认值为 true。
类型 | 必需 |
---|---|
bool | No |
enablesReturnKeyAutomatically
如果为 true,键盘会在文本框内没有文字的时候禁用确认按钮。默认值为 false。
类型 | 必需 | 平台 |
---|---|---|
bool | No | iOS |
importantForAutofill
Say the 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
, 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.
类型 | Required | 平台 |
---|---|---|
enum('auto', 'no', 'noExcludeDescendants', 'yes', 'yesExcludeDescendants') | No | Android |
inlineImageLeft
指定一个图片放置在左侧。图片必须放置在/android/app/src/main/res/drawable
目录下,经过编译后按如下形式引用(无路径无后缀):
<TextInput
inlineImageLeft='search_icon'
/>
类型 | 必需 | 平台 |
---|---|---|
string | No | Android |
inlineImagePadding
给放置在左侧的图片设置 padding 样式。
类型 | 必需 | 平台 |
---|---|---|
number | No | Android |
keyboardAppearance
指定键盘的颜色。
类型 | 必需 | 平台 |
---|---|---|
enum('default', 'light', 'dark') | No | iOS |
keyboardType
决定弹出何种软键盘类型,譬如numeric
(纯数字键盘)。
See screenshots of all the types here.
这些值在所有平台都可用:
default
number-pad
decimal-pad
numeric
email-address
phone-pad
下面的值仅 iOS 可用:
ascii-capable
numbers-and-punctuation
url
name-phone-pad
twitter
web-search
下面的值仅 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') | No |
maxLength
限制文本框中最多的字符数。使用这个属性而不用 JS 逻辑去实现,可以避免闪烁的现象。
类型 | 必需 |
---|---|
number | No |