Form 插件是最常用的表單處理插件之一,支援 Ajax、支援 Ajax 檔案上傳,功能強大,基本能滿足日常應用需求。本文整理其 API 與使用方法。
<form id="myForm" action="comment.php" method="post"> Name: <input type="text" name="name" /> Comment: <textarea name="comment"></textarea> <input type="submit" value="Submit Comment" /> </form>
<head>
<script type="text/javascript" src="path/to/jquery.js"></script>
<script type="text/javascript" src="path/to/form.js"></script>
<script type="text/javascript">
// wait for the DOM to be loaded
$(document).ready(function() {
// bind 'myForm' and provide a simple callback function
$('#myForm').ajaxForm(function() {
alert("Thank you for your comment!");
});
});
</script>
</head>
插件作者在介紹時說道:「用 Ajax 提交表單,你不可能找到比這更容易的了。」是否如此,用過便知。
增加所有必要的事件監聽器,為 Ajax 提交表單做好準備。ajaxForm 本身不能提交表單,通常在 document ready 中呼叫。可鏈接。
$('#myFormId').ajaxForm();
立即以 Ajax 提交表單,多在響應用戶提交時呼叫。可鏈接。
// 綁定表單提交事件處理器
$('#myFormId').submit(function() {
// 提交表單
$(this).ajaxSubmit();
// 為了防止瀏覽器進行表單提交和頁面導航,返回false
return false;
});
將表單序列化為查詢字串,格式為 name1=value1&name2=value2。返回字串。
var queryString = $('#myFormId').formSerialize();
$.post('myscript.php', queryString);
將表單的部分欄位序列化為查詢字串,適合只需序列化部分欄位時使用。
var queryString = $('#myFormId .specialFields').fieldSerialize();
回傳符合條件的表單元素值陣列。自 0.91 版起總是以陣列形式回傳。
var value = $('#myFormId :password').fieldValue();
alert('The password is: ' + value[0]);
resetForm 將表單還原到初始狀態;clearForm 清除所有欄位內容;clearFields 僅清除部分欄位。
$('#myFormId').resetForm();
$('#myFormId').clearForm();
$('#myFormId .specialFields').clearFields();
ajaxForm 與 ajaxSubmit 都支援豐富的選項參數,透過一個 Options 物件提供:
target:指定伺服器回應要更新的元素,預設 null。url:指定提交資料的 URL,預設為表單的 action。type:指定提交方法(GET 或 POST),預設為表單的 method。beforeSubmit:提交前呼叫的回調,可作為預提交邏輯或驗證鉤子,若回傳 false 則不提交。success:成功提交後呼叫的回調。dataType:期望回傳的資料類型,可為 null、xml、script 或 json。semantic:布林標記,表示是否必須嚴格按語義順序提交資料。resetForm / clearForm:布林標記,表示提交成功後是否重置或清除表單。Options 物件也可直接傳給 jQuery 的 $.ajax 方法,若你熟悉 $.ajax 的參數,就能靈活地把它傳給 ajaxForm 與 ajaxSubmit。
// 准備好Options對象
var options = {
target: '#divToUpdate',
url: 'comment.php',
success: function() {
alert('Thanks for your comment!');
}
};
// 將options傳給ajaxForm
$('#myForm').ajaxForm(options);