jQuery.form.js是一個form插件,支持ajax表單提交和ajax文件上傳。
官網下載地址:http://plugins.jquery.com/form/
API
| ajaxForm | 增加所有需要的事件監聽器,為ajax提交表單做准備。ajaxForm並不能提交表單。在document的ready函數中,使用ajaxForm來為ajax提交表單進行准備。 | 接受0個或1個參數。參數可以是一個回調函數,也可以是一個Options對象。 | $("#formid").ajaxForm(); |
| ajaxSubmit | 使用ajax提交表單。 | 接受0個或1個參數。參數可以是一個回調函數,也可以是一個Options對象。 | $("#formid").ajaxSubmit(); 或 $("#formid").submit(function(){ $(this).ajaxSubmit(); return false; }); |
| formSerialize | 將表單串行化(或序列化)為一個查詢字符串。這個方法將返回以下格式的字符串:name1=value1&name2=value2。 | 無 | $("#formid").formSerialize(); |
| fieldSerialize | 將表單的字段元素串行化(或序列化)為一個查詢字符串。當只有部分表單字段需要進行串行化(或序列化)時,使用這個就很方便了。返回以下格式的字符串:name=value1&name2=value2。 | 無 | $("#formid .specialFields").fieldSerialize(); |
| fieldValue | 返回匹配插入數組中的表單元素值。該方法以數組的形式返回數據。如果元素值被判定可能無效,則數組為空。 | 無 | $("#formid :password").fieldValue(); |
| resetForm | 將表單恢復到初始狀態。 | 無 | $("#formid").resetForm(); |
| clearForm | 清除表單元素。該方法將所有的text、password、textarea置空,清除select元素中的選定,以及所有radio按鈕和checkbox按鈕重置為非選定狀態。 | 無 | $("#formid").clearForm(); |
| clearFields | 清除字段元素。只有部分表單元素需要清除時方便使用。 | 無 | $("#formid .specialFields").clearFields(); |
Options對象
ajaxForm和ajaxSubmit都支持眾多的選項參數,這些選項參數可以使用一個Options對象來提供。
| target | 指明頁面中由服務器響應進行更新的元素。元素的值可能被指定為一個jQuery選擇器字符串、一個jquery對象、一個DOM元素。 | 默認值:null |
| url | 指定提交表單數據的URL。 | 默認值:表單的action屬性值 |
| type | 指定提交表單數據的方法(method):“GET”或“POST”。 | 默認值:GET |
| beforeSubmit | 表單提交前被調用的回調函數。如果回調函數返回false表單將不被提交。回調函數帶三個調用參數:數組形式的表單數據,jQuery表單對象,以及傳入ajaxForm/ajaxSubmit中的Options對象。 | 默認值:null |
| success | 表單成功提交后調用的回調函數。然后dataType選項值決定傳回responseText還是responseXML的值。 | 默認值:null |
| dataType | 返回的數據類型:null、"xml"、"script"、"json"其中之一。 | 默認值:null |
| resetForm | 表示如果表單提交成功是否進行重置。 | 默認值:null |
| clearForm | 表示如果表單提交成功是否清除表單數據。 | 默認值:null |
示例:
var options={
target : '#output', // 把服務器返回的內容放入id為output的元素中
beforeSubmit : showRequest, // 提交前的回調函數
success : showResponse, // 提交后的回調函數
// url : url, //默認是form的action,如果申明,則會覆蓋
// type : type, // 默認值是form的method("GET" or "POST"),如果聲明,則會覆蓋
// dataType : null, // html(默認)、xml、script、json接受服務器端返回的類型
// clearForm : true, // 成功提交后,清除所有表單元素的值
// resetForm : true, // 成功提交后,重置所有表單元素的值
timeout : 3000 // 限制請求的時間,當請求大於3秒后,跳出請求
}
function showRequest(formData, jqForm, options){
// formData: 數組對象,提交表單時,form插件會以ajax方式自動提交這些數據,格式如[{name:user,value:val},{name:pwd,value:pwd}]
// jqForm: jQuery對象,封裝了表單的元素
// options: options對象
var queryString=$.param(formData); // name=1&address=2
var formElement=jqForm[0]; // 將jqForm轉換為DOM對象
var address=formElement.address.value; // 訪問jqForm的DOM元素
return true; // 只要不返回false,表單都會提交,在這里可以對表單元素進行驗證
}
function showResponse(responseText,statusText){
// dataType=xml
var name=$("name",responseXML).text();
var address=$("address",responseXML).text();
$("#xmlout").html(name+" "+address);
// dataType=json
$("#jsonout").html(data.name+" "+data.address);
}
