Field 输入框

介绍

表单中的输入框组件。

引入

  1. import { createApp } from 'vue';
  2. import { Field } from 'vant';
  3. const app = createApp();
  4. app.use(Field);

代码演示

基础用法

可以通过 v-model 双向绑定输入框的值,通过 placeholder 设置占位提示文字。

  1. <!-- Field 是基于 Cell 实现的,可以使用 CellGroup 作为容器来提供外边框。 -->
  2. <van-cell-group>
  3. <van-field v-model="value" label="文本" placeholder="请输入用户名" />
  4. </van-cell-group>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const value = ref('');
  5. return { value };
  6. },
  7. };

自定义类型

根据 type 属性定义不同类型的输入框,默认值为 text

  1. <!-- 输入任意文本 -->
  2. <van-field v-model="state.text" label="文本" />
  3. <!-- 输入手机号,调起手机号键盘 -->
  4. <van-field v-model="state.tel" type="tel" label="手机号" />
  5. <!-- 允许输入正整数,调起纯数字键盘 -->
  6. <van-field v-model="state.digit" type="digit" label="整数" />
  7. <!-- 允许输入数字,调起带符号的纯数字键盘 -->
  8. <van-field v-model="state.number" type="number" label="数字" />
  9. <!-- 输入密码 -->
  10. <van-field v-model="state.password" type="password" label="密码" />
  1. import { reactive } from 'vue';
  2. export default {
  3. setup() {
  4. const state = reactive({
  5. tel: '',
  6. text: '',
  7. digit: '',
  8. number: '',
  9. password: '',
  10. });
  11. return { state };
  12. },
  13. };

禁用输入框

通过 readonly 将输入框设置为只读状态,通过 disabled 将输入框设置为禁用状态。

  1. <van-cell-group>
  2. <van-field label="文本" value="输入框只读" readonly />
  3. <van-field label="文本" value="输入框已禁用" disabled />
  4. </van-cell-group>

显示图标

通过 left-iconright-icon 配置输入框两侧的图标,通过设置 clearable 在输入过程中展示清除图标。

  1. <van-cell-group>
  2. <van-field
  3. v-model="state.value1"
  4. label="文本"
  5. left-icon="smile-o"
  6. right-icon="warning-o"
  7. placeholder="显示图标"
  8. />
  9. <van-field
  10. v-model="state.value2"
  11. clearable
  12. label="文本"
  13. left-icon="music-o"
  14. placeholder="显示清除图标"
  15. />
  16. </van-cell-group>
  1. import { reactive } from 'vue';
  2. export default {
  3. setup() {
  4. const state = reactive({
  5. value1: '',
  6. value2: '123',
  7. });
  8. return { state };
  9. },
  10. };

错误提示

设置 required 属性表示这是一个必填项,可以配合 errorerror-message 属性显示对应的错误提示。

  1. <van-cell-group>
  2. <van-field
  3. v-model="username"
  4. error
  5. required
  6. label="用户名"
  7. placeholder="请输入用户名"
  8. />
  9. <van-field
  10. v-model="phone"
  11. required
  12. label="手机号"
  13. placeholder="请输入手机号"
  14. error-message="手机号格式错误"
  15. />
  16. </van-cell-group>

插入按钮

通过 button 插槽可以在输入框尾部插入按钮。

  1. <van-field
  2. v-model="sms"
  3. center
  4. clearable
  5. label="短信验证码"
  6. placeholder="请输入短信验证码"
  7. >
  8. <template #button>
  9. <van-button size="small" type="primary">发送验证码</van-button>
  10. </template>
  11. </van-field>

格式化输入内容

通过 formatter 属性可以对输入的内容进行格式化,通过 format-trigger 属性可以指定执行格式化的时机,默认在输入时进行格式化。

  1. <van-field
  2. v-model="state.value1"
  3. label="文本"
  4. :formatter="formatter"
  5. placeholder="在输入时执行格式化"
  6. />
  7. <van-field
  8. v-model="state.value2"
  9. label="文本"
  10. :formatter="formatter"
  11. format-trigger="onBlur"
  12. placeholder="在失焦时执行格式化"
  13. />
  1. import { reactive } from 'vue';
  2. export default {
  3. setup() {
  4. const state = reactive({
  5. value1: '',
  6. value2: '',
  7. });
  8. // 过滤输入的数字
  9. const formatter = (value) => value.replace(/\d/g, '');
  10. return {
  11. state,
  12. formatter,
  13. };
  14. },
  15. };

高度自适应

对于 textarea,可以通过 autosize 属性设置高度自适应。

  1. <van-field
  2. v-model="message"
  3. rows="1"
  4. autosize
  5. label="留言"
  6. type="textarea"
  7. placeholder="请输入留言"
  8. />

显示字数统计

