快捷導(dǎo)航

element-plus?el-form表單驗證使用方法以及注意事項

更新時間：2023年12月05日 10:55:24 作者：柑橘烏云_

這篇文章主要給大家介紹了關(guān)于element-plus?el-form表單驗證使用方法以及注意事項的相關(guān)資料,表單驗證能通過設(shè)置驗證規(guī)則驗證用戶的輸入,并對不規(guī)范的輸入做出對應(yīng)提示,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下

表單定義規(guī)則

//表單驗證規(guī)則 
const rules = reactive({
  name: [{ validator: checkName, trigger: ['blur', 'change'],required: true}],
  phone: [{ type: number, validator: checkPhone, trigger: ['blur', 'change'] }],
  password: [{ validator: checkpassword, trigger: ['blur'] }],
})

el-form配置

<el-form :model="formData" :rules="rules" ref="baseForm"></el-form>

上一步已經(jīng)為表單綁定了規(guī)則列表formData，接下來，只需要在form-item中使用prop綁定驗證規(guī)則即可

<el-form-item label="電話" style="width: 40%" prop="phone">
   <el-input v-model="formData.phone" type="text" autocomplete="off" disabled />
</el-form-item>

對應(yīng)關(guān)系:

表單對象 formData: { name: '' }
表單元素 prop="name"
規(guī)則列表 rules: { name: [{...}] }

另外，驗證嵌套屬性可以通過 . 連接綁定：

formData: { obj: { name: '' } }
prop="obj.name"
baseRules: { 'obj.name': [{...}] }

完整demo

<template>
    <el-form :model="formData" :rules="rules" ref="ruleFormRef" status-icon label-width="120px" size="large">
        <el-form-item label="姓名" style="width: 40%" prop="name">
          <el-input v-model="form.name" type="text" autocomplete="off" />
        </el-form-item>
        <el-form-item label="性別" style="width: 40%" prop="sex">
          <el-select v-model="form.sex" placeholder="請選擇性別">
            <el-option label="男" :value=1 />
            <el-option label="女" :value=0 />
          </el-select>
        </el-form-item>
        <el-form-item label="生日" style="width: 40%" prop="birthday">
          <!-- <el-input v-model="form.birthday" type="text" autocomplete="off" /> -->
          <el-date-picker v-model="form.birthday" type="date" placeholder="請選擇生日!" style="width: 100%"
            value-format="YYYY-MM-DD" />
        </el-form-item>
        <el-form-item label="電話" style="width: 40%" prop="phone">
          <el-input v-model="form.phone" type="text" autocomplete="off" disabled />
        </el-form-item>
        <el-form-item label="密碼" style="width: 40%" prop="password">
          <el-input v-model="form.password" type="password" autocomplete="off" show-password />
        </el-form-item>
      </el-form>
</template>

<script setup>
let formData = reactive({
  birthday: '',
  name: '',
  phone: '',
  sex: 1,
  password: ''
})
// 驗證函數(shù)
const checkPhone = (rule, value, callback) => {
  console.log(value);
  if (!Number.isInteger(Number(value))) {
    return callback(new Error('請輸入數(shù)字！'))
  } else if (String(value).length != 11) {
    return callback(new Error('您輸入的手機(jī)位數(shù)不是11位！'))
  } else {
    callback()
  }
}
// 驗證函數(shù)
const checkpassword = (rule, value, callback) => {
  console.log(value);
  if (String(value).length > 12) {
    return callback(new Error('您輸入的密碼過長！長度不超過12位'))
  } else {
    callback()
  }
}
// 驗證函數(shù)
const checkName = (rule, value, callback) => {
  if (value.length > 8) {
    return callback(new Error('您輸入的姓名過長！'))
  } else {
    callback()
  }
}
//表單驗證規(guī)則 
const rules = reactive({
  name: [{ validator: checkName, trigger: ['blur', 'change'] }],
  phone: [{ type: number, validator: checkPhone, trigger: ['blur', 'change'] }],
  password: [{ validator: checkpassword, trigger: ['blur'] }],
})

</script>

配置項以及其可選的值

（詳細(xì)文檔鏈接）

Rules API:

type: 指示要使用的驗證器類型

type: string, number, boolean, method, regexp, integer, float, array, object, enum, date, url, hex, email, any

Required

required:必填/非必填

Messages

message: 錯誤提示

Pattern

pattern: 值需校驗通過的正則表達(dá)式

Range

min, max: type為array, string時，指長度。為number時，指大小

Length

len: type為array, string時，指長度。為number時，指值

Enumerable

enum: 例：{ type: 'enum', enum: ['admin', 'user', 'guest'] }

Whitespace
Deep Rules 對象的深層規(guī)則

fields: 對象的屬性名，數(shù)組的下標(biāo)

defaultField: 應(yīng)用于對象、數(shù)組內(nèi)的所有成員

Transform

transform: 方法，對值的預(yù)處理

validator

validator: 自定義驗證方法

asyncValidator

asyncValidator: 自定義異步驗證方法

trigger: 觸發(fā)驗證的方法，值可用字符串’blur’, ‘change’，也可是數(shù)組[‘blur’, ‘change’]

注意，規(guī)則數(shù)組是按序逐一被執(zhí)行驗證的（trigger='blur’時，更改input框的值不會觸發(fā)驗證）

進(jìn)階

單項驗證

可在表單的項 ( < el-form-item > ) 中單獨設(shè)置驗證規(guī)則

<el-form-item label="郵箱：" prop="email"
  :rules="[{ type: 'email', message: '郵箱格式錯誤', trigger: 'change' }]"
></el-form-item>

簡寫：

<el-form-item label="姓名：" prop="username" required />

對于字符串的非空校驗，element plus表單驗證提供了一種簡單的方式（能實現(xiàn)校驗，但有很大局限性，而且提示語是英文）

為了代碼的可維護(hù)性與美觀，盡量不要將規(guī)則寫在模板中。但某些情況下必須如此，比如，當(dāng)需要額外傳遞參數(shù)給validator時：

<el-form-item label="樣本類型：" prop="sampType"
    :rules="[{ validator: (rule, value, cb) => validateSampType(rule, value, cb, yourParams), trigger: 'change' }]"
></el-form-item>

正則校驗

//regex.js
// 手機(jī)號或座機(jī)號
export const reg_tel_phone = /(^((\+86)|(86))?(1[3-9])\d{9}$)|(^(0\d{2,3})-?(\d{7,8})$)/

//doctor.vue
import { reg_tel_phone } from '@/assets/regex'
rules: {
  name: [{ required: true, message: '請輸入醫(yī)生名稱', trigger: 'blur' }],
  title: [{ required: true, message: '請選擇職稱', trigger: 'change' }],
  tel: [{ pattern: reg_tel_phone, message: '請輸入正確的手機(jī)號或座機(jī)號', trigger: ['blur', 'change'] }]
},

注意：直接在vue模板中進(jìn)行單項驗證使用正則校驗時，需將RegExp定義成響應(yīng)式變量。