jQuery Validate

jQuery Validate

導入 js 庫

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

默認校驗規(guī)則

默認提示

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、將校驗規(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">確認密碼</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、將校驗規(guī)則寫到 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

指明錯誤放置的位置，默認情況是：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 則顯示在內容的后面。

一般這三個屬性同時使用，實現在一個容器內顯示所有錯誤提示的功能，并且沒有信息時自動隱藏。

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、每個字段驗證通過執(zhí)行函數

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、驗證的觸發(fā)方式修改

下面的雖然是 boolean 型的，但建議除非要改為 false，否則別亂添加。

// 重置表單
$().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",               //數據發(fā)送方式
    dataType: "json",           //接受數據格式   
    data: {                     //要傳遞的數據
        username: function() {
            return $("#username").val();
        }
    }
}

遠程地址只能輸出 "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)); }, "請正確填寫您的郵政編碼"); 

注意：要在 additional-methods.js 文件中添加或者在 jquery.validate.js 文件中添加。建議一般寫在 additional-methods.js 文件中。

注意：在 messages_cn.js 文件中添加：isZipCode: "只能包括中文字、英文字母、數字和下劃線"。調用前要添加對 additional-methods.js 文件的引用。

10、radio 和 checkbox、select 的驗證

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"/>

checkbox 的 required 表示必須選中。

<input type="checkbox" class="checkbox" id="agree" name="agree" class="{required:true}" />

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

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] 表示選中個數區(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

Validator

validate 方法返回一個 Validator 對象。Validator 對象有很多方法可以用來引發(fā)校驗程序或者改變 form 的內容，下面列出幾個常用的方法。

內置驗證方式

validate ()的可選項

$(".selector").validate
({
 debug:true
})

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

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

$("#myform").validate({
  ignore:".ignore"
})

$(".selector").validate({
   rules:{
       name:"required",
        email:{
           required:true,
            email:true
        }
 }
})

$(".selector").validate({
  rules:{
       name:"required",
        email:{
           required:true,
            email:true
        }
 },
    messages:{
        name:"Name不能為空",
        email:{       
            required:"E-mail不能為空",
          email:"E-mail地址不正確"
     }
 }
})

$("#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
})

$(".selector").validate({  
   onsubmit:false
})

$(".selector").validate({   
   onfocusout:false
})

$(".selector").validate({
   onkeyup:false
})

$(".selector").validate({
   onclick:false
})

$(".selector").validate({
   focusInvalid:false
})

$(".selector").validate({
   focusCleanup:true
})

$(".selector").validate({ 
  errorClass:"invalid"
})

$(".selector").validate
   errorElement:"em"
})

$(".selector").validate({
   wrapper:"li"
})

$("#myform").validate({   
   errorLabelContainer:"#messageBox",
  wrapper:"li",
   submitHandler:function() { 
       alert("Submitted!") 
    }
})

$(".selector").validate({  
    showErrors:function(errorMap,errorList) {
        $("#summary").html("Your form contains " + this.numberOfInvalids() + " errors,see details below.");
      this.defaultShowErrors();
 }
})

$("#myform").validate({  
 errorPlacement:function(error,element) {  
        error.appendTo(element.parent("td").next("td"));
   },
   debug:true
})

$("#myform").validate({        
   success:"valid",
        submitHandler:function() { 
           alert("Submitted!") 
        }
})

addMethod(name,method,message)方法

參數 name 是添加的方法的名字。

參數 method 是一個函數，接收三個參數 (value,element,param) 。
value 是元素的值，element 是元素本身，param 是參數。

我們可以用 addMethod 來添加除內置的 Validation 方法之外的驗證方法。比如有一個字段，只能輸一個字母，范圍是 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>

實例演示

虛構的實例

• 錯誤消息容器
• 自定義消息作為元素數據
• radio（單選按鈕）、checkbox（復選按鈕）和 select（下拉框）
• 與表單（Form）插件的交互（AJAX 提交）
• 自定義方法和消息顯示
• 動態(tài)表單
• 使用 jQuery UI Themeroller 定義表單樣式
• TinyMCE - 一個輕量級的基于瀏覽器的所見即所得編輯器
• 文件輸入框
• jQuery Mobile 表單驗證

現實世界的實例

• Milk 注冊表單
• Marketo 注冊表單
• 房屋買賣折疊面板表單
• 遠程 CAPTCHA（驗證碼）驗證

實例下載

點擊下載