jQuery Validation Plugin学习

http://blog.csdn.net/violet_day/article/details/14109261

jQuery Validation Plugin

Demo

一、默认校验规则

(1)required:true                必输字段
(2)remote:"check.php"      使用ajax方法调用check.php验证输入值
(3)email:true                    必须输入正确格式的电子邮件
(4)url:true                        必须输入正确格式的网址
(5)date:true                      必须输入正确格式的日期 日期校验ie6出错，慎用
(6)dateISO:true                必须输入正确格式的日期(ISO)，例如：2009-06-23，1998/01/22 只验证格式，不验证有效性
(7)number:true                 必须输入合法的数字(负数，小数)
(8)digits:true                    必须输入整数
(9)creditcard:                   必须输入合法的信用卡号
(10)equalTo:"#field"          输入值必须和#field相同
(11)accept:                       输入拥有合法后缀名的字符串（上传文件的后缀）
(12)maxlength:5               输入长度最多是5的字符串(汉字算一个字符)
(13)minlength:10              输入长度最小是10的字符串(汉字算一个字符)
(14)rangelength:[5,10]      输入长度必须介于 5 和 10 之间的字符串")(汉字算一个字符)
(15)range:[5,10]               输入值必须介于 5 和 10 之间
(16)max:5                        输入值不能大于5
(17)min:10                       输入值不能小于10

二、修改默认的提示

jQuery.extend(jQuery.validator.messages, {
    required: "必选字段",
    remote: "请修正该字段",
    email: "请输入正确格式的电子邮件",
    url: "请输入合法的网址",
    date: "请输入合法的日期",
    dateISO: "请输入合法的日期 (ISO).",
    number: "请输入合法的数字",
    digits: "只能输入整数",
    creditcard: "请输入合法的信用卡号",
    equalTo: "请再次输入相同的值",
    accept: "请输入拥有合法后缀名的字符串",
    maxlength: jQuery.validator.format("请输入一个 长度最多是 {0}的字符串"),
    minlength: jQuery.validator.format("请输入一个 长度最少是 {0}的字符串"),
    rangelength: jQuery.validator.format("请输入 一个长度介于 {0}和 {1}之间的字符串"),
    range: jQuery.validator.format("请输入一个介于 {0}和 {1}之间的值"),
    max: jQuery.validator.format("请输入一个最大为{0}的值"),
    min: jQuery.validator.format("请输入一个最小为{0}的值")
});

上述代码存至message_cn.js中并添加引用即可

三、常用的方法

1.用其他方式替代默认的SUBMIT

$().ready(function(){
    $("#signupForm").validate({
        submitHandler: function(form){
            alert("submitted");
            form.submit();
        }
    });
});

使用ajax方式

$(".selector").validate({
    submitHandler: function(form){
        $(form).ajaxSubmit();
    }
})

 可以设置validate的默认值，写法如下：

$.validator.setDefaults({
    submitHandler: function(form){
        alert("submitted!");
        form.submit();
    }
});

如果想提交表单, 需要使用form.submit()而不要使用$(form).submit()

2.debug，只验证不提交表单
如果这个参数为true，那么表单不会提交，只进行检查，调试时十分方便

$().ready(function(){
    $("#signupForm").validate({
        debug: true
    });
});

如果一个页面中有多个表单都想设置成为debug，用

$.validator.setDefaults({
    debug: true
})

3.ignore：忽略某些元素不验证

ignore: ".ignore"

4.更改错误信息显示的位置
errorPlacement：Callback

Default: 把错误信息放在验证的元素后面 
指明错误放置的位置，默认情况是：error.appendTo(element.parent());即把错误信息放在验证的元素后面 

errorPlacement: function(error, element){
    error.appendTo(element.parent());
}

errorClass：String  Default: "error" 
指定错误提示的css类名，可以自定义错误提示的样式

errorElement：String  Default: "label" 
用什么标签标记错误，默认的是label你可以改成em

errorContainer：Selector 
显示或者隐藏验证信息，可以自动实现有错误信息出现时把容器属性变为显示，无错误时隐藏，用处不大
errorContainer: "#messageBox1, #messageBox2"

