jQuery表单验证插件——jquery.validate.js
官网地址:http://bassistance.de/jquery-plugins/jquery-plugin-validation
一、导入js库
1 <script src="../js/jquery.js" type="text/javascript"></script> 2 <script src="../js/jquery.validate.js" type="text/javascript"></script>
二、默认校验规则
(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
三、默认的提示
messages: { required: "This field is required.", remote: "Please fix this field.", email: "Please enter a valid email address.", url: "Please enter a valid URL.", date: "Please enter a valid date.", dateISO: "Please enter a valid date (ISO).", dateDE: "Bitte geben Sie ein g眉ltiges Datum ein.", number: "Please enter a valid number.", numberDE: "Bitte geben Sie eine Nummer ein.", digits: "Please enter only digits", creditcard: "Please enter a valid credit card number.", equalTo: "Please enter the same value again.", accept: "Please enter a value with a valid extension.", maxlength: $.validator.format("Please enter no more than {0} characters."), minlength: $.validator.format("Please enter at least {0} characters."), rangelength: $.validator.format("Please enter a value between {0} and {1} characters long."), range: $.validator.format("Please enter a value between {0} and {1}."), max: $.validator.format("Please enter a value less than or equal to {0}."), min: $.validator.format("Please enter a value greater than or equal to {0}.") },
如需要修改,可在js代码中加入:
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} 的值") });
推荐做法,将此文件放入messages_cn.js中,在页面中引入
1 <script src="../js/messages_cn.js" type="text/javascript"></script>
四、使用方式
1.将校验规则写到控件中
1 <script src="../js/jquery.js" type="text/javascript"></script> 2 <script src="../js/jquery.validate.js" type="text/javascript"></script> 3 <script src="./js/jquery.metadata.js" type="text/javascript"></script> 4 5 6 $().ready(function() { 7 $("#signupForm").validate(); 8 }); 9 10 11 <form id="signupForm" method="get" action=""> 12 <p> 13 <label for="firstname">Firstname</label> 14 <input id="firstname" name="firstname" class="required" /> 15 </p> 16 <p> 17 <label for="email">E-Mail</label> 18 <input id="email" name="email" class="required email" /> 19 </p> 20 <p> 21 <label for="password">Password</label> 22 <input id="password" name="password" type="password" class="{required:true,minlength:5}" /> 23 </p> 24 <p> 25 <label for="confirm_password">确认密码</label> 26 <input id="confirm_password" name="confirm_password" type="password" class="{required:true,minlength:5,equalTo:'#password'}" /> 27 </p> 28 <p> 29 <input class="submit" type="submit" value="Submit"/> 30 </p> 31 </form>
使用class="{}"的方式,必须引入包:jquery.metadata.js
可以使用如下的方法,修改提示内容:
class="{required:true,minlength:5,messages:{required:'请输入内容'}}"
在使用equalTo关键字时,后面的内容必须加上引号,如下代码:
class="{required:true,minlength:5,equalTo:'#password'}"
2.将校验规则写到js代码中
1 $().ready(function() { 2 $("#signupForm").validate({ 3 rules: { 4 firstname: "required", 5 email: { 6 required: true, 7 email: true 8 }, 9 password: { 10 required: true, 11 minlength: 5 12 }, 13 confirm_password: { 14 required: true, 15 minlength: 5, 16 equalTo: "#password" 17 } 18 }, 19 messages: { 20 firstname: "请输入姓名", 21 email: { 22 required: "请输入Email地址", 23 email: "请输入正确的email地址" 24 }, 25 password: { 26 required: "请输入密码", 27 minlength: jQuery.format("密码不能小于{0}个字 符") 28 }, 29 confirm_password: { 30 required: "请输入确认密码", 31 minlength: "确认密码不能小于5个字符", 32 equalTo: "两次输入密码不一致不一致" 33 } 34 } 35 }); 36 });
//messages处,如果某个控件没有message,将调用默认的信息
1 <form id="signupForm" method="get" action=""> 2 <p> 3 <label for="firstname">Firstname</label> 4 <input id="firstname" name="firstname" /> 5 </p> 6 <p> 7 <label for="email">E-Mail</label> 8 <input id="email" name="email" /> 9 </p> 10 <p> 11 <label for="password">Password</label> 12 <input id="password" name="password" type="password" /> 13 </p> 14 <p> 15 <label for="confirm_password">确认密码</label> 16 <input id="confirm_password" name="confirm_password" type="password" /> 17 </p> 18 <p> 19 <input class="submit" type="submit" value="Submit"/> 20 </p> 21 </form>
required:true 必须有值
required:"#aa:checked"表达式的值为真,则需要验证
required:function(){}返回为真,表示需要验证
后边两种常用于,表单中需要同时填或不填的元素
五、常用方法及注意问题
1.用其他方式替代默认的SUBMIT
1 $().ready(function() { 2 $("#signupForm").validate({ 3 submitHandler:function(form){ 4 alert("submitted"); 5 form.submit(); 6 } 7 }); 8 });
使用ajax方式
1 $(".selector").validate({ 2 submitHandler: function(form) 3 { 4 $(form).ajaxSubmit(); 5 } 6 });
可以设置validate的默认值,写法如下:
1 $.validator.setDefaults({ 2 submitHandler: function(form) { alert("submitted!");form.submit(); } 3 });
如果想提交表单, 需要使用form.submit()而不要使用$(form).submit()
2.debug,只验证不提交表单
如果这个参数为true,那么表单不会提交,只进行检查,调试时十分方便
1 $().ready(function() { 2 $("#signupForm").validate({ 3 debug:true 4 }); 5 });
如果一个页面中有多个表单都想设置成为debug,用
1 $.validator.setDefaults({ 2 debug: true 3 })
3.ignore:忽略某些元素不验证
1 ignore: ".ignore"
4.更改错误信息显示的位置
1 errorPlacement:Callback
Default: 把错误信息放在验证的元素后面
指明错误放置的位置,默认情况是:error.appendTo(element.parent());即把错误信息放在验证的元素后面
1 errorPlacement: function(error, element) { 2 error.appendTo(element.parent()); 3 }
//示例:
1 <tr> 2 <td class="label"><label id="lfirstname" for="firstname">First Name</label></td> 3 <td class="field"><input id="firstname" name="firstname" type="text" value="" maxlength="100" /></td> 4 <td class="status"></td> 5 </tr> 6 <tr> 7 <td style="padding-right: 5px;"> 8 <input id="dateformat_eu" name="dateformat" type="radio" value="0" /> 9 <label id="ldateformat_eu" for="dateformat_eu">14/02/07</label> 10 </td> 11 <td style="padding-left: 5px;"> 12 <input id="dateformat_am" name="dateformat" type="radio" value="1" /> 13 <label id="ldateformat_am" for="dateformat_am">02/14/07</label> 14 </td> 15 <td></td> 16 </tr> 17 <tr> 18 <td class="label"> </td> 19 <td class="field" colspan="2"> 20 <div id="termswrap"> 21 <input id="terms" type="checkbox" name="terms" /> 22 <label id="lterms" for="terms">I have read and accept the Terms of Use.</label> 23 </div> 24 </td> 25 </tr> 26 27 errorPlacement: function(error, element) { 28 if ( element.is(":radio") ) 29 error.appendTo( element.parent().next().next() ); 30 else if ( element.is(":checkbox") ) 31 error.appendTo ( element.next() ); 32 else 33 error.appendTo( element.parent().next() ); 34 }
代码的作用是:一般情况下把错误信息显示在<td class="status"></td>中,如果是radio显示在<td></td>中,如果是 checkbox显示在内容的后面
1 errorClass:String Default: "error"
指定错误提示的css类名,可以自定义错误提示的样式
1 errorElement:String Default: "label"
用什么标签标记错误,默认的是label你可以改成em
1 errorContainer:Selector
显示或者隐藏验证信息,可以自动实现有错误信息出现时把容器属性变为显示,无错误时隐藏,用处不大
1 errorContainer: "#messageBox1, #messageBox2"
1 errorLabelContainer:Selector
把错误信息统一放在一个容器里面。
1 wrapper:String
用什么标签再把上边的errorELement包起来
一般这三个属性同时使用,实现在一个容器内显示所有错误提示的功能,并且没有信息时自动隐藏
1 errorContainer: "div.error", 2 errorLabelContainer: $("#signupForm div.error"), 3 wrapper: "li"
5.更改错误信息显示的样式
设置错误提示的样式,可以增加图标显示,在该系统中已经建立了一个validation.css专门用于维护校验文件的样式
1 input.error { border: 1px solid red; } 2 label.error { 3 background:url("./demo/images/unchecked.gif") no-repeat 0px 0px; 4 5 padding-left: 16px; 6 7 padding-bottom: 2px; 8 9 font-weight: bold; 10 11 color: #EA5200; 12 } 13 label.checked { 14 background:url("./demo/images/checked.gif") no-repeat 0px 0px; 15 }
6.每个字段验证通过执行函数
1 success:String,Callback
要验证的元素通过验证后的动作,如果跟一个字符串,会当做一个css类,也可跟一个函数
1 success: function(label) { 2 // set as text for IE 3 label.html(" ").addClass("checked"); 4 //label.addClass("valid").text("Ok!") 5 }
添加"valid" 到验证元素, 在CSS中定义的样式<style>label.valid {}</style>
1 success: "valid"
7.验证的触发方式修改
下面的虽然是boolean型的,但建议除非要改为false,否则别乱添加。
1 onsubmit:Boolean Default: true
提交时验证. 设置唯false就用其他方法去验证
1 onfocusout:Boolean Default: true
失去焦点是验证(不包括checkboxes/radio buttons)
1 onkeyup:Boolean Default: true
在keyup时验证
1 onclick:Boolean Default: true
在checkboxes 和 radio 点击时验证
1 focusInvalid:Boolean Default: true
提交表单后,未通过验证的表单(第一个或提交之前获得焦点的未通过验证的表单)会获得焦点
1 focusCleanup:Boolean Default: false
如果是true那么当未通过验证的元素获得焦点时,移除错误提示。避免和 focusInvalid 一起用
// 重置表单
1 $().ready(function() { 2 var validator = $("#signupForm").validate({ 3 submitHandler:function(form){ 4 alert("submitted"); 5 form.submit(); 6 } 7 }); 8 $("#reset").click(function() { 9 validator.resetForm(); 10 }); 11 12 });
8.异步验证
1 remote:URL
使用ajax方式进行验证,默认会提交当前验证的值到远程地址,如果需要提交其他的值,可以使用data选项
1 remote: "check-email.php"
1 remote: { 2 url: "check-email.php", //后台处理程序 3 type: "post", //数据发送方式 4 dataType: "json", //接受数据格式 5 data: { //要传递的数据 6 username: function() { 7 return $("#username").val(); 8 } 9 } 10 }
远程地址只能输出 "true" 或 "false",不能有其它输出
9.添加自定义校验
1 addMethod:name, method, message //验证方法名称, 验证规则, 验证提示信息
自定义验证方法
// 中文字两个字节
1 jQuery.validator.addMethod("byteRangeLength", function(value, element, param) { 2 var length = value.length; 3 for(var i = 0; i < value.length; i++){ 4 if(value.charCodeAt(i) > 127){ 5 length++; 6 } 7 } 8 return this.optional(element) || ( length >= param[0] && length <= param[1] ); 9 }, $.validator.format("请确保输入的值在{0}-{1}个字节之间(一个中文字算2个字节)"));
// 邮政编码验证
1 jQuery.validator.addMethod("isZipCode", function(value, element) { 2 var tel = /^[0-9]{6}$/; 3 return this.optional(element) || (tel.test(value)); 4 }, "请正确填写您的邮政编码");
(1)要在additional-methods.js文件中添加或者在jquery.validate.js添加
建议一般写在additional-methods.js文件中
(2)在messages_cn.js文件添加:isZipCode: "只能包括中文字、英文字母、数字和下划线",
调用前要添加对additional-methods.js文件的引用。
10.radio和checkbox、select的验证
(1)radio的required表示必须选中一个
1 <input type="radio" id="gender_male" value="m" name="gender" class="{required:true}" /> 2 <input type="radio" id="gender_female" value="f" name="gender"/>
(2)checkbox的required表示必须选中
1 <input type="checkbox" class="checkbox" id="agree" name="agree" class="{required:true}" />
checkbox的minlength表示必须选中的最小个数,maxlength表示最大的选中个数,rangelength:[2,3]表 示选中个数区间
1 <input type="checkbox" class="checkbox" id="spam_email" value="email" name="spam[]" class="{required:true, minlength:2}" /> 2 <input type="checkbox" class="checkbox" id="spam_phone" value="phone" name="spam[]" /> 3 <input type="checkbox" class="checkbox" id="spam_mail" value="mail" name="spam[]" />
(3)select的required表示选中的value不能为空
1 <select id="jungle" name="jungle" title="Please select something!" class="{required:true}"> 2 <option value=""></option> 3 <option value="1">Buga</option> 4 <option value="2">Baga</option> 5 <option value="3">Oi</option> 6 </select>
select的minlength表示选中的最小个数(可多选的select),maxlength表示最大的选中个 数,rangelength:[2,3]表示选中个数区间
1 <select id="fruit" name="fruit" title="Please select at least two fruits" class="{required:true, minlength:2}" multiple="multiple"> 2 <option value="b">Banana</option> 3 <option value="a">Apple</option> 4 <option value="p">Peach</option> 5 <option value="t">Turtle</option> 6 </select>
jQuery.validate 中文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 |
返回:String |
用参数代替模板中的 |
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 |
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:{ email:"E-mail地址不正确" } } }) |
groups: 对一组元素的验证,用一个错误提示,用error Placement控制把出错信息放在哪里 |
$("#myform").validate({ groups:{ username:"fname }, if (element.attr("name") == else }, debug:true }) |
Onubmit Boolean 默认:true 是否提交时验证 |
$(".selector").validate({ }) |
onfocusout Boolean 默认:true 是否在获取焦点时验证 |
$(".selector").validate({ }) |
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({ }) |
errorElement String 默认:"label" 使用什么标签标记错误 |
$(".selector").validate errorElement:"em" }) |
wrapper String 使用什么标签再把上边的errorELement包起来 |
$(".selector").validate({ wrapper:"li" }) |
errorLabelContainer Selector 把错误信息统一放在一个容器里面 |
$("#myform").validate({ wrapper:"li", submitHandler:function() { })
|
showErrors: 跟一个函数,可以显示总共有多少个未通过验证的元素 |
$(".selector").validate({ $("#summary").html("Your } }) |
errorPlacement: 跟一个函数,可以自定义错误放到哪里 |
$("#myform").validate({ }, debug:true
}) |
success: 要验证的元素通过验证后的动作,如果跟一个字符串,会当做一个css类,也可跟一个函数 |
$("#myform").validate({ submitHandler:function() }) |
highlight: 可以给未通过验证的元素加效果,闪烁等 |
|
addMethod(name,method,message)方法: |
参数name是添加的方法的名字 |
参数method是一个函数,接收三个参数(value,element,param)
$.validator.addMethod("af",function(value,element,params){ return false; } if(value>=params[0] 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() { }) |
<script type="text/javascript" <script type="text/javascript" <form id="myform"> <input type="text" <input type="submit" </form> |