欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Vue2.0表单校验组件vee-validate的使用详解

程序员文章站 2022-05-14 16:06:28
vee-validate使用教程 本文适合有一定vue2.0基础的同学参考,根据项目的实际情况来使用,关于vue的使用不做多余解释。本人也是一边学习一边使用,如果错误之处...

vee-validate使用教程

本文适合有一定vue2.0基础的同学参考,根据项目的实际情况来使用,关于vue的使用不做多余解释。本人也是一边学习一边使用,如果错误之处敬请批评指出*

一、安装

npm install vee-validate@next --save

注意:@next,不然是vue1.0版本

bower install vee-validate#2.0.0-beta.13 --save

二、引用

import vue from 'vue';
import veevalidate from 'vee-validate';
vue.use(veevalidate);

组件设置:

import veevalidate, { validator } from 'vee-validate';
import messages from 'assets/js/zh_cn';
validator.updatedictionary({
  zh_cn: {
    messages
  }
});
const config = {
  errorbagname: 'errors', // change if property conflicts.
  delay: 0,
  locale: 'zh_cn',
  messages: null,
  strict: true
};
vue.use(veevalidate,config);

assets/js/zh_cn 代表你存放语言包的目录,从node_modules/vee-validate/dist/locale目录下面拷贝到你的项目

validator还有更多应用,下面再讲。

config其它参数,delay代表输入多少ms之后进行校验,messages代表自定义校验信息,strict=true代表没有设置规则的表单不进行校验,errorbagname属于高级应用,自定义errors,待研究

三、基础使用

<div class="column is-12">
  <label class="label" for="email">email</label>
  <p class="control">
    <input v-validate data-rules="required|email" :class="{'input': true, 'is-danger': errors.has('email') }" name="email" type="text" placeholder="email">
    <span v-show="errors.has('email')" class="help is-danger">{{ errors.first('email') }}</span>
  </p>
</div>

提醒:错误信息里面的名称通常就是表单的name属性,除非是通过vue实例传递进来的。

提醒:养成好习惯,给每个field添加name属性,如果没有name属性又没有对值进行绑定的话,validator可能不会对其进行正确的校验

关于errors:

上面的代码我们看到有errors.has,errors.first,errors是组件内置的一个数据模型,用来存储和处理错误信息,可以调用以下方法:

  1. errors.first('field') - 获取关于当前field的第一个错误信息
  2. collect('field') - 获取关于当前field的所有错误信息(list)
  3. has('field') - 当前filed是否有错误(true/false)
  4. all() - 当前表单所有错误(list)
  5. any() - 当前表单是否有任何错误(true/false)
  6. add(string field, string msg) - 添加错误
  7. clear() - 清除错误
  8. count() - 错误数量
  9. remove(string field) - 清除指定filed的所有错误

关于validator

validator是以$validator被组件自动注入到vue实例的。同时也可以独立的进行调用,用来手动检查表单是否合法,以传入一个对象的方式,遍历其中指定的field。

import { validator } from 'vee-validate';
const validator = new validator({
  email: 'required|email',
  name: 'required|alpha|min:3',
}); 
// or validator.create({ ... });

你也可以在构造了validator之后设置对象参数

import { validator } from 'vee-validate';
const validator = new validator();

validator.attach('email', 'required|email'); // attach field.
validator.attach('name', 'required|alpha', 'full name'); // attach field with display name for error generation.

validator.detach('email'); // you can also detach fields.

最后你也可以直接传值给field,测试是否可以通过校验,像这样:

validator.validate('email', 'foo@bar.com'); // true
validator.validate('email', 'foo@bar'); // false
//或者同时校验多个:
validator.validateall({
  email: 'foo@bar.com',
  name: 'john snow'
});
//只要有一个校验失败了,就返回false

四、内置的校验规则

  1. after{target} - 比target要大的一个合法日期,格式(dd/mm/yyyy)
  2. alpha - 只包含英文字符
  3. alpha_dash - 可以包含英文、数字、下划线、破折号
  4. alpha_num - 可以包含英文和数字
  5. before:{target} - 和after相反
  6. between:{min},{max} - 在min和max之间的数字
  7. confirmed:{target} - 必须和target一样
  8. date_between:{min,max} - 日期在min和max之间
  9. date_format:{format} - 合法的format格式化日期
  10. decimal:{decimals?} - 数字,而且是decimals进制
  11. digits:{length} - 长度为length的数字
  12. dimensions:{width},{height} - 符合宽高规定的图片
  13. email - 不解释
  14. ext:[extensions] - 后缀名
  15. image - 图片
  16. in:[list] - 包含在数组list内的值
  17. ip - ipv4地址
  18. max:{length} - 最大长度为length的字符
  19. mimes:[list] - 文件类型
  20. min - max相反
  21. mot_in - in相反
  22. numeric - 只允许数字
  23. regex:{pattern} - 值必须符合正则pattern
  24. required - 不解释
  25. size:{kb} - 文件大小不超过
  26. url:{domain?} - (指定域名的)url

五、自定义校验规则

1.直接定义

const validator = (value, args) => {
  // return a boolean or a promise.
}
//最基本的形式,只返回布尔值或者promise,带默认的错误提示

2.对象形式

const validator = {
  getmessage(field, args) { // 添加到默认的英文错误消息里面
    // returns a message.
  },
  validate(value, args) {
    // returns a boolean or a promise.
  }
};

3.添加到指定语言的错误消息

const validator = {
  messages: {
    en: (field, args) => {
      // 英文错误提示
    },
    cn: (field, args) => {
      // 中文错误提示
    }
  },
  validate(value, args) {
    // returns a boolean or a promise.
  }
};

创建了规则之后,用extend方法添加到validator里面

import { validator } from 'vee-validate';
const ismobile = {
  messages: {
    en:(field, args) => field + '必须是11位手机号码',
  },
  validate: (value, args) => {
    return value.length == 11 && /^((13|14|15|17|18)[0-9]{1}\d{8})$/.test(value)
  }
}
validator.extend('mobile', ismobile);

//或者直接

validator.extend('mobile', {
  messages: {
   en:field => field + '必须是11位手机号码',
  },
  validate: value => {
   return value.length == 11 && /^((13|14|15|17|18)[0-9]{1}\d{8})$/.test(value)
  }
});

然后接可以直接把mobile当成内置规则使用了:

<input v-validate data-rules="required|mobile" :class="{'input': true, 'is-danger': errors.has('mobile') }" name="mobile" type="text" placeholder="mobile">
<span v-show="errors.has('mobile')" class="help is-danger">{{ errors.first('mobile') }}</span>

4.自定义内置规则的错误信息

import { validator } from 'vee-validate';

const dictionary = {
  en: {
    messages: {
      alpha: () => 'some english message'
    }
  },
  cn: {
    messages: {
      alpha: () => '对alpha规则的错误定义中文描述'
    }
  }
};

validator.updatedictionary(dictionary);

暂时介绍到这里,应该已经上手了,有空再继续翻译。

其它问题或者更高级应用,请参考官方文档vee-validate

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。