errorLabelContainer：Selector
把错误信息统一放在一个容器里面。

wrapper：String
用什么标签再把上边的errorELement包起来

一般这三个属性同时使用，实现在一个容器内显示所有错误提示的功能，并且没有信息时自动隐藏

errorContainer: "div.error",
errorLabelContainer: $("#signupForm div.error"),
wrapper: "li"

官方demo

5.更改错误信息显示的样式

设置错误提示的样式，可以增加图标显示，在该系统中已经建立了一个validation.css专门用于维护校验文件的样式

input.error {
    border: 1px solid red;
}

label.error {
    background: url("./demo/images/unchecked.gif") no-repeat 0px 0px;
    padding-left: 16px;
    padding-bottom: 2px;
    font-weight: bold;
    color: #EA5200;
}

label.checked {
    background: url("./demo/images/checked.gif") no-repeat 0px 0px;
}

6.每个字段验证通过执行函数success：String,Callback

要验证的元素通过验证后的动作，如果跟一个字符串，会当做一个css类，也可跟一个函数

success: function(label){
    // set   as text for IE
    label.html(" ").addClass("checked");
    //label.addClass("valid").text("Ok!")
}

添加"valid" 到验证元素, 在CSS中定义的样式<style>label.valid {}</style>
success: "valid"

7.验证的触发方式修改
下面的虽然是boolean型的，但建议除非要改为false,否则别乱添加。

onsubmit：Boolean  Default: true 
提交时验证. 设置唯false就用其他方法去验证
onfocusout：Boolean  Default: true 
失去焦点是验证(不包括checkboxes/radio buttons)
onkeyup：Boolean  Default: true 
在keyup时验证.
onclick：Boolean  Default: true 
在checkboxes 和 radio 点击时验证
focusInvalid：Boolean  Default: true 
提交表单后，未通过验证的表单(第一个或提交之前获得焦点的未通过验证的表单)会获得焦点
focusCleanup：Boolean  Default: false 
如果是true那么当未通过验证的元素获得焦点时，移除错误提示。避免和 focusInvalid 一起用

// 清除表单的错误验证信息
$().ready(function(){
    var validator = $("#signupForm").validate({
        submitHandler: function(form){
            alert("submitted");
            form.submit();
        }
    });
    $("#reset").click(function(){
        validator.resetForm();
    });
});

8.异步验证
remote：URL
使用ajax方式进行验证，默认会提交当前验证的值到远程地址，如果需要提交其他的值，可以使用data选项

remote: "check-email.php"
//服务器端会默认接受name和value
remote: {
    url: "check-email.php",     //后台处理程序
    type: "post",               //数据发送方式
    dataType: "json",           //接受数据格式
    data: {                     //要传递的数据
        username: function() {
            return $("#username").val();//必须写成函数形式，否则取不到最新的值
        }
    }
}

远程地址只能输出 "true" 或 "false"，不能有其它输出

9.添加自定义校验
addMethod：name, method, message
自定义验证方法

// 中文字两个字节
jQuery.validator.addMethod("byteRangeLength", function(value, element, param){
    var length = value.length;
    for (var i = 0; i < value.length; i++) {
        if (value.charCodeAt(i) > 127) {
            length++;
        }
    }
    return this.optional(element) || (length >= param[0] && length <= param[1]);
}, $.validator.format("请确保输入的值在{0}-{1}个字节之间(一个中文字算2个字节)"));

// 邮政编码验证
jQuery.validator.addMethod("isZipCode", function(value, element){
    var tel = /^[0-9]{6}$/;
    return this.optional(element) || (tel.test(value));
}, "请正确填写您的邮政编码");

1.要在additional-methods.js文件中添加或者在jquery.validate.js添加建议一般写在additional-methods.js文件中

2.在messages_cn.js文件添加：isZipCode: "只能包括中文字、英文字母、数字和下划线",

调用前要添加对additional-methods.js文件的引用。

10.动态修改验证规则

$("#myinput").rules("add", {
    minlength: 2
});

$("#myinput").rules("add", {
    required: true,
    minlength: 2,
    messages: {
        required: "Required input",
        minlength: jQuery.format("Please, at least {0} characters are necessary")
    }
});

