input
input
基础库 1.0.0 开始支持,低版本需做兼容处理。
微信 Windows 版:支持
微信 Mac 版:支持
微信 鸿蒙 OS 版:支持
渲染框架支持情况:Skyline (使用最新 Nighly 工具调试)、WebView
功能描述
输入框。该组件是原生组件,使用时请注意相关限制
通用属性
属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 | |
---|---|---|---|---|---|---|
value | string | 是 | 输入框的初始内容 | 1.0.0 | ||
type | string | text | 否 | input 的类型 | 1.0.0 | |
合法值说明最低版本text文本输入键盘number数字输入键盘idcard身份证输入键盘digit带小数点的数字键盘safe-password密码安全输入键盘 指引。仅 Webview 支持。2.18.0nickname昵称输入键盘。2.21.2 | ||||||
password | boolean | false | 否 | 是否是密码类型 | 1.0.0 | |
placeholder | string | 是 | 输入框为空时占位符 | 1.0.0 | ||
placeholder-style | string | 是 | 指定 placeholder 的样式 | 1.0.0 | ||
disabled | boolean | false | 否 | 是否禁用 | 1.0.0 | |
maxlength | number | 140 | 否 | 最大输入长度,设置为 -1 的时候不限制最大长度 | 1.0.0 | |
cursor-spacing | number | 0 | 否 | 指定光标与键盘的距离,取 input 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离 | 1.0.0 | |
auto-focus | boolean | false | 否 | (即将废弃,请直接使用 focus )自动聚焦,拉起键盘 | 1.0.0 | |
focus | boolean | false | 否 | 获取焦点 | 1.0.0 | |
confirm-type | string | done | 否 | 设置键盘右下角按钮的文字,仅在type='text'时生效 | 1.1.0 | |
合法值说明send右下角按钮为“发送”search右下角按钮为“搜索”next右下角按钮为“下一个”go右下角按钮为“前往”done右下角按钮为“完成” | ||||||
always-embed | boolean | false | 否 | 强制 input 处于同层状态,默认 focus 时 input 会切到非同层状态 (仅在 iOS 下生效) | 2.10.4 | |
confirm-hold | boolean | false | 否 | 点击键盘右下角按钮时是否保持键盘不收起 | 1.1.0 | |
cursor | number | 是 | 指定focus时的光标位置 | 1.5.0 | ||
cursor-color | string | 是 | 光标颜色。iOS 下的格式为十六进制颜色值 #000000,安卓下的只支持 default 和 green,Skyline 下无限制 | 3.1.0 | ||
selection-start | number | -1 | 否 | 光标起始位置,自动聚集时有效,需与selection-end搭配使用 | 1.9.0 | |
selection-end | number | -1 | 否 | 光标结束位置,自动聚集时有效,需与selection-start搭配使用 | 1.9.0 | |
adjust-position | boolean | true | 否 | 键盘弹起时,是否自动上推页面 | 1.9.90 | |
hold-keyboard | boolean | false | 否 | focus时,点击页面的时候不收起键盘 | 2.8.2 | |
safe-password-cert-path | string | 否 | 安全键盘加密公钥的路径,只支持包内路径。鸿蒙 OS 暂不支持 | 2.18.0 | ||
safe-password-length | number | 否 | 安全键盘输入密码长度。鸿蒙 OS 暂不支持 | 2.18.0 | ||
safe-password-time-stamp | number | 否 | 安全键盘加密时间戳。鸿蒙 OS 暂不支持 | 2.18.0 | ||
safe-password-nonce | string | 否 | 安全键盘加密盐值。鸿蒙 OS 暂不支持 | 2.18.0 | ||
safe-password-salt | string | 否 | 安全键盘计算hash盐值,若指定custom-hash 则无效。鸿蒙 OS 暂不支持 | 2.18.0 | ||
safe-password-custom-hash | string | 否 | 安全键盘计算hash的算法表达式,如 md5(sha1('foo' + sha256(sm3(password + 'bar')))) 。鸿蒙 OS 暂不支持 |
2.18.0 | ||
bindinput | eventhandle | 是 | 键盘输入时或内容改变时触发。event.detail = { value: string, cursor?: number, keyCode?: number },cursor 为光标位置,keyCode 为键值。2.1.0 起支持,处理函数可以直接 return 一个字符串,将替换输入框的内容。 | 1.0.0 | ||
bindchange | eventhandle | 是 | 键盘非聚焦状态内容改变时触发。event.detail = | 1.0.0 | ||
bindfocus | eventhandle | 是 | 输入框聚焦时触发,event.detail = { value: string, height: number },height 为键盘高度,在基础库 1.9.90 起支持 | 1.0.0 | ||
bindblur | eventhandle | 是 | 输入框失去焦点时触发,event.detail = | 1.0.0 | ||
bindconfirm | eventhandle | 是 | 点击完成按钮时触发,event.detail = | 1.0.0 | ||
bindkeyboardheightchange | eventhandle | 是 | 键盘高度发生变化的时候触发此事件,event.detail = | 2.7.0 | ||
bindnicknamereview | eventhandle | 是 | 用户昵称审核完毕后触发,仅在 type 为 "nickname" 时有效,event.detail = | 2.29.1 |
Skyline 特有属性
属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 | |
---|---|---|---|---|---|---|
bind:selectionchange | eventhandle | 否 | 选区改变事件, | 3.2.0 | ||
bind:keyboardcompositionstart | eventhandle | 否 | 输入法开始新的输入时触发 (仅当输入法支持时触发) | 3.2.0 | ||
bind:keyboardcompositionupdate | eventhandle | 否 | 输入法输入字符时触发(仅当输入法支持时触发) | 3.2.0 | ||
bind:keyboardcompositionend | eventhandle | 否 | 输入法输入结束时触发(仅当输入法支持时触发) | 3.2.0 | ||
worklet:onkeyboardheightchange | worklet | 否 | 键盘高度变化时触发。event.detail = {height: height, pageBottomPadding: pageBottomPadding}; height: 键盘高度,pageBottomPadding: 页面上推高度 | 3.2.4 |
WebView 特有属性
属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 | |
---|---|---|---|---|---|---|
placeholder-class | string | input-placeholder | 否 | 指定 placeholder 的样式类 | 1.0.0 |
Bug & Tip
tip
: confirm-type的最终表现与手机输入法本身的实现有关,部分安卓系统输入法和第三方输入法可能不支持或不完全支持tip
: input 组件是一个原生组件,字体是系统字体,所以无法设置 font-familytip
: 在 input 聚焦期间,避免使用 css 动画tip
: 对于将input
封装在自定义组件中、而form
在自定义组件外的情况,form
将不能获得这个自定义组件中input
的值。此时需要使用自定义组件的 内置 behaviorswx://form-field
tip
: 键盘高度发生变化,keyboardheightchange事件可能会多次触发,开发者对于相同的height值应该忽略掉bug
: 微信版本6.3.30
, focus 属性设置无效bug
: 微信版本6.3.30
, placeholder 在聚焦时出现重影问题
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 无需6万激活码!GitHub神秘组织3小时极速复刻Manus,手把手教你使用OpenManus搭建本
· Manus爆火,是硬核还是营销?
· 终于写完轮子一部分:tcp代理 了,记录一下
· 别再用vector<bool>了!Google高级工程师:这可能是STL最大的设计失误
· 单元测试从入门到精通