input

输入框。

属性说明

属性名类型默认值说明平台差异说明
valueString输入框的初始内容
typeStringtextinput 的类型
passwordBooleanfalse是否是密码类型
placeholderString输入框为空时占位符
placeholder-styleString指定 placeholder 的样式
placeholder-classString"input-placeholder"指定 placeholder 的样式类
disabledBooleanfalse是否禁用
maxlengthNumber140最大输入长度,设置为 -1 的时候不限制最大长度
cursor-spacingNumber0指定光标与键盘的距离,单位 px 。取 input 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离5+App、微信小程序、百度小程序、QQ小程序
focusBooleanfalse获取焦点。在 H5 平台聚焦后软键盘是否跟随弹出,取决于当前浏览器本身的规范(策略)。
confirm-typeStringdone设置键盘右下角按钮的文字,仅在 type="text" 时生效。
confirm-holdBooleanfalse点击键盘右下角按钮时是否保持键盘不收起5+App、微信小程序、支付宝小程序、百度小程序、QQ小程序
cursorNumber指定focus时的光标位置
selection-startNumber-1光标起始位置,自动聚集时有效,需与selection-end搭配使用
selection-endNumber-1光标结束位置,自动聚集时有效,需与selection-start搭配使用
adjust-positionBooleantrue键盘弹起时,是否自动上推页面5+App(softinputMode 为 adjustResize 时无效)、微信小程序、百度小程序、QQ小程序
@inputEventHandle当键盘输入时,触发input事件,event.detail = {value}差异见下方 Tips
@focusEventHandle输入框聚焦时触发,event.detail = { value, height },height 为键盘高度仅微信小程序、5+App(HBuilderX 2.2.3) 、QQ小程序支持 height
@blurEventHandle输入框失去焦点时触发,event.detail = {value: value}
@confirmEventHandle点击完成按钮时触发,event.detail = {value: value}

Tips

  • input 事件处理函数可以直接 return 一个字符串,将替换输入框的内容。仅微信小程序支持。
  • input 事件处理函数内实时修改当前值不生效,可以延迟设置,例如:setTimeout(() => { this.value = 100 }, 0)
  • input 组件上有默认的 min-height 样式,如果 min-height 的值大于 height 的值那么 height 样式无效。type 有效值
说明平台差异说明
text文本输入键盘
number数字输入键盘注意iOS的vue页面弹出的数字键盘并非9宫格方式
idcard身份证输入键盘微信、支付宝、百度、QQ小程序
digit带小数点的数字键盘App的nvue页面、微信、支付宝、百度、头条、QQ小程序

注意事项

  • 小程序平台,number 类型只支持输入整型数字。微信开发者工具上体现不出效果,请使用真机预览。
  • 如果需要在小程序平台输入浮点型数字,请使用 digit 类型。
  • input组件若不想弹出软键盘,可设置为disable
  • App平台的vue页面及 H5平台 的弹出键盘使用的是浏览器控制的键盘,丰富程度略低。可通过插件市场补足。
  • uni-app插件市场有各种类型的模拟键盘,比如车牌键盘、身份证键盘,以及封装好的搜索框ui组件,可去插件市场搜索 键盘
  • uni-app插件市场有输入文字后自动提示候选的组件,可搜索 autocomplete 查看。confirm-type 有效值
说明平台差异说明
send右下角按钮为“发送”微信、支付宝、百度小程序、App的nvue
search右下角按钮为“搜索”
next右下角按钮为“下一个”微信、支付宝、百度小程序、App的nvue
go右下角按钮为“前往”
done右下角按钮为“完成”微信、支付宝、百度小程序、App的nvue

App平台的nvue页面,如果是uni-app编译模式,直接使用此属性设置即可生效。如果是weex编译模式,需通过weex的api设置,weex相关文档参考

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

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

  • 如需要整个App配置,则在manifest中配置
  1. "app-plus": {
  2. "softinput": {
  3. "navBar": "none" // 是否显示软键盘上的导航条
  4. }
  5. }
  • 如需要单个页面配置,则在pages.json中配置
  1. {
  2. "path": "pages/component/input/input",
  3. "style": {
  4. "app-plus":{
  5. "softinputNavBar":"none"
  6. }
  7. }
  8. }
  • 如需使用js动态设置softinputNavBar
  1. this.$mp.page.$getAppWebview().setStyle({
  2. softinputNavBar: 'none'
  3. })

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

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

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

  • adjustResize:软键盘弹出时,webview窗体高度挤压。屏幕高度=webview窗体高度+软键盘高度
  • adjustPan:软键盘弹出时,webview窗体高度不变,但窗体上推,以保证输入框不被软键盘盖住配置方式,在 pages.json 中配置 style
  1. "app-plus": {
  2. "softinputMode": "adjustResize"
  3. }

