以前做表單都要自己一格一格寫 if 判斷,既醜又難維護。jquery.validate.js 把這件事變成宣告式的設定。下面先看在線登入表單的實例,再整理各項規則與常用選項。
<script type="text/javascript">
function lang(key) {
mylang = {
'ls_input_myb': '請輸入您的賬戶',
'ls_myb_email': '漫游幣賬戶為郵箱地址',
'ls_login_password': '請輸入您的登錄密碼',
'ls_password_length': '密碼長度為{0}-{1}位之間',
'ls_input_captcha': '請輸入驗證碼',
'ls_captcha_length': '驗證碼的長度為{0}位',
'ls_account_email': '賬戶名為郵箱地址',
'': ''
};
return mylang[key];
}
</script>
<script type="text/javascript">
$(document).ready(function() {
$("#loginForm").validate({
rules: {
uEmail: { required: true, email: true },
uPassword: { required: true, rangelength: [6, 30] }
},
messages: {
uEmail: {
required: lang('ls_input_myb'),
email: lang('ls_myb_email')
},
uPassword: {
required: lang('ls_login_password'),
rangelength: $.format(lang('ls_password_length'))
}
},
// 把錯誤訊息放到下一列的第二個欄位
errorPlacement: function(error, element) {
var placement = $(element.parent("td").parent("tr").next("tr").find("td").get(1));
placement.text('');
error.appendTo(placement);
},
onkeyup: false
});
var accountTipsText = lang('ls_account_email');
$("#uEmail").focus(function() {
var target = $($(this).parent().parent().next().find('td').get(1));
if (!$(target).text()) {
$(target).html('<span class="font_888_8">' + accountTipsText + '</span>');
}
$(this).css('color', '#000');
}).focus();
});
</script>
這個例子幾乎涵蓋了 validate.js 的核心觀念:規則、訊息、訊息位置與事件時機。理解它之後,其餘都是延伸。
required: true:必填。remote: "check.php":以 Ajax 呼叫後端驗證。email: true / url: true:格式檢查。date: true / dateISO: true:日期格式(ISO 僅驗格式,不驗有效性)。number: true:合法數字(含負數、小數);digits: true:整數。creditcard:信用卡號。equalTo: "#field":與指定欄位相同,常用於確認密碼。accept:副檔名白名單。maxlength / minlength / rangelength:長度上下限(一個中文字算一個字元)。range / max / min:數值範圍。把中文訊息集中放在 messages_cn.js 再於頁面引入,是最實用的做法:
<script src="../js/messages_cn.js" type="text/javascript"></script>
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} 的值")
});
<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>
<script>
$().ready(function() { $("#signupForm").validate(); });
</script>
<form id="signupForm" method="get" action="">
<label for="firstname">Firstname</label>
<input id="firstname" name="firstname" class="required" />
<label for="email">E-Mail</label>
<input id="email" name="email" class="required email" />
<label for="password">Password</label>
<input id="password" name="password" type="password" class="{required:true,minlength:5}" />
<label for="confirm_password">確認密碼</label>
<input id="confirm_password" name="confirm_password" type="password"
class="{required:true,minlength:5,equalTo:'#password'}" />
<input class="submit" type="submit" value="Submit"/>
</form>
幾個細節:用 class="{}" 時務必引入 metadata 外掛;可以自訂訊息 class="{required:true,messages:{required:'請輸入內容'}}";equalTo 的值要加引號。
另外可用 meta: "validate" 指定到 metadata 的 validate 屬性去讀規則;或 $.metadata.setType("attr", "validate") 改用 validate="{required:true}" 的寫法(此時 class="{required:true,minlength:5}" 會失效)。
$().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: "兩次輸入密碼不一致"
}
}
});
});
沒有指定 message 的欄位會使用預設訊息。另外 required 除了 true,也可以寫成 required: "#aa:checked" 或 required: function(){},這兩種寫法常用於「有勾選 A 才必填 B」這類連動需求。
$().ready(function() {
$("#signupForm").validate({
submitHandler: function(form) {
alert("submitted");
form.submit();
}
});
});
也能設為全域預設:$.validator.setDefaults({ submitHandler: function(form){ alert("submitted!"); form.submit(); } })。注意要送出表單請用 form.submit(),不要寫成 $(form).submit()。
設為 true 時表單不會真的送出,只跑驗證,除錯很方便。多表單頁面可用 $.validator.setDefaults({ debug: true })。
ignore: ".ignore"
預設是 error.appendTo(element.parent())。若表格有專門的狀態欄,可以這樣安排:
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());
}
errorClass(預設 "error"):錯誤提示的 CSS 類名。errorElement(預設 "label"):用什麼標籤包住錯誤訊息,可改為 em。errorContainer:有錯誤時顯示、無錯誤時隱藏的容器。errorLabelContainer:把錯誤訊息集中到單一容器。wrapper:再包一層標籤。這三個常一起使用,做出「集中式錯誤清單」。
errorContainer: "div.error",
errorLabelContainer: $("#signupForm div.error"),
wrapper: "li"
success: function(label) {
label.html(" ").addClass("checked"); // 對 IE 友善
}
// 或直接把 class 名稱字串傳入
success: "valid"
onsubmit(預設 true):送出時驗證。onfocusout(預設 true):離開焦點時驗證,不含 checkbox / radio。onkeyup(預設 true):按鍵釋放時驗證。onclick(預設 true):點擊 checkbox / radio 時驗證。focusInvalid(預設 true):送出後焦點跳到第一個未通過的欄位。focusCleanup(預設 false):取得焦點時清除錯誤提示,盡量不要和 focusInvalid 併用。
$().ready(function() {
var validator = $("#signupForm").validate({
submitHandler: function(form) { alert("submitted"); form.submit(); }
});
$("#reset").click(function() { validator.resetForm(); });
});
remote: "check-email.php"
remote: {
url: "check-email.php", // 後端處理程式
type: "post", // 送出方式
dataType: "json", // 接受格式
data: { // 額外要傳的資料
username: function() { return $("#username").val(); }
}
}
遠端只能輸出 true 或 false,不要有其他內容。
// 中文字算兩個位元組
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);
}, "請正確填寫您的郵政編碼");
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 代表必須勾選,minlength / maxlength / rangelength 則控制勾選數量區間:
<input type="checkbox" id="spam_email" value="email" name="spam[]" class="{required:true, minlength:2}" />
<input type="checkbox" id="spam_phone" value="phone" name="spam[]" />
<input type="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 / maxlength / rangelength 限制勾選數量:
<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>