设置 maxlengthshow-word-limit 属性后会在底部显示字数统计。

  1. <van-field
  2. v-model="message"
  3. rows="2"
  4. autosize
  5. label="留言"
  6. type="textarea"
  7. maxlength="50"
  8. placeholder="请输入留言"
  9. show-word-limit
  10. />

输入框内容对齐

通过 input-align 属性可以设置输入框内容的对齐方式,可选值为 centerright

  1. <van-field
  2. v-model="value"
  3. label="文本"
  4. placeholder="输入框内容右对齐"
  5. input-align="right"
  6. />

API

Props

参数说明类型默认值
v-model当前输入的值number | string-
label输入框左侧文本string-
name v2.5.0名称,提交表单的标识符string-
type输入框类型, 可选值为 tel digit
number textarea password
stringtext
size大小,可选值为 largestring-
maxlength输入的最大字符数number | string-
placeholder输入框占位提示文字string-
border是否显示内边框booleantrue
disabled是否禁用输入框booleanfalse
readonly是否只读booleanfalse
colon v2.7.2是否在 label 后面添加冒号booleanfalse
required是否显示表单必填星号booleanfalse
center是否使内容垂直居中booleanfalse
clearable是否启用清除图标,点击清除图标后会清空输入框booleanfalse
clear-trigger v2.9.1显示清除图标的时机,always 表示输入框不为空时展示,
focus 表示输入框聚焦且不为空时展示
stringfocus
clickable是否开启点击反馈booleanfalse
is-link是否展示右侧箭头并开启点击反馈booleanfalse
autofocus是否自动聚焦,iOS 系统不支持该属性booleanfalse
show-word-limit是否显示字数统计,需要设置maxlength属性booleanfalse
error是否将输入内容标红booleanfalse
error-message底部错误提示文案,为空时不展示string-
formatter v2.4.2输入内容格式化函数Function-
format-trigger v2.8.7格式化函数触发的时机,可选值为 onBlurstringonChange
arrow-direction箭头方向,可选值为 left up downstringright
label-class左侧文本额外类名any-
label-width左侧文本宽度,默认单位为pxnumber | string6.2em
label-align左侧文本对齐方式,可选值为 center rightstringleft
input-align输入框对齐方式,可选值为 center rightstringleft
error-message-align错误提示文案对齐方式,可选值为 center rightstringleft
autosize是否自适应内容高度,只对 textarea 有效,
可传入对象,如 { maxHeight: 100, minHeight: 50 },
单位为px
boolean | objectfalse
left-icon左侧图标名称或图片链接string-
right-icon右侧图标名称或图片链接string-
icon-prefix v2.5.3图标类名前缀,同 Icon 组件的 class-prefix 属性stringvan-icon
rules v2.5.0表单校验规则,详见 Form 组件Rule[]-

Events

事件说明回调参数
update:model-value输入框内容变化时触发value: string (当前输入的值)
focus输入框获得焦点时触发event: Event
blur输入框失去焦点时触发event: Event
clear点击清除按钮时触发event: Event
click点击 Field 时触发event: Event
click-input v2.8.1点击输入区域时触发event: Event
click-left-icon点击左侧图标时触发event: Event
click-right-icon点击右侧图标时触发event: Event

方法

通过 ref 可以获取到 Field 实例并调用实例方法,详见组件实例方法

方法名说明参数返回值
focus获取输入框焦点--
blur取消输入框焦点--

Slots

名称说明
label自定义输入框 label 标签
input自定义输入框,使用此插槽后,与输入框相关的属性和事件将失效
left-icon自定义输入框头部图标
right-icon自定义输入框尾部图标
button自定义输入框尾部按钮
extra v2.8.2自定义输入框最右侧的额外内容

样式变量

组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考主题定制

名称默认值描述
@field-label-width6.2em-
@field-label-color@gray-7-
@field-label-margin-right@padding-sm-
@field-input-text-color@text-color-
@field-input-error-text-color@red-
@field-input-disabled-text-color@gray-5-
@field-placeholder-text-color@gray-5-
@field-icon-size16px-
@field-clear-icon-size16px-
@field-clear-icon-color@gray-5-
@field-right-icon-color@gray-6-
@field-error-message-color@red-
@field-error-message-text-color12px-
@field-text-area-min-height60px-
@field-word-limit-color@gray-7-
@field-word-limit-font-size@font-size-sm-
@field-word-limit-line-height16px-
@field-disabled-text-color@gray-5-

常见问题

设置 type 为 number 后,为什么 input 标签的类型仍为 text?

HTML 原生的 type="number" 属性在 iOS 和 Android 系统上都存在一定问题,比如 maxlength 属性不生效、无法获取到完整的输入内容等。因此设置 type 为 number 时,Field 不会使用原生的 type="number" 属性,而是用现代浏览器支持的 inputmode 属性来控制输入键盘的类型。

在桌面端点击清除按钮无效?

清除按钮监听是的移动端 Touch 事件,参见桌面端适配

Field 输入框 - 图1