输入框。

属性说明

属性名 类型 默认值 说明 平台差异说明
value String 输入框的初始内容
type String text input 的类型 H5 暂未支持动态切换请使用 v-if 进行整体切换
password Boolean false 是否是密码类型
placeholder String 输入框为空时占位符
placeholder-style String 指定 placeholder 的样式
placeholder-class String “input-placeholder” 指定 placeholder 的样式类
disabled Boolean false 是否禁用
maxlength Number 140 最大输入长度,设置为 -1 的时候不限制最大长度
cursor-spacing Number 0 指定光标与键盘的距离,单位 px 。取 input 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离 App、微信小程序、百度小程序、QQ小程序
focus Boolean false 获取焦点。 在 H5 平台能否聚焦以及软键盘是否跟随弹出,取决于当前浏览器本身的实现。
confirm-type String done 设置键盘右下角按钮的文字,仅在 type=”text” 时生效。 微信小程序、App、H5
confirm-hold Boolean false 点击键盘右下角按钮时是否保持键盘不收起 App、微信小程序、支付宝小程序、百度小程序、QQ小程序
cursor Number 指定focus时的光标位置
selection-start Number -1 光标起始位置,自动聚集时有效,需与selection-end搭配使用
selection-end Number -1 光标结束位置,自动聚集时有效,需与selection-start搭配使用
adjust-position Boolean true 键盘弹起时,是否自动上推页面 App-Android(vue 页面 softinputMode 为 adjustResize 时无效)、微信小程序、百度小程序、QQ小程序
hold-keyboard boolean false focus时,点击页面的时候不收起键盘 微信小程序2.8.2
@input EventHandle 当键盘输入时,触发input事件,event.detail = {value} 差异见下方 Tips
@focus EventHandle 输入框聚焦时触发,event.detail = { value, height },height 为键盘高度 仅微信小程序、App(2.2.3+) 、QQ小程序支持 height
@blur EventHandle 输入框失去焦点时触发,event.detail = {value: value}
@confirm EventHandle 点击完成按钮时触发,event.detail = {value: value}
@keyboardheightchange eventhandle 键盘高度发生变化的时候触发此事件,event.detail = {height: height, duration: duration} 微信小程序2.7.0

Tips

  • input 事件处理函数可以直接 return 一个字符串,将替换输入框的内容。仅微信小程序支持。
  • 如果遇到 value 属性设置不生效的问题参考:组件属性设置不生效解决办法
  • input 组件上有默认的 min-height 样式,如果 min-height 的值大于 height 的值那么 height 样式无效。

    type 有效值

    | 值 | 说明 | 平台差异说明 | | :—- | :—- | :—- | | text | 文本输入键盘 | | | number | 数字输入键盘 | 均支持,app-vue下可以输入浮点数,app-nvue和小程序平台下只能输入整数。注意iOS上app-vue弹出的数字键盘并非9宫格方式 | | idcard | 身份证输入键盘 | 微信、支付宝、百度、QQ小程序 | | digit | 带小数点的数字键盘 | App的nvue页面、微信、支付宝、百度、头条、QQ小程序 |

