Vant3 Field 輸入框

介紹

用戶可以在文本框內(nèi)輸入或編輯文字。

實例演示

引入

通過以下方式來全局注冊組件，更多注冊方式請參考組件注冊。

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

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

代碼演示

基礎(chǔ)用法

可以通過 v-model 雙向綁定輸入框的值，通過 placeholder 設(shè)置占位提示文字。

<!-- 可以使用 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 };
  },
};

自定義類型

根據(jù) type 屬性定義不同類型的輸入框，默認值為 text。

<van-cell-group inset>
  <!-- 輸入任意文本 -->
  <van-field v-model="state.text" label="文本" />
  <!-- 輸入手機號，調(diào)起手機號鍵盤 -->
  <van-field v-model="state.tel" type="tel" label="手機號" />
  <!-- 允許輸入正整數(shù)，調(diào)起純數(shù)字鍵盤 -->
  <van-field v-model="state.digit" type="digit" label="整數(shù)" />
  <!-- 允許輸入數(shù)字，調(diào)起帶符號的純數(shù)字鍵盤 -->
  <van-field v-model="state.number" type="number" label="數(shù)字" />
  <!-- 輸入密碼 -->
  <van-field v-model="state.password" type="password" label="密碼" />
</van-cell-group>

import { reactive } from 'vue';

export default {
  setup() {
    const state = reactive({
      tel: '',
      text: '',
      digit: '',
      number: '',
      password: '',
    });

    return { state };
  },
};

禁用輸入框

通過 readonly 將輸入框設(shè)置為只讀狀態(tài)，通過 disabled 將輸入框設(shè)置為禁用狀態(tài)。

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

顯示圖標

通過 left-icon 和 right-icon 配置輸入框兩側(cè)的圖標，通過設(shè)置 clearable 在輸入過程中展示清除圖標。

<van-cell-group inset>
  <van-field
    v-model="state.value1"
    label="文本"
    left-icon="smile-o"
    right-icon="warning-o"
    placeholder="顯示圖標"
  />
  <van-field
    v-model="state.value2"
    clearable
    label="文本"
    left-icon="music-o"
    placeholder="顯示清除圖標"
  />
</van-cell-group>

import { reactive } from 'vue';

export default {
  setup() {
    const state = reactive({
      value1: '',
      value2: '123',
    });

    return { state };
  },
};

錯誤提示

設(shè)置 required 屬性表示這是一個必填項，可以配合 error 或 error-message 屬性顯示對應(yīng)的錯誤提示。

<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">發(fā)送驗證碼</van-button>
    </template>
  </van-field>
</van-cell-group>

格式化輸入內(nèi)容

通過 formatter 屬性可以對輸入的內(nèi)容進行格式化，通過 format-trigger 屬性可以指定執(zhí)行格式化的時機，默認在輸入時進行格式化。

<van-cell-group inset>
  <van-field
    v-model="state.value1"
    label="文本"
    :formatter="formatter"
    placeholder="在輸入時執(zhí)行格式化"
  />
  <van-field
    v-model="state.value2"
    label="文本"
    :formatter="formatter"
    format-trigger="onBlur"
    placeholder="在失焦時執(zhí)行格式化"
  />
</van-cell-group>

import { reactive } from 'vue';

export default {
  setup() {
    const state = reactive({
      value1: '',
      value2: '',
    });
    // 過濾輸入的數(shù)字
    const formatter = (value) => value.replace(/\d/g, '');

    return {
      state,
      formatter,
    };
  },
};

高度自適應(yīng)

對于 textarea，可以通過 autosize 屬性設(shè)置高度自適應(yīng)。

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

顯示字數(shù)統(tǒng)計

設(shè)置 maxlength 和 show-word-limit 屬性后會在底部顯示字數(shù)統(tǒng)計。

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

輸入框內(nèi)容對齊

通過 input-align 屬性可以設(shè)置輸入框內(nèi)容的對齊方式，可選值為 center、right。

<van-cell-group inset>
  <van-field
    v-model="value"
    label="文本"
    placeholder="輸入框內(nèi)容右對齊"
    input-align="right"
  />
</van-cell-group>

API

Props

Events

方法

通過 ref 可以獲取到 Field 實例并調(diào)用實例方法，詳見組件實例方法。

Slots

主題定制

樣式變量

組件提供了下列 CSS 變量，可用于自定義樣式，使用方法請參考 ConfigProvider 組件。

常見問題

設(shè)置 type 為 number 后，為什么 input 標簽的類型仍為 text?

HTML 原生的 type="number" 屬性在 iOS 和 Android 系統(tǒng)上都存在一定問題，比如 maxlength 屬性不生效、無法獲取到完整的輸入內(nèi)容等。因此設(shè)置 type 為 number 時，F(xiàn)ield 不會使用原生的 type="number" 屬性，而是用現(xiàn)代瀏覽器支持的 inputmode 屬性來控制輸入鍵盤的類型。

在桌面端點擊清除按鈕無效？

清除按鈕監(jiān)聽是的移動端 Touch 事件，參見桌面端適配。