Version: 下个版本

Input

输入框。该组件是原生组件,使用时请注意相关限制

参考文档

类型#

ComponentType<InputProps>

示例代码#

class App extends Component {
render () {
return (
<View className='example-body'>
<Text>可以自动聚焦的 input</Text>
<Input type='text' placeholder='将会获取焦点' focus/>
<Text>控制最大输入长度的 input</Text>
<Input type='text' placeholder='最大输入长度为 10' maxlength='10'/>
<Text>数字输入的 input</Text>
<Input type='number' placeholder='这是一个数字输入框'/>
<Text>密码输入的 input</Text>
<Input type='password' password placeholder='这是一个密码输入框'/>
<Text>带小数点的 input</Text>
<Input type='digit' placeholder='带小数点的数字键盘'/>
<Text>身份证输入的 input</Text>
<Input type='idcard' placeholder='身份证输入键盘'/>
<Text>控制占位符颜色的 input</Text>
<Input type='text' placeholder='占位符字体是红色的' placeholderStyle='color:red'/>
</View>
)
}
}

InputProps#

参数类型默认值必填说明
valuestring输入框的初始内容
type"number" | "text" | "idcard" | "digit""text"input 的类型
passwordboolean是否是密码类型
placeholderstring输入框为空时占位符
placeholderStylestring指定 placeholder 的样式
placeholderClassstring"input-placeholder"指定 placeholder 的样式类
disabledboolean是否禁用
maxlengthnumber140最大输入长度,设置为 -1 的时候不限制最大长度
cursorSpacingnumber0指定光标与键盘的距离,单位 px 。取 input 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离
autoFocusbooleanfalse(即将废弃,请直接使用 focus )自动聚焦,拉起键盘
focusboolean获取焦点
confirmType"send" | "search" | "next" | "go" | "done"done设置键盘右下角按钮的文字
confirmHoldbooleanfalse点击键盘右下角按钮时是否保持键盘不收起
cursornumber指定focus时的光标位置
selectionStartnumber-1光标起始位置,自动聚集时有效,需与selection-end搭配使用
selectionEndnumber-1光标结束位置,自动聚集时有效,需与selection-start搭配使用
adjustPositionbooleantrue键盘弹起时,是否自动上推页面
holdKeyboardbooleanfalsefocus 时,点击页面的时候不收起键盘
onInputBaseEventOrigFunction<inputEventDetail>当键盘输入时,触发input事件,event.detail = {value, cursor, keyCode},处理函数可以直接 return 一个字符串,将替换输入框的内容。
onFocusBaseEventOrigFunction<inputForceEventDetail>输入框聚焦时触发,event.detail = { value, height },height 为键盘高度
onBlurBaseEventOrigFunction<inputValueEventDetail>输入框失去焦点时触发

event.detail = {value: value}
onConfirmBaseEventOrigFunction<inputValueEventDetail>点击完成按钮时触发

event.detail = {value: value}
onKeyboardHeightChangeBaseEventOrigFunction<onKeyboardHeightChangeEventDetail>键盘高度发生变化的时候触发此事件

event.detail = {height: height, duration: duration}

API 支持度#

API微信小程序H5React Native
InputProps.value✔️✔️✔️
InputProps.type✔️✔️✔️(部分支持)
InputProps.password✔️✔️✔️
InputProps.placeholder✔️✔️✔️
InputProps.placeholderStyle✔️
InputProps.placeholderClass✔️
InputProps.disabled✔️✔️✔️
InputProps.maxlength✔️✔️✔️
InputProps.cursorSpacing✔️
InputProps.autoFocus✔️
InputProps.focus✔️✔️✔️
InputProps.confirmType✔️✔️
InputProps.confirmHold✔️
InputProps.cursor✔️✔️
InputProps.selectionStart✔️✔️
InputProps.selectionEnd✔️✔️
InputProps.adjustPosition✔️
InputProps.holdKeyboard✔️
InputProps.onInput✔️✔️✔️
InputProps.onFocus✔️✔️✔️
InputProps.onBlur✔️✔️✔️
InputProps.onConfirm✔️(借用Form 组件onSubmit事件来替代)✔️
InputProps.onKeyboardHeightChange✔️

inputEventDetail#

参数类型说明
valuestring输入值
cursornumber光标位置
keyCodenumber键值

注意:React-Native 端 inputEventDetail 仅实现参数 value,若需实时获取光标位置则可通过 onSelectionChange 实现。

inputForceEventDetail#

参数类型说明
valuestring输入值
heightnumber键盘高度

inputValueEventDetail#

参数类型说明
valuestring输入值

onKeyboardHeightChangeEventDetail#

参数类型说明
heightnumber键盘高度
durationnumber持续时间

API 支持度#

API微信小程序H5React Native
Input✔️✔️✔️