jQuery validate 是前端表單驗證的經典外掛。本文整理其常用的方法、選擇器、內建驗證方式與設定選項,方便查閱。
validate(options):回傳 Validator,用來驗證所選的 FORM。
valid():回傳 Boolean,檢查是否驗證通過。
rules():回傳 Options,取得元素的驗證規則。
rules("add", rules):增加驗證規則。
rules("remove", rules):刪除驗證規則。
removeAttrs(attributes):刪除特殊屬性並回傳它們。
:blank:沒有值的篩選器。
:filled:有值的篩選器。
:unchecked:未勾選元素的篩選器。
jQuery.format(template, argument, argumentN...):以參數取代模板中的 {n},回傳字串。
form():驗證整個表單,回傳成功或失敗。
element(element):驗證單一元素。
resetForm():把表單恢復到驗證前的狀態。
showErrors(errors):顯示特定的錯誤訊息。
setDefaults(defaults):改變預設設定。
addMethod(name, method, message):新增一個驗證方法,需包含獨一無二的名稱、一個 JavaScript 方法與預設訊息。
addClassRules(name, rules):增加組合驗證類型,在同一個 class 中使用多種驗證方法時很有用。
addClassRules(rules):一次增加多組組合驗證類型。
required():必填驗證。
required(dependency-expression):必填元素依賴於表達式的結果。
required(dependency-callback):必填元素依賴於回調函數的結果。
remote(url):請求遠程校驗,url 通常是一個遠程調用方法。
minlength(length):設置最小長度。
maxlength(length):設置最大長度。
rangelength(range):設置長度範圍 [min, max]。
min(value):設置最小值。
max(value):設置最大值。
email():驗證電子郵箱格式。
range(range):設置值的範圍。
url():驗證 URL 格式。
date():驗證日期格式(只驗證格式,不驗證準確性)。
dateISO():驗證 ISO 類型的日期格式。
dateDE():驗證德式日期格式(如 29.04.1994)。
number():驗證十進位數字(含小數)。
digits():驗證整數。
creditcard():驗證信用卡號。
accept(extension):驗證相同副檔名的字串。
equalTo(other):驗證兩個輸入框內容是否相同。
phoneUS():驗證美式電話號碼。
debug:除錯模式(表單不提交)。
$(".selector").validate({ 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 形式。
messages:{
name:"Name不能為空",
email:{ required:"E-mail不能為空", email:"E-mail地址不正確" }
}
groups:對一組元素進行驗證,用一個錯誤提示,並以 errorPlacement 控制錯誤訊息的位置。
其他常用選項還包括:onfocusout(取得焦點時驗證)、onkeyup(敲擊鍵盤時驗證)、onclick(滑鼠點擊時驗證,常用於 checkbox、radio)、focusInvalid(提交後未通過驗證的元素取得焦點)、errorClass(錯誤提示的 CSS 類名,預設 "error")、errorElement(標記錯誤的標籤,預設 "label")、wrapper(包裹 errorElement 的標籤)、errorLabelContainer(把錯誤訊息統一放進一個容器)、showErrors、errorPlacement、success、highlight 等。
參數 name 是方法名稱;參數 method 是一個函式,接收三個參數(value、element、param),分別為元素值、元素本身與參數;參數 message 是錯誤提示。以下示範一個只允許輸入 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");
使用時,在 rules 中寫:
username:{ af:["a","f"] }
若只有一個參數可直接寫(如 af:"a"),多個參數則放進 [] 並以逗號分隔。
另外,也可搭配 meta 字串方式,透過 class 屬性宣告驗證規則,例如:
<input type="text" name="email" class="{validate:{ required:true,email:true }}" />
本文另附 jQuery.validate.js + API_cn.pdf 供下載參考。