Vant4 Field 输入框

介绍

用户可以在文本框内输入或编辑文字。

引入

通过以下方式来全局注册组件，更多注册方式请参考组件注册。

import { createApp } from vue;
import { Field, CellGroup } from vant;

const app = createApp();
app.use(Field);
app.use(CellGroup);

代码演示

基础用法

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

<!-- 可以使用 CellGroup 作为容器 -->
<van-cell-group inset>
  <van-field v-model="value" label="文本" placeholder="请输入用户名" />
</van-cell-group>

import { ref } from vue;

export default {
  setup() {
    const value = ref();
    return { value };
  },
};

自定义类型

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

<van-cell-group inset>
  <!-- 输入任意文本 -->
  <van-field v-model="text" label="文本" />
  <!-- 输入手机号，调起手机号键盘 -->
  <van-field v-model="tel" type="tel" label="手机号" />
  <!-- 允许输入正整数，调起纯数字键盘 -->
  <van-field v-model="digit" type="digit" label="整数" />
  <!-- 允许输入数字，调起带符号的纯数字键盘 -->
  <van-field v-model="number" type="number" label="数字" />
  <!-- 输入密码 -->
  <van-field v-model="password" type="password" label="密码" />
</van-cell-group>

import { ref } from vue;

export default {
  setup() {
    const tel = ref();
    const text = ref();
    const digit = ref();
    const number = ref();
    const password = ref();

    return { tel, text, digit, number, password };
  },
};

禁用输入框

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

<van-cell-group inset>
  <van-field label="文本" model-value="输入框只读" readonly />
  <van-field label="文本" model-value="输入框已禁用" disabled />
</van-cell-group>

显示图标

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

<van-cell-group inset>
  <van-field
    v-model="value1"
    label="文本"
    left-icon="smile-o"
    right-icon="warning-o"
    placeholder="显示图标"
  />
  <van-field
    v-model="value2"
    clearable
    label="文本"
    left-icon="music-o"
    placeholder="显示清除图标"
  />
</van-cell-group>

import { ref } from vue;

export default {
  setup() {
    const value1 = ref();
    const value2 = ref(123);
    return {
      value1,
      value2,
    };
  },
};

错误提示

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

<van-cell-group inset>
  <van-field
    v-model="username"
    error
    required
    label="用户名"
    placeholder="请输入用户名"
  />
  <van-field
    v-model="phone"
    required
    label="手机号"
    placeholder="请输入手机号"
    error-message="手机号格式错误"
  />
</van-cell-group>

插入按钮

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

<van-cell-group inset>
  <van-field
    v-model="sms"
    center
    clearable
    label="短信验证码"
    placeholder="请输入短信验证码"
  >
    <template #button>
      <van-button size="small" type="primary">发送验证码</van-button>
    </template>
  </van-field>
</van-cell-group>

格式化输入内容

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

<van-cell-group inset>
  <van-field
    v-model="value1"
    label="文本"
    :formatter="formatter"
    placeholder="在输入时执行格式化"
  />
  <van-field
    v-model="value2"
    label="文本"
    :formatter="formatter"
    format-trigger="onBlur"
    placeholder="在失焦时执行格式化"
  />
</van-cell-group>

import { ref } from vue;

export default {
  setup() {
    const value1 = ref();
    const value2 = ref();
    // 过滤输入的数字
    const formatter = (value) => value.replace(/d/g, );

    return {
      value1,
      value2,
      formatter,
    };
  },
};

高度自适应

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

<van-cell-group inset>
  <van-field
    v-model="message"
    rows="1"
    autosize
    label="留言"
    type="textarea"
    placeholder="请输入留言"
  />
</van-cell-group>

显示字数统计

设置 ​maxlength​ 和 ​show-word-limit​ 属性后会在底部显示字数统计。

<van-cell-group inset>
  <van-field
    v-model="message"
    rows="2"
    autosize
    label="留言"
    type="textarea"
    maxlength="50"
    placeholder="请输入留言"
    show-word-limit
  />
</van-cell-group>

输入框内容对齐

通过 ​input-align​ 属性可以设置输入框内容的对齐方式，可选值为 ​center​、​right​。

<van-cell-group inset>
  <van-field
    v-model="value"
    label="文本"
    placeholder="输入框内容右对齐"
    input-align="right"
  />
</van-cell-group>

输入框文本位置

通过 ​label-align​ 属性可以设置输入框文本的位置，可选值为 ​center​、​right​、​top​。

<van-cell-group inset>
  <van-field
    v-model="value"
    label="手机号"
    placeholder="请输入手机号"
    label-align="top"
  />
</van-cell-group>

API

Props

Events

方法

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

类型定义

组件导出以下类型定义：

import type {
  FieldType,
  FieldRule,
  FieldProps,
  FieldInstance,
  FieldTextAlign,
  FieldRuleMessage,
  FieldClearTrigger,
  FieldFormatTrigger,
  FieldRuleValidator,
  FiledRuleFormatter,
  FieldValidateError,
  FieldAutosizeConfig,
  FieldValidateTrigger,
  FieldValidationStatus,
} from vant;

​FieldInstance​ 是组件实例的类型，用法如下：

import { ref } from vue;
import type { FieldInstance } from vant;

const fieldRef = ref<FieldInstance>();

fieldRef.value?.focus();

Slots

主题定制

样式变量

组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 ConfigProvider 组件。

常见问题

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

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

为什么 v-model 绑定的值被更新为 string 类型？

Field 组件内部会将传入的 v-model 格式化为 string 类型，便于组件内部进行处理。

如果你希望在 v-model 上绑定 number 类型，可以使用 Vue 提供的 .number 修饰符。

<van-field v-model.number="value" type="tel" />

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

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