其他分享
首页 > 其他分享> > Element Ui使用技巧——Form表单的校验规则rules详细说明;element的 form 表单rules详细用法

Element Ui使用技巧——Form表单的校验规则rules详细说明;element的 form 表单rules详细用法

作者:互联网

介绍 

Form 组件提供了表单验证的功能,只需要通过 rules 属性传入约定的验证规则,并将 Form-Item的 prop 属性设置为需校验的字段名即可。校验规则参见 async-validator
文档中提及的用法有2种:

官方form 表单文档

https://element.eleme.io/#/zh-CN/component/form

1.对整个表单进行规则验证:

<el-form :model="ruleForm" status-icon :rules="rules" ref="ruleForm" label-width="100px" class="demo-ruleForm">
  <el-form-item label="密码" prop="pass">
    <el-input type="password" v-model="ruleForm.pass" autocomplete="off"></el-input>
  </el-form-item>
  <el-form-item label="确认密码" prop="checkPass">
    <el-input type="password" v-model="ruleForm.checkPass" autocomplete="off"></el-input>
  </el-form-item>
  ......
</el-form>
<script>
  export default {
    data() {
      ......
      var validatePass = (rule, value, callback) => {
        if (value === '') {
          callback(new Error('请输入密码'));
        } else {
          if (this.ruleForm.checkPass !== '') {
            this.$refs.ruleForm.validateField('checkPass');
          }
          callback();
        }
      };
      return {
        ruleForm: {
          pass: '',
          checkPass: '',
          age: ''
        },
        rules: {
          pass: [
            { validator: validatePass, trigger: 'blur' }
          ],
          ......
        }
      };
    },
    ......
  }
</script>
View Code

如上,在data中定义表单验证规则的对象数组rules(可以单独编写验证器函数),并直接绑定到表单标签的rules参数中。

其中,validator是单个表单域格式验证的验证器,一般是需要比较复杂的格式验证的时候才会用。如果是非空验证、数据类型验证或者正则表达式能处理的,都可以直接通过rules的type/Pattern等相关参数直接配置就好了。

2.对单个表单域进行验证:

 
<el-form :model="dynamicValidateForm" ref="dynamicValidateForm" label-width="100px" class="demo-dynamic">
  <el-form-item 
    label="邮箱"
    prop="email"
    :rules="[
      { required: true, message: '请输入邮箱地址', trigger: 'blur' },
      { type: 'email', message: '请输入正确的邮箱地址', trigger: ['blur', 'change'] }
    ]">
    <el-input v-model="dynamicValidateForm.email"></el-input>
  </el-form-item>
  <el-form-item
    v-for="(domain, index) in dynamicValidateForm.domains" :label="'域名' + index" :key="domain.key" 
    :prop="'domains.' + index + '.value'" 
    :rules="{
      required: true, message: '域名不能为空', trigger: 'blur'
    }">
    ......
</el-form>
<script>
  export default {
    data() {
      return {
        dynamicValidateForm: {
          domains: [{
            value: ''
          }],
          email: ''
        }
      };
    },
    ......
  }
</script>

  如上,对于单个表单域,可以直接对表单域的rules参数进行配置,来实现格式验证,这种方法一般比较适用于格式验证比较简单的情况。

如果需要进行验证的字段比较多,或者验证规则比较复杂,那么最好使用上边对整个表单进行验证的方式。

====================================================================================

表单验证规则rules的详细用法:

官方文档中的介绍太过粗略,下面单独介绍rules的用法,详细校验规则参见async-validator。

GitHub - yiminghe/async-validator: validate form asynchronous

线上Element UI的例子:

Element - The world's most popular Vue UI framework  页面 的

【表单验证】在防止用户犯错的前提下,尽可能让用户更早地发现并纠正错误。

重点 

Form 组件提供了表单验证的功能,只需要通过 rules 属性传入约定的验证规则,并将 Form-Item 的 prop 属性设置为需校验的字段名即可。校验规则参见 async-validator

