jQuery驗證控件jquery.validate.js使用說明+中文API
官網(wǎng)地址:http://bassistance.de/jquery-plugins/jquery-plugin-validation
jQuery plugin: Validation 使用說明
轉(zhuǎn)載自:http://blog.sina.com.cn/s/blog_608475eb0100h3h1.html
一導(dǎo)入js庫
<script src="../js/jquery.js" type="text/javascript"></script>
< script src="../js/jquery.validate.js" type="text/javascript"></script>
二、默認(rèn)校驗規(guī)則
(1)required:true 必輸字段
(2)remote:"check.php" 使用ajax方法調(diào)用check.php驗證輸入值
(3)email:true 必須輸入正確格式的電子郵件
(4)url:true 必須輸入正確格式的網(wǎng)址
(5)date:true 必須輸入正確格式的日期 日期校驗ie6出錯,慎用
(6)dateISO:true 必須輸入正確格式的日期(ISO),例如:2009-06-23,1998/01/22 只驗證格式,不驗證有效性
(7)number:true 必須輸入合法的數(shù)字(負(fù)數(shù),小數(shù))
(8)digits:true 必須輸入整數(shù)
(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
三、默認(rèn)的提示
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: "請輸入合法的網(wǎng)址",
date: "請輸入合法的日期",
dateISO: "請輸入合法的日期 (ISO).",
number: "請輸入合法的數(shù)字",
digits: "只能輸入整數(shù)",
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中,在頁面中引入
<script src="../js/messages_cn.js" type="text/javascript"></script>
四、使用方式
1.將校驗規(guī)則寫到控件中
<script src="../js/jquery.js" type="text/javascript"></script>
<script src="../js/jquery.validate.js" type="text/javascript"></script>
<script src="./js/jquery.metadata.js" type="text/javascript"></script>
$().ready(function() {
$("#signupForm").validate();
});
<form id="signupForm" method="get" action="">
<p>
<label for="firstname">Firstname</label>
<input id="firstname" name="firstname" class="required" />
</p>
<p>
<label for="email">E-Mail</label>
<input id="email" name="email" class="required email" />
</p>
<p>
<label for="password">Password</label>
<input id="password" name="password" type="password" class="{required:true,minlength:5}" />
</p>
<p>
<label for="confirm_password">確認(rèn)密碼</label>
<input id="confirm_password" name="confirm_password" type="password" class="{required:true,minlength:5,equalTo:'#password'}" />
</p>
<p>
<input class="submit" type="submit" value="Submit"/>
</p>
</form>
使用class="{}"的方式,必須引入包:jquery.metadata.js
可以使用如下的方法,修改提示內(nèi)容:
class="{required:true,minlength:5,messages:{required:'請輸入內(nèi)容'}}"
在使用equalTo關(guān)鍵字時,后面的內(nèi)容必須加上引號,如下代碼:
class="{required:true,minlength:5,equalTo:'#password'}"
2.將校驗規(guī)則寫到j(luò)s代碼中
$().ready(function() {
$("#signupForm").validate({
rules: {
firstname: "required",
email: {
required: true,
email: true
},
password: {
required: true,
minlength: 5
},
confirm_password: {
required: true,
minlength: 5,
equalTo: "#password"
}
},
messages: {
firstname: "請輸入姓名",
email: {
required: "請輸入Email地址",
email: "請輸入正確的email地址"
},
password: {
required: "請輸入密碼",
minlength: jQuery.format("密碼不能小于{0}個字 符")
},
confirm_password: {
required: "請輸入確認(rèn)密碼",
minlength: "確認(rèn)密碼不能小于5個字符",
equalTo: "兩次輸入密碼不一致不一致"
}
}
});
});
//messages處,如果某個控件沒有message,將調(diào)用默認(rèn)的信息
<form id="signupForm" method="get" action="">
<p>
<label for="firstname">Firstname</label>
<input id="firstname" name="firstname" />
</p>
<p>
<label for="email">E-Mail</label>
<input id="email" name="email" />
</p>
<p>
<label for="password">Password</label>
<input id="password" name="password" type="password" />
</p>
<p>
<label for="confirm_password">確認(rèn)密碼</label>
<input id="confirm_password" name="confirm_password" type="password" />
</p>
<p>
<input class="submit" type="submit" value="Submit"/>
</p>
</form>
required:true 必須有值
required:"#aa:checked"表達(dá)式的值為真,則需要驗證
required:function(){}返回為真,表時需要驗證
后邊兩種常用于,表單中需要同時填或不填的元素
五、常用方法及注意問題
1.用其他方式替代默認(rèn)的SUBMIT
$().ready(function() {
$("#signupForm").validate({
submitHandler:function(form){
alert("submitted");
form.submit();
}
});
});
使用ajax方式
$(".selector").validate({
submitHandler: function(form)
{
$(form).ajaxSubmit();
}
})
可以設(shè)置validate的默認(rèn)值,寫法如下:
$.validator.setDefaults({
submitHandler: function(form) { alert("submitted!");form.submit(); }
});
如果想提交表單, 需要使用form.submit()而不要使用$(form).submit()
2.debug,只驗證不提交表單
如果這個參數(shù)為true,那么表單不會提交,只進行檢查,調(diào)試時十分方便
$().ready(function() {
$("#signupForm").validate({
debug:true
});
});
如果一個頁面中有多個表單都想設(shè)置成為debug,用
$.validator.setDefaults({
debug: true
})
3.ignore:忽略某些元素不驗證
ignore: ".ignore"
4.更改錯誤信息顯示的位置
errorPlacement:Callback
Default: 把錯誤信息放在驗證的元素后面
指明錯誤放置的位置,默認(rèn)情況是:error.appendTo(element.parent());即把錯誤信息放在驗證的元素后面
errorPlacement: function(error, element) {
error.appendTo(element.parent());
}
//示例:
<tr>
<td class="label"><label id="lfirstname" for="firstname">First Name</label></td>
<td class="field"><input id="firstname" name="firstname" type="text" value="" maxlength="100" /></td>
<td class="status"></td>
</tr>
<tr>
<td style="padding-right: 5px;">
<input id="dateformat_eu" name="dateformat" type="radio" value="0" />
<label id="ldateformat_eu" for="dateformat_eu">14/02/07</label>
</td>
<td style="padding-left: 5px;">
<input id="dateformat_am" name="dateformat" type="radio" value="1" />
<label id="ldateformat_am" for="dateformat_am">02/14/07</label>
</td>
<td></td>
</tr>
<tr>
<td class="label"> </td>
<td class="field" colspan="2">
<div id="termswrap">
<input id="terms" type="checkbox" name="terms" />
<label id="lterms" for="terms">I have read and accept the Terms of Use.</label>
</div>
</td>
</tr>
errorPlacement: function(error, element) {
if ( element.is(":radio") )
error.appendTo( element.parent().next().next() );
else if ( element.is(":checkbox") )
error.appendTo ( element.next() );
else
error.appendTo( element.parent().next() );
}
代碼的作用是:一般情況下把錯誤信息顯示在<td class="status"></td>中,如果是radio顯示在<td></td>中,如果是 checkbox顯示在內(nèi)容的后面
errorClass:String Default: "error"
指定錯誤提示的css類名,可以自定義錯誤提示的樣式
errorElement:String Default: "label"
用什么標(biāo)簽標(biāo)記錯誤,默認(rèn)的是label你可以改成em
errorContainer:Selector
顯示或者隱藏驗證信息,可以自動實現(xiàn)有錯誤信息出現(xiàn)時把容器屬性變?yōu)轱@示,無錯誤時隱藏,用處不大
errorContainer: "#messageBox1, #messageBox2"
errorLabelContainer:Selector
把錯誤信息統(tǒng)一放在一個容器里面。
wrapper:String
用什么標(biāo)簽再把上邊的errorELement包起來
一般這三個屬性同時使用,實現(xiàn)在一個容器內(nèi)顯示所有錯誤提示的功能,并且沒有信息時自動隱藏
errorContainer: "div.error",
errorLabelContainer: $("#signupForm div.error"),
wrapper: "li"
5更改錯誤信息顯示的樣式
設(shè)置錯誤提示的樣式,可以增加圖標(biāo)顯示,在該系統(tǒng)中已經(jīng)建立了一個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每個字段驗證通過執(zhí)行函數(shù)
success:String,Callback
要驗證的元素通過驗證后的動作,如果跟一個字符串,會當(dāng)做一個css類,也可跟一個函數(shù)
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驗證的觸發(fā)方式修改
下面的雖然是boolean型的,但建議除非要改為false,否則別亂添加。
onsubmit:Boolean Default: true
提交時驗證. 設(shè)置唯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那么當(dāng)未通過驗證的元素獲得焦點時,移除錯誤提示。避免和 focusInvalid 一起用
// 重置表單
$().ready(function() {
var validator = $("#signupForm").validate({
submitHandler:function(form){
alert("submitted");
form.submit();
}
});
$("#reset").click(function() {
validator.resetForm();
});
});
8異步驗證
remote:URL
使用ajax方式進行驗證,默認(rèn)會提交當(dāng)前驗證的值到遠(yuǎn)程地址,如果需要提交其他的值,可以使用data選項
remote: "check-email.php"
remote: {
url: "check-email.php", //后臺處理程序
type: "post", //數(shù)據(jù)發(fā)送方式
dataType: "json", //接受數(shù)據(jù)格式
data: { //要傳遞的數(shù)據(jù)
username: function() {
return $("#username").val();
}
}
}
遠(yuǎn)程地址只能輸出 "true" 或 "false",不能有其它輸出
9添加自定義校驗
addMethod:name, method, message
自定義驗證方法
// 中文字兩個字節(jié)
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}個字節(jié)之間(一個中文字算2個字節(jié))"));
// 郵政編碼驗證
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: "只能包括中文字、英文字母、數(shù)字和下劃線",
調(diào)用前要添加對additional-methods.js文件的引用。
10radio和checkbox、select的驗證
1.radio的required表示必須選中一個
<input type="radio" id="gender_male" value="m" name="gender" class="{required:true}" />
<input type="radio" id="gender_female" value="f" name="gender"/>
2.checkbox的required表示必須選中
<input type="checkbox" class="checkbox" id="agree" name="agree" class="{required:true}" />
checkbox的minlength表示必須選中的最小個數(shù),maxlength表示最大的選中個數(shù),rangelength:[2,3]表 示選中個數(shù)區(qū)間
<input type="checkbox" class="checkbox" id="spam_email" value="email" name="spam[]" class="{required:true, minlength:2}" />
<input type="checkbox" class="checkbox" id="spam_phone" value="phone" name="spam[]" />
<input type="checkbox" class="checkbox" id="spam_mail" value="mail" name="spam[]" />
3.select的required表示選中的value不能為空
<select id="jungle" name="jungle" title="Please select something!" class="{required:true}">
<option value=""></option>
<option value="1">Buga</option>
<option value="2">Baga</option>
<option value="3">Oi</option>
</select>
select的minlength表示選中的最小個數(shù)(可多選的select),maxlength表示最大的選中個 數(shù),rangelength:[2,3]表示選中個數(shù)區(qū)間
<select id="fruit" name="fruit" title="Please select at least two fruits" class="{required:true, minlength:2}" multiple="multiple">
<option value="b">Banana</option>
<option value="a">Apple</option>
<option value="p">Peach</option>
<option value="t">Turtle</option>
</select>
jQuery.validate 中文API
名稱
返回類型
描述
validate(options)
返回:Validator
驗證所選的FORM
valid()
返回:Boolean
檢查是否驗證通過
rules()
返回:Options
返回元素的驗證規(guī)則
rules("add",rules)
返回:Options
增加驗證規(guī)則
rules("remove",rules)
返回:Options
刪除驗證規(guī)則
removeAttrs(attributes)
返回:Options
刪除特殊屬性并且返回他們
Custom selectors
:blank
返回:Validator
沒有值的篩選器
:filled
返回:Array <Element
>
有值的篩選器
:unchecked
返回:Array <Element
>
沒選擇的元素的篩選器
Utilities
jQuery.format
(template,argument
,argumentN...)
返回:String
用參數(shù)代替模板中的
{n}
Validator:
validate方法返回一個Validator對象,它有很多方法, 讓你能使用引發(fā)校驗程序或者改變form的內(nèi)容. validator對象有很多方法,但下面只是列出常用的
form()
返回:Boolean
驗證form返回成功還是失敗
element(element)
返回:Boolean
驗證單個元素是成功還是失敗
resetForm()
返回:undefined
把前面驗證的FORM恢復(fù)到驗證前原來的狀態(tài)
showErrors(errors)
返回:undefined
顯示特定的錯誤信息
Validator functions:
setDefaults(defaults)
返回:undefined
改變默認(rèn)的設(shè)置
addMethod(name,method,message)
返回:undefined
添加一個新的驗證方法. 必須包括一個獨一無二的名字,一個JAVASCRIPT的方法和一個默認(rèn)的信息
addClassRules(name,rules)
返回:undefined
增加組合驗證類型 在一個類里面用多種驗證方法里比較有用
addClassRules(rules)
返回:undefined
增加組合驗證類型 在一個類里面用多種驗證方法里比較有用,這個是一下子加多個
內(nèi)置驗證方式:
required()
返回:Boolean
必填驗證元素
required(dependency-expression)
返回:Boolean
必填元素依賴于表達(dá)式的結(jié)果
required(dependency-callback)
返回:Boolean
必填元素依賴于回調(diào)函數(shù)的結(jié)果
remote(url)
返回:Boolean
請求遠(yuǎn)程校驗。url通常是一個遠(yuǎn)程調(diào)用方法
minlength(length)
返回:Boolean
設(shè)置最小長度
maxlength(length)
返回:Boolean
設(shè)置最大長度
rangelength(range)
返回:Boolean
設(shè)置一個長度范圍[min,max]
min(value)
返回:Boolean
設(shè)置最大值
max(value)
返回:Boolean
設(shè)置最小值
email()
返回:Boolean
驗證電子郵箱格式
range(range)
返回:Boolean
設(shè)置值的范圍
url()
返回:Boolean
驗證URL格式
date()
返回:Boolean
驗證日期格式(類似30/30/2008的格式,不驗證日期準(zhǔn)確性只驗證格式)
dateISO()
返回:Boolean
驗證ISO類型的日期格式
dateDE()
返回:Boolean
驗證德式的日期格式(29.04.1994 or
1.1.2006)
number()
返回:Boolean
驗證十進制數(shù)字(包括小數(shù)的)
digits()
返回:Boolean
驗證整數(shù)
creditcard()
返回:Boolean
驗證信用卡號
accept(extension)
返回:Boolean
驗證相同后綴名的字符串
equalTo(other)
返回:Boolean
驗證兩個輸入框的內(nèi)容是否相同
phoneUS()
返回:Boolean
驗證美式的電話號碼
validate ()的可選項:
debug:進行調(diào)試模式(表單不提交):
$(".selector").validate
({
debug:true
})
把調(diào)試設(shè)置為默認(rèn):
$.validator.setDefaults({
debug:true
})
submitHandler:
通過驗證后運行的函數(shù),里面要加上表單提交的函數(shù),否則表單不會提交
$(".selector").validate({
submitHandler:function(form)
{
$(form).ajaxSubmit();
}
})
ignore:
對某些元素不進行驗證
$("#myform").validate({
ignore:".ignore"
})
rules:
自定義規(guī)則,key:value的形式,key是要驗證的元素,value可以是字符串或?qū)ο?div style="height:15px;">