App端开发聊天类应用时,目前推荐改为adjustResize模式。在hello uni-app的模板-聊天中有详细示例。

注意

  • adjustResize模式在Android App上,弹起键盘和收回键盘时,因为要重设webview高度,可能会临时性出现灰屏或漏出下层页面内容。后续会优化
  • 小程序端在 input 聚焦期间,避免使用 css 动画。
  • H5平台只能在用户交互时修改 focus 生效。
  • 如果遇到 focus 属性设置不生效的问题参考:组件属性设置不生效解决办法

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

  • Android上在软键盘弹出后,点击back或点击非置焦区域可收起软键盘。
  • iOS上如果软键盘上方有带有“完成”的横条,则需要点完成才能收起键盘;如果没有软键盘上方横条,则点击非input/textarea区域即可收起软键盘以上为默认逻辑,uni-app同时提供了隐藏软键盘的api:uni.hideKeyboard()

App平台原生输入框的说明

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

  • 原生输入框在iOS上不会有软键盘上方的横条
  • 原生输入框一样受配置的adjustPan|adjustResize模式影响input示例
  1. <template>
  2. <view>
  3. <view class="uni-common-mt">
  4. <view class="uni-form-item uni-column">
  5. <view class="title">可自动聚焦的input</view>
  6. <input class="uni-input" focus placeholder="自动获得焦点" />
  7. </view>
  8. <view class="uni-form-item uni-column">
  9. <view class="title">键盘右下角按钮显示为搜索</view>
  10. <input class="uni-input" confirm-type="search" placeholder="键盘右下角按钮显示为搜索" />
  11. </view>
  12. <view class="uni-form-item uni-column">
  13. <view class="title">控制最大输入长度的input</view>
  14. <input class="uni-input" maxlength="10" placeholder="最大输入长度为10" />
  15. </view>
  16. <view class="uni-form-item uni-column">
  17. <view class="title">实时获取输入值:{{inputValue}}</view>
  18. <input class="uni-input" @input="onKeyInput" placeholder="输入同步到view中" />
  19. </view>
  20. <view class="uni-form-item uni-column">
  21. <view class="title">控制输入的input</view>
  22. <input class="uni-input" @input="replaceInput" v-model="changeValue" placeholder="连续的两个1会变成2" />
  23. </view>
  24. <!-- #ifndef MP-BAIDU -->
  25. <view class="uni-form-item uni-column">
  26. <view class="title">控制键盘的input</view>
  27. <input class="uni-input" ref="input1" @input="hideKeyboard" placeholder="输入123自动收起键盘" />
  28. </view>
  29. <!-- #endif -->
  30. <view class="uni-form-item uni-column">
  31. <view class="title">数字输入的input</view>
  32. <input class="uni-input" type="number" placeholder="这是一个数字输入框" />
  33. </view>
  34. <view class="uni-form-item uni-column">
  35. <view class="title">密码输入的input</view>
  36. <input class="uni-input" password type="text" placeholder="这是一个密码输入框" />
  37. </view>
  38. <view class="uni-form-item uni-column">
  39. <view class="title">带小数点的input</view>
  40. <input class="uni-input" type="digit" placeholder="带小数点的数字键盘" />
  41. </view>
  42. <view class="uni-form-item uni-column">
  43. <view class="title">身份证输入的input</view>
  44. <input class="uni-input" type="idcard" placeholder="身份证输入键盘" />
  45. </view>
  46. <view class="uni-form-item uni-column">
  47. <view class="title">控制占位符颜色的input</view>
  48. <input class="uni-input" placeholder-style="color:#F76260" placeholder="占位符字体是红色的" />
  49. </view>
  50. </view>
  51. </view>
  52. </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. }

uniapp


发现错误?想参与编辑?在 GitHub 上编辑此页面!