jQuery驗證控制元件jquery.validate.js的使用介紹

Franson發表於2017-09-21

官網地址:http://bassistance.de/jquery-plugins/jquery-plugin-validation

jQuery plugin: Validation 使用說明  

轉載自:http://blog.sina.com.cn/s/blog_608475eb0100h3h1.html

 

一匯入js庫
<script src="../js/jquery.js" type="text/javascript"></script>
<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中,在頁面中引入
<script src="../js/messages_cn.js" type="text/javascript"></script>

 

四、使用方式
1.將校驗規則寫到控制元件中

複製程式碼
<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">確認密碼</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

可以使用如下的方法,修改提示內容:
class="{required:true,minlength:5,messages:{required:'請輸入內容'}}"

在使用equalTo關鍵字時,後面的內容必須加上引號,如下程式碼:
class="{required:true,minlength:5,equalTo:'#password'}"

 

2.將校驗規則寫到js程式碼中

複製程式碼
$().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: "請輸入確認密碼",
    minlength: "確認密碼不能小於5個字元",
    equalTo: "兩次輸入密碼不一致不一致"
   }
  }
    });
});
複製程式碼

//messages處,如果某個控制元件沒有message,將呼叫預設的資訊

複製程式碼
<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">確認密碼</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"表示式的值為真,則需要驗證
required:function(){}返回為真,表時需要驗證
後邊兩種常用於,表單中需要同時填或不填的元素

 

五、常用方法及注意問題
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());  
}

//示例:

複製程式碼
<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">&nbsp;</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顯示在內容的後面

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"

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 &nbsp; as text for IE
    label.html("&nbsp;").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"

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檔案的引用。

 

 

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表示必須選中的最小個數,maxlength表示最大的選中個數,rangelength:[2,3]表 示選中個數區間


<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表示選中的最小個數(可多選的select),maxlength表示最大的選中個 數,rangelength:[2,3]表示選中個數區間
<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


返回元素的驗證規則


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>

相關文章