<el-form :model="ruleForm" :rules="rules" ref="ruleForm" label-width="100px" class="demo-ruleForm">
  <el-form-item label="活动名称" prop="name">
    <el-input v-model="ruleForm.name"></el-input>
  </el-form-item>
  <el-form-item label="活动区域" prop="region">
    <el-select v-model="ruleForm.region" placeholder="请选择活动区域">
      <el-option label="区域一" value="shanghai"></el-option>
      <el-option label="区域二" value="beijing"></el-option>
    </el-select>
  </el-form-item>
  <el-form-item label="活动时间" required>
    <el-col :span="11">
      <el-form-item prop="date1">
        <el-date-picker type="date" placeholder="选择日期" v-model="ruleForm.date1" style="width: 100%;"></el-date-picker>
      </el-form-item>
    </el-col>
    <el-col class="line" :span="2">-</el-col>
    <el-col :span="11">
      <el-form-item prop="date2">
        <el-time-picker placeholder="选择时间" v-model="ruleForm.date2" style="width: 100%;"></el-time-picker>
      </el-form-item>
    </el-col>
  </el-form-item>
  <el-form-item label="即时配送" prop="delivery">
    <el-switch v-model="ruleForm.delivery"></el-switch>
  </el-form-item>
  <el-form-item label="活动性质" prop="type">
    <el-checkbox-group v-model="ruleForm.type">
      <el-checkbox label="美食/餐厅线上活动" name="type"></el-checkbox>
      <el-checkbox label="地推活动" name="type"></el-checkbox>
      <el-checkbox label="线下主题活动" name="type"></el-checkbox>
      <el-checkbox label="单纯品牌曝光" name="type"></el-checkbox>
    </el-checkbox-group>
  </el-form-item>
  <el-form-item label="特殊资源" prop="resource">
    <el-radio-group v-model="ruleForm.resource">
      <el-radio label="线上品牌商赞助"></el-radio>
      <el-radio label="线下场地免费"></el-radio>
    </el-radio-group>
  </el-form-item>
  <el-form-item label="活动形式" prop="desc">
    <el-input type="textarea" v-model="ruleForm.desc"></el-input>
  </el-form-item>
  <el-form-item>
    <el-button type="primary" @click="submitForm('ruleForm')">立即创建</el-button>
    <el-button @click="resetForm('ruleForm')">重置</el-button>
  </el-form-item>
</el-form>
<script>
  export default {
    data() {
      return {
        ruleForm: {
          name: '',
          region: '',
          date1: '',
          date2: '',
          delivery: false,
          type: [],
          resource: '',
          desc: ''
        },
        rules: {
          name: [
            { required: true, message: '请输入活动名称', trigger: 'blur' },
            { min: 3, max: 5, message: '长度在 3 到 5 个字符', trigger: 'blur' }
          ],
          region: [
            { required: true, message: '请选择活动区域', trigger: 'change' }
          ],
          date1: [
            { type: 'date', required: true, message: '请选择日期', trigger: 'change' }
          ],
          date2: [
            { type: 'date', required: true, message: '请选择时间', trigger: 'change' }
          ],
          type: [
            { type: 'array', required: true, message: '请至少选择一个活动性质', trigger: 'change' }
          ],
          resource: [
            { required: true, message: '请选择活动资源', trigger: 'change' }
          ],
          desc: [
            { required: true, message: '请填写活动形式', trigger: 'blur' }
          ]
        }
      };
    },
    methods: {
      submitForm(formName) {
        this.$refs[formName].validate((valid) => {
          if (valid) {
            alert('submit!');
          } else {
            console.log('error submit!!');
            return false;
          }
        });
      },
      resetForm(formName) {
        this.$refs[formName].resetFields();
      }
    }
  }
</script>

如上,rules中单个表单域校验规则可以包含多个数组,每个数组即是一条校验规则:

name: [
   { required: true, message: '请输入活动名称', trigger: 'blur' },
   { min: 3, max: 5, message: '长度在 3 到 5 个字符', trigger: 'blur' }
],
date1: [
   { type: 'date', required: true, message: '请选择日期', trigger: 'change' }
],

  数组中的单个检验规则对象中包含required/message/trigger/min/max等参数,这些参数配合起来,可以完成我们以往要编写多行代码才能实现的校验功能。下面就详细介绍这些参数。

参数说明

属性    类型    说明
type    String    用于验证数据类型,默认类型为’string’
required    boolean    是否必填
pattern    regexp/string    字段值匹配正则表达式才能通过验证
min和max    number    对于字符串和数组类型,将根据长度进行比较,对于数字类型,数字不得小于min,也不得大于max
len    number    对于字符串和数组类型,对length属性执行比较,对于数字类型,此属性指示数字的完全匹配,len属性与min和max属性组合,则len优先。
enum    array    type必须设置为enum,值必须包含在从可能值列表中才能通过验证
whitespace    boolean    type必须设置为string,要为仅包含空格的字符串可以将whitespace设置为true
transform    function    在验证之前转换值
defaultField    array/object    type为数组或对象类型时一起使用,用来验证数组或对象中包含的所有值,进行深层验证
fields    object    type为数组或对象类型时一起使用,分别验证array/object类型的数据中的值,实现深度验证
validator    function    验证器,可以为指定字段自定义验证函数:function(rule, value, callback)
asyncValidator    function    异步验证器,可以为指定字段自定义异步验证函数 function(rule, value, callback)
message    string/jsx/function等    根据需要将消息分配给规则

type:
表明要使用验证器的类型,类似数据格式检验,其中还有email、url、regexp、method等特定格式字段的验证。

使用这个,我们就可以对一些特定的字段进行校验,而不用再像以前一样写正则,做判断。