$("#myinput").rules("remove");

$("#myinput").rules("remove", "min max");

四、API文档

名称	返回类型	描述
validate(options)	返回:Validator	验证所选的FORM
valid()	返回:Boolean	检查是否验证通过
rules()	返回:Options	返回元素的验证规则
rules("add",rules)	返回:Options	增加验证规则
rules("remove",rules)	返回:Options	删除验证规则
removeAttrs(attributes)	返回:Options	删除特殊属性并且返回他们
Custom selectors
:blank	返回:Validator	没有值的筛选器
:filled	返回:Array <Element >	有值的筛选器
:unchecked	返回:Array <Element >	没选择的元素的筛选器
Utilities
jQuery.format (template,argument ,argumentN...)	返回:String	用参数代替模板中的 {n}

 

 

Validator:
validate方法返回一个Validator对象,它有很多方法,让你能使用引发校验程序或者改变form的内容. validator对象有很多方法,但下面只是列出常用的
form()	返回:Boolean	验证form返回成功还是失败
element(element)	返回:Boolean	验证单个元素是成功还是失败
resetForm()	返回:undefined	把前面验证的FORM恢复到验证前原来的状态
showErrors(errors)	返回:undefined	显示特定的错误信息
Validator functions:
setDefaults(defaults)	返回:undefined	改变默认的设置
addMethod(name,method,message)	返回:undefined	添加一个新的验证方法.必须包括一个独一无二的名字,一个JAVASCRIPT的方法和一个默认的信息
addClassRules(name,rules)	返回:undefined	增加组合验证类型 在一个类里面用多种验证方法里比较有用
addClassRules(rules)	返回:undefined	增加组合验证类型 在一个类里面用多种验证方法里比较有用,这个是一下子加多个

 

 

内置验证方式：
required()	返回:Boolean	必填验证元素
required(dependency-expression)	返回:Boolean	必填元素依赖于表达式的结果
required(dependency-callback)	返回:Boolean	必填元素依赖于回调函数的结果
remote(url)	返回:Boolean	请求远程校验。url通常是一个远程调用方法
minlength(length)	返回:Boolean	设置最小长度
maxlength(length)	返回:Boolean	设置最大长度
rangelength(range)	返回:Boolean	设置一个长度范围[min,max]
min(value)	返回:Boolean	设置最大值
max(value)	返回:Boolean	设置最小值
email()	返回:Boolean	验证电子邮箱格式
range(range)	返回:Boolean	设置值的范围
url()	返回:Boolean	验证URL格式
date()	返回:Boolean	验证日期格式(类似30/30/2008的格式,不验证日期准确性只验证格式)
dateISO()	返回:Boolean	验证ISO类型的日期格式
dateDE()	返回:Boolean	验证德式的日期格式（29.04.1994 or 1.1.2006）
number()	返回:Boolean	验证十进制数字（包括小数的）
digits()	返回:Boolean	验证整数
creditcard()	返回:Boolean	验证信用卡号
accept(extension)	返回:Boolean	验证相同后缀名的字符串
equalTo(other)	返回:Boolean	验证两个输入框的内容是否相同
phoneUS()	返回:Boolean	验证美式的电话号码

 

 