注意事项

  • 原html规范中input不仅是输入框,还有radio、checkbox、时间、日期、文件选择功能。在uni-app和小程序规范中,input仅仅是输入框。其他功能uni-app有单独的组件或API:radio组件checkbox组件时间选择日期选择图片选择视频选择多媒体文件选择(含图片视频)通用文件选择
  • 小程序平台,number 类型只支持输入整型数字。微信开发者工具上体现不出效果,请使用真机预览。
  • 如果需要在小程序平台输入浮点型数字,请使用 digit 类型。
  • 小程序端input在置焦时,会表现为原生控件,此时会层级变高。如需前端组件遮盖input,需让input失焦,或使用cover-view等覆盖原生控件的方案,参考。具体来讲,阿里小程序的input为text且置焦为原生控件;微信、头条、QQ所有input置焦均为原生控件;百度小程序置焦时仍然是非原生的。也可以参考原生控件文档
  • input组件若不想弹出软键盘,可设置为disable
  • 插件市场有各种类型的模拟键盘,比如车牌键盘、身份证键盘,可去插件市场搜索 键盘
  • 搜索框ui组件,可参考uni ui的search组件或封装好的页面模板。详见
  • uni-app插件市场有输入文字后自动提示候选的组件,可搜索 autocomplete 查看。

    confirm-type 有效值

    | 值 | 说明 | 平台差异说明 | | :—- | :—- | :—- | | send | 右下角按钮为“发送” | 微信、支付宝、百度小程序、app-nvue、app-vue和h5(2.9.9+,且要求设备webview内核Chrome81+、Safari13.7+) | | search | 右下角按钮为“搜索” | | | next | 右下角按钮为“下一个” | 微信、支付宝、百度小程序、app-nvue、app-vue和h5(2.9.9+,且要求设备webview内核Chrome81+、Safari13.7+) | | go | 右下角按钮为“前往” | | | done | 右下角按钮为“完成” | 微信、支付宝、百度小程序、app-nvue、app-vue和h5(2.9.9+,且要求设备webview内核Chrome81+、Safari13.7+) |

  • App平台的nvue页面,如果是weex编译模式,需通过weex的api设置(weex模式已被淘汰)

  • App平台的vue页面及 H5平台 的弹出键盘使用的是浏览器控制的键盘,在Chrome81+、Safari13.7+之前,键盘右下角文字只能设置完成和搜索,从Chrome81+、Safari13.7+起支持设置发送、下一个。
  • App平台涉及聊天的建议使用nvue,一方面因为app-vue控制键盘右下角按键文字为“发送”对webview内核有要求,另一方面聊天记录如使用sroll-view,过长的内容在app-vue上会有性能问题。

    App平台iOS端软键盘上方横条去除方案

    App平台在iOS上,webview中的软键盘弹出时,默认在软键盘上方有一个横条,显示着:上一项、下一项和完成等按钮。如不想显示这个横条,可以配置softinputNavBar: ‘none’
    配置方式,在 pages.json 中配置 style

    1. "app-plus": {
    2. "softinputNavBar": "none"
    3. }
  • 如需使用js动态设置softinputNavBar

    1. this.$scope.$getAppWebview().setStyle({
    2. softinputNavBar: 'none'
    3. })
    4. //this.$scope.$getAppWebview()相当于html5plus里的plus.webview.currentWebview()。在uni-app里vue页面直接使用plus.webview.currentWebview()无效,非v3编译模式使用this.$mp.page.$getAppWebview()

    如果是nvue页面,iOS默认就没有键盘上方的横条,无需任何设置。

    关于软键盘弹出的逻辑说明

    App平台软键盘弹出有 adjustResize|adjustPan 两种模式,默认为 adjustPan 模式,小程序平台只支持 adjustPan 模式,H5平台因不同浏览器而异

  • adjustResize:软键盘弹出时,webview窗体高度挤压。屏幕高度=webview窗体高度+软键盘高度

  • adjustPan:软键盘弹出时,webview窗体高度不变,但窗体上推,以保证输入框不被软键盘盖住

配置方式,在 pages.json 中配置 style

  1. "app-plus": {
  2. "softinputMode": "adjustResize"
  3. }

注意

  • adjustResize模式在Android App上,弹起键盘和收回键盘时,因为要重设webview窗体高度,可能会在个别安卓机型闪现灰屏或漏出下层页面内容。
  • 小程序端在 input 聚焦期间,避免使用 css 动画。
  • H5平台只能在用户交互时修改 focus 生效。
  • 如果遇到 focus 属性设置不生效的问题参考:组件属性设置不生效解决办法
  • 如需禁止点击其他位置收起键盘的默认行为,可以监听touch事件并使用prevent修饰符(仅支持App-v3、H5,其他平台可以通过设置focus来使输入框重新获取焦点),例如在确认按钮上使用:@touchend.prevent="onTap"

    关于软键盘收起的逻辑说明

  • Android上在软键盘弹出后,点击back或点击非置焦区域可收起软键盘。

  • iOS上如果软键盘上方有带有“完成”的横条,则需要点完成才能收起键盘;如果没有软键盘上方横条,则点击非input/textarea区域即可收起软键盘

以上为默认逻辑,uni-app同时提供了隐藏软键盘的api:uni.hideKeyboard()

App平台原生输入框的说明

在app平台,有titleNView配置的searchinput原生输入框和plus.nativeObj.view的drawinput。这两种方式的输入框都是原生的,不是webview里的。

  • 原生输入框在iOS上不会有软键盘上方的横条
  • 原生输入框一样受配置的adjustPan|adjustResize模式影响

    input示例

    查看演示
    以下示例代码,来自于hello uni-app项目,推荐使用HBuilderX,新建uni-app项目,选择hello uni-app模板,可直接体验完整示例。
    1. <!-- 本示例未包含完整css,获取外链css请参考上文,在hello uni-app项目中查看 -->
    2. <template>
    3. <view>
    4. <view class="uni-common-mt">
    5. <view class="uni-form-item uni-column">
    6. <view class="title">可自动聚焦的input</view>
    7. <input class="uni-input" focus placeholder="自动获得焦点" />
    8. </view>
    9. <view class="uni-form-item uni-column">
    10. <view class="title">键盘右下角按钮显示为搜索</view>
    11. <input class="uni-input" confirm-type="search" placeholder="键盘右下角按钮显示为搜索" />
    12. </view>
    13. <view class="uni-form-item uni-column">
    14. <view class="title">控制最大输入长度的input</view>
    15. <input class="uni-input" maxlength="10" placeholder="最大输入长度为10" />
    16. </view>
    17. <view class="uni-form-item uni-column">
    18. <view class="title">实时获取输入值:{{inputValue}}</view>
    19. <input class="uni-input" @input="onKeyInput" placeholder="输入同步到view中" />
    20. </view>
    21. <view class="uni-form-item uni-column">
    22. <view class="title">控制输入的input</view>
    23. <input class="uni-input" @input="replaceInput" v-model="changeValue" placeholder="连续的两个1会变成2" />
    24. </view>
    25. <!-- #ifndef MP-BAIDU -->
    26. <view class="uni-form-item uni-column">
    27. <view class="title">控制键盘的input</view>
    28. <input class="uni-input" ref="input1" @input="hideKeyboard" placeholder="输入123自动收起键盘" />
    29. </view>
    30. <!-- #endif -->
    31. <view class="uni-form-item uni-column">
    32. <view class="title">数字输入的input</view>
    33. <input class="uni-input" type="number" placeholder="这是一个数字输入框" />
    34. </view>
    35. <view class="uni-form-item uni-column">
    36. <view class="title">密码输入的input</view>
    37. <input class="uni-input" password type="text" placeholder="这是一个密码输入框" />
    38. </view>
    39. <view class="uni-form-item uni-column">
    40. <view class="title">带小数点的input</view>
    41. <input class="uni-input" type="digit" placeholder="带小数点的数字键盘" />
    42. </view>
    43. <view class="uni-form-item uni-column">
    44. <view class="title">身份证输入的input</view>
    45. <input class="uni-input" type="idcard" placeholder="身份证输入键盘" />
    46. </view>
    47. <view class="uni-form-item uni-column">
    48. <view class="title">控制占位符颜色的input</view>
    49. <input class="uni-input" placeholder-style="color:#F76260" placeholder="占位符字体是红色的" />
    50. </view>
    51. </view>
    52. </view>
    53. </template>
    1. export default {
    2. data() {
    3. return {
    4. title: 'input',
    5. focus: false,
    6. inputValue: '',
    7. changeValue: ''
    8. }
    9. },
    10. methods: {
    11. onKeyInput: function(event) {
    12. this.inputValue = event.target.value
    13. },
    14. replaceInput: function(event) {
    15. var value = event.target.value;
    16. if (value === '11') {
    17. this.changeValue = '2';
    18. }
    19. },
    20. hideKeyboard: function(event) {
    21. if (event.target.value === '123') {
    22. uni.hideKeyboard();
    23. }
    24. }
    25. }
    26. }
    input - 图1