比如只需要配置 type:‘email’ 的规则就可以验证email了,验证器都已经封装好了这些功能,你只需调用就可以了。

可识别的类型值有:

string: 字符串类型(默认值)
number: 数字类型
boolean:布尔类型
method: 函数类型
regexp:正则表达式
integer: 整型
float: 双精度浮点型数字
array: 数组类型
object: 对象类型
enum: 枚举值
date: 日期格式
url: 网址格式
hex: 16进制数字
email: 电子邮箱格式
any: 任意类型
验证电子邮箱的完整示例代码:

如上,实现了文本框失去焦点进行非空检验,失去焦点、内容改变进行格式验证,并给出相应提示,是不是比我们以前用原生js来实现简单明了多了呢。

required:
必填字段,即非空验证。如上面实例中的的非空验证,以及邮箱前边的必填符号*,就是这个参数的功劳。

pattern:
正则表达式,如果需要验证手机号码之类,可以直接编写正则表达式配置到校验规则中,那么就不需要自己去校验了,由校验器自动校验。

{ type : "string" , required: true , pattern : /^[a-z]+$/ }

min/max:

判断数据大小范围,通常对数字大小范围做校验。对于字符串和数组类型,将根据长度进行比较。

{ required: true, message: '请输入活动名称', trigger: 'blur' },
{ min: 3, max: 5, message: '长度在 3 到 5 个字符', trigger: 'blur' }

  

len:

长度验证,如11位手机号码。

roles: {
    type: "array", required: true, len: 11
}

enum:

枚举值验证,示例代码如下:

role: {type: "enum", enum: ['admin', 'user', 'guest']}

 

whitespace:

验证是否只有空格(如果没有该配置,则全空格的输入值也是有效的)

whitespace: [{
    type: "string",
    message: '只存在空格',
    whitespace:true,
    trigger: ['change', 'blur']
}]

 

transform:

有时有必要在验证之前转换值,以强制或以某种方式对其进行清理。为此 transform ,向验证规则添加一个功能。在验证之前,先转换属性,然后将其重新分配给源对象,以更改该属性的值。

// 校验
transform: [
 {
    type: 'enum',
    enum: [2,4,6], 
    message: `结果不存在`, 
    trigger: ['change', 'blur'],
    transform(value) {
      return Number(value * 2)
    }
  }
]

如上,只有输入1、2、3的时候才能校验通过。

貌似这个只能辅助校验,并不能改变组件绑定变量本身的值。

fields:

深层规则,可以通过将嵌套规则分配给规则的属性来验证object或array类型的验证规则,如地址对象的省市区的规则验证:

object类型:

address: {
    type: "object", required: true,
    fields: {
      street: {type: "string", required: true},
      city: {type: "string", required: true},
      zip: {type: "string", required: true, len: 8, message: "invalid zip"}
    }
  }

array类型:

 roles: {
    type: "array", required: true, len: 3,
    fields: {
      0: {type: "string", required: true},
      1: {type: "string", required: true},
      2: {type: "string", required: true}
    }
  }

messages:

未通过校验的提示信息

{name:{type: "string", required: true, message: "Name is required"}}

支持html:

{name:{type: "string", required: true, message: "<b>Name is required</b>"}}

支持vue-i18n:

{name:{type: "string", required: true, message: () => this.$t( 'name is required' )}}

 

validator:

可以为指定字段自定义验证函数——这就相当于把前边配置的东西用js按照以前的方式编写验证逻辑了。虽然麻烦点,但是能实现比较复杂的业务逻辑判断。

简单的用法:

  field: {
    validator(rule, value, callback) {
      return value === 'test';
    },
    message: 'Value is not equal to "test".',
  }

还可以这样用:

......    
data() {
      const checkAge = (rule, value, callback) => {
        if(!value) {
          return callback(new Error('年龄不能为空'));
        }
        setTimeout(() => {
          if(!Number.isInteger(value)) {
            callback(new Error('请输入数字值'));
          } else {
            if(value < 18) {
              callback(new Error('必须年满18岁'));
            } else {
              callback();
            }
          }
        }, 1000);
      };
      return {
        ruleForm: {
          age: 11
        },
        rules: {          
          age: [{
            type: 'number',
            required: true,
            validator: checkAge,
            trigger: ['blur', 'change']
          }]
        }
      };
}
......

小结:

如上,官方介绍的比较常用的验证规则也就是这些了,如果有比较复杂的逻辑判断可以直接通过编写validator来实现就好了。

转载: https://www.cnblogs.com/xyyt/p/13366812.html 、https://blog.csdn.net/cplvfx/article/details/125329481

 

搜索

复制

标签:验证,rules,true,required,校验,表单,详细,message,type
来源: https://www.cnblogs.com/j-a-h/p/16613756.html