validate ()的可选项：
debug:进行调试模式（表单不提交）:	$(".selector").validate ({   debug:true })
把调试设置为默认:	$.validator.setDefaults({   debug:true })
submitHandler: 通过验证后运行的函数,里面要加上表单提交的函数,否则表单不会提交	$(".selector").validate({   submitHandler:function(form) { $(form).ajaxSubmit();   } })
ignore: 对某些元素不进行验证	$("#myform").validate({   ignore:".ignore" })
rules: 自定义规则,key:value的形式,key是要验证的元素,value可以是字符串或对象	$(".selector").validate({   rules:{     name:"required",     email:{       required:true,       email:true     }   } })
messages: 自定义的提示信息key:value的形式key是要验证的元素,值是字符串或函数	$(".selector").validate({   rules:{     name:"required",     email:{       required:true,       email:true     }   },   messages:{     name:"Name不能为空",     email:{       required:"E-mail不能为空",       email:"E-mail地址不正确"     }   } })
groups: 对一组元素的验证,用一个错误提示,用error Placement控制把出错信息放在哪里	$("#myform").validate({  groups:{    username:"fname lname"  },  errorPlacement:function(error,element) {     if (element.attr("name") == "fname" || element.attr("name") == "lname")       error.insertAfter("#lastname");     else       error.insertAfter(element);   },   debug:true })
Onubmit Boolean默认:true 是否提交时验证	$(".selector").validate({   onsubmit:false })
onfocusout Boolean默认:true  是否在获取焦点时验证	$(".selector").validate({   onfocusout:false })
onkeyup Boolean默认:true  是否在敲击键盘时验证	$(".selector").validate({   onkeyup:false })
onclick Boolean默认:true 是否在鼠标点击时验证（一般验证checkbox,radiobox）	$(".selector").validate({   onclick:false })
focusInvalid Boolean默认:true 提交表单后,未通过验证的表单(第一个或提交之前获得焦点的未通过验证的表单)会获得焦点	$(".selector").validate({   focusInvalid:false })
focusCleanup Boolean默认:false 当未通过验证的元素获得焦点时,并移除错误提示（避免和 focusInvalid.一起使用）	$(".selector").validate({   focusCleanup:true })
errorClass String默认:"error" 指定错误提示的css类名,可以自定义错误提示的样式	$(".selector").validate({   errorClass:"invalid" })
errorElement String默认:"label" 使用什么标签标记错误	$(".selector").validate   errorElement:"em" })
wrapper String 使用什么标签再把上边的errorELement包起来	$(".selector").validate({   wrapper:"li" })
errorLabelContainer Selector 把错误信息统一放在一个容器里面	$("#myform").validate({   errorLabelContainer:"#messageBox",   wrapper:"li",   submitHandler:function() { alert("Submitted!") } })
showErrors: 跟一个函数,可以显示总共有多少个未通过验证的元素	$(".selector").validate({   showErrors:function(errorMap,errorList) {        $("#summary").html("Your form contains " + this.numberOfInvalids() + " errors,see details below.");        this.defaultShowErrors();   } })
errorPlacement: 跟一个函数,可以自定义错误放到哪里	$("#myform").validate({  rrorPlacement:function(error,element) { error.appendTo(element.parent("td").next("td"));   },   debug:true   })
success: 要验证的元素通过验证后的动作,如果跟一个字符串,会当做一个css类,也可跟一个函数	$("#myform").validate({        success:"valid",        submitHandler:function() { alert("Submitted!") } })
highlight: 可以给未通过验证的元素加效果,闪烁等

 

 

addMethod(name,method,message)方法：

参数name是添加的方法的名字

参数method是一个函数,接收三个参数(value,element,param) value是元素的值,element是元素本身param是参数,我们可以用addMethod来添加除built-in Validation methods之外的验证方法 比如有一个字段,只能输一个字母,范围是a-f,写法如下:

 

$.validator.addMethod("af",function(value,element,params){

  if(value.length>1){

   return false;

  }

  if(value>=params[0] && value<=params[1]){

   return true;

  }else{

   return false;

  }

},"必须是一个字母,且a-f");

用的时候,比如有个表单字段的id="username",则在rules中写

username:{

  af:["a","f"]

}

 

addMethod的第一个参数,就是添加的验证方法的名子,这时是af

addMethod的第三个参数,就是自定义的错误提示,这里的提示为:"必须是一个字母,且a-f"

addMethod的第二个参数,是一个函数,这个比较重要,决定了用这个验证方法时的写法

如果只有一个参数,直接写,如果af:"a",那么a就是这个唯一的参数,如果多个参数,用在[]里,用逗号分开

 

meta String方式：

$("#myform").validate({

  meta:"validate",

  submitHandler:function() { alert("Submitted!") }

})

<script type="text/javascript" src="js/jquery.metadata.js"></script>

<script type="text/javascript" src="js/jquery.validate.js"></script>

<form id="myform">

 <input type="text" name="email" class="{validate:{ required:true,email:true }}" />

 <input type="submit" value="Submit" />

</form>