=20

Overview

The jQuery Form Plugin allows you to easily and unobtrusively upg= rade HTML forms to use AJAX. The main methods, ajaxForm and ajaxSubmit, gather information from the form element to determine how to mana= ge the submit process. =20 Both of these methods support numerous options which allows you to have full control over how t= he data is submitted. =20 =20 Submitting a form with AJAX doesn't get any easier than thi= s!

Quick Start Guide

1Add a form to your page. Just a normal form, = no special markup required:

<form id=3D"myForm" action=3D"comment=
.php" method=3D"post">
    Name: <input type=3D"text" name=3D"name" />
    Comment: <textarea name=3D"comment"></textarea>
    <input type=3D"submit" value=3D"Submit Comment" />
</form>

=09

2Include jQuery and the Form Plugin external s= cript files and a short script to initialize the form when the <html> <head> <script src=3D"http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquer= y.js"></script> <script src=3D"http://malsup.github.com/jquery.form.js"></scri= pt> <script> // 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> ...

That's it!

When this form is submitted the name and comment = fields will be posted to comment.php. If the server returns a success status then the user will see a "Thank you" message.

=20

Form Plugin API

The Form Plugin API provides several methods that allow you to easi= ly manage form data and form submission.

ajaxForm

Prepares a form to be submitted via AJAX by adding all of the necessary event listeners. It does no= t submit the form. Use ajaxForm in your document's ready function to prepare your form(s) for AJAX submission.

a=
jaxForm

takes zero or one argument. The single argument can be either a callback function or an Options Object.
Chainable: Yes.

Note: You can pass any of the st= andard=20 $.ajax options to= ajaxForm

Example:

$('#myFormId').ajaxForm();

ajaxSubmit

Immediately submits the form via AJAX. In the most common use = case this is invoked in response to the user clicking a submit button on th= e form. ajaxSubmit takes zero or one argument= . The single argument can be either a callback function or an Options Object.
Chainable: Yes.

Note: You can pass any of the st= andard=20 $.ajax options to= ajaxSubmit

Example:

// attach handler to form's submit eve=
nt
$('#myFormId').submit(function() {
    // submit the form
    $(this).ajaxSubmit();
    // return false to prevent normal browser submit and page navigation
    return false;
});

formSerialize

Serializes the form into a query string. This method will retu= rn a string in the format: name1=3Dvalue1&name2=3Dvalue2
Chainable: No, this method returns a String.

Example:

var queryString =3D $('#myFormId').for=
mSerialize();

// the data could now be submitted using $.get, $.post, $.ajax, etc
$.post('myscript.php', queryString);

fieldSerialize

Serializes field elements into a query string. This is handy w= hen you need to serialize only part of a form. This method will return a string in the format: name1=3Dvalue1&name2=3Dvalue2
Chainable: No, this method returns a String.

Example:

var queryString =3D $('#myFormId .spec=
ialFields').fieldSerialize();

fieldValue

Returns the value(s) of the element(s) in the matched set in an= array. As of version .91, this method always returns an array. If no valid value can be determined the array will be empty, otherwise it will contain one or more values.<= br> Chainable: No, this method returns an array.

Example:

// get the value of the password input
var value =3D $('#myFormId :password').fieldValue();
alert('The password is: ' + value[0]);

resetForm

Resets the form to its original state by invoking the form elem= ent's native DOM method.
Chainable: Yes.

Example:

$('#myFormId').resetForm();

clearForm

Clears the form elements. This method emptys all of the text i= nputs, password inputs and textarea elements, clears the selection in any select elements, and unchecks all radio and ch= eckbox inputs.
Chainable: Yes.

$('#myFormId').clearForm();

clearFields

Clears field elements. This is handy when you need to clear on= ly a part of the form.
Chainable: Yes.

$('#myFormId .specialFields').clearFields(=
);

=09

=20

ajaxForm and ajaxSubmit Options

Note: Aside from the options listed below, yo= u can also pass any of the standard=20 $.ajax options to ajaxForm and= ajaxSubmit.

Both ajaxForm and ajaxSubmit support numerous options which can be provided using an Options Object. = The Options Object is simply a JavaScript object that contains properties with values set as f= ollows:

beforeSerialize

Callback function to be invoked before the form is serialized= . This provides an opportunity to manipulate the form before it's= values are retrieved. The beforeSerialize function is invoked with two a= rguments: the jQuery object for the form,=20 and the Options Object passed into ajaxForm/ajaxSubmit.

beforeSerialize: function($form, option=
s) {
    // return false to cancel submit		        =20
}

Default value: null

beforeSubmit

Callback function to be invoked before the form is submitted. The 'beforeSubmit' callback can be provided as a hook for runni= ng pre-submit logic or for validating the form data. If the 'beforeSubmit' callback retur= ns false then the form will not be submitted. The 'beforeSubmit' callback is invoked with t= hree arguments: the form data in array format, the jQuery object for the form, and the Option= s Object passed into ajaxForm/ajaxSubmit.

beforeSubmit: function(arr, $form, opti=
ons) {
    // The array of form data takes the following form:
    // [ { name: 'username', value: 'jresig' }, { name: 'password', value: =
'secret' } ]
   =20
    // return false to cancel submit		        =20
}

Default value: null

clearForm

Boolean flag indicating whether the form should be cleared if= the submit is successful
Default value: null

data

An object containing extra data that should be submitted alon= g with the form.

data: { key1: 'value1', key2: 'value2' =
}

dataType

Expected data type of the response. One of: null, 'xml', 'sc= ript', or 'json'. The dataType option provides a mean= s for specifying how the server response should be handled. This maps directly to the

jQuery.httpData<=
/code> method.
		        The following values are supported:
		        
		        'xml': if dataType =3D=3D 'xml' the server respo=
nse is treated as XML and the 'success'
		                  callback method, if specified, will be passed the respo=
nseXML value
		        

		        'json': if dataType =3D=3D 'json' the server res=
ponse will be evaluted and passed to
		                  the 'success' callback, if specified
		        

		        'script': if dataType =3D=3D 'script' the server=
 response is evaluated in the global context
		        

		            Default value: null


		        error
		        Callback function to be invoked upon error.
			    
		        forceSync
		        Boolean value. Set to true to remove short delay before posti=
ng form when uploading files (or using the iframe option).
		        The delay is used to allow the browser to render DOM updates prio=
r to performing a native form submit.  This improves
		        usability when displaying notifications to the user, such as "Ple=
ase Wait..."
		        

		            Default value: false
		            Added in v2.38
		        
		        iframe
		        Boolean flag indicating whether the form should always target=
 the server response to an iframe.
		            This is useful in conjuction with file uploads.  See the =
File Uploads
		            documentation on the Code Samples  page for more info.
		        

		            Default value: false
		        
		        iframeSrc
		        String value that should be used for the iframe's src attribu=
te when/if an iframe is used.
		        

		            Default value: about:blank

		            Default value for pages that use https protocol:=
 javascript:false
		        
		        iframeTarget
		        Identifies the iframe element to be used as the response targ=
et for file uploads.  By default, the plugin
					will create a temporary iframe element to capture the response when up=
loading files.  This options allows you
					to use an existing iframe if you wish. When using this option the plug=
in will make no attempt at handling
					the response from the server.

		            Default value: null
		            Added in v2.76
		        
		        replaceTarget
		        Optionally used along with the the target option=
. Set to true if the
		        	target should be replaced or false if only the targ=
et contents should
		        	be replaced. 

		            Default value: false
		            Added in v2.43
		        
		        resetForm
		        Boolean flag indicating whether the form should be reset if t=
he submit is successful

		            Default value: null
		        
		        semantic

Boolean flag indicating whether data must be submitted in str=
ict semantic order (slower). Note that the
		            normal form serialization is done in semantic order with the =
exception of input elements of type=3D"image"=
.
		            You should only set the semantic option to true if your serve=
r has strict semantic requirements
		            and your form contains an input element of <=
code class=3D"inline">type=3D"image"

.
Default value: false

success

Callback function to be invoked after the form has been submi= tted. If a 'success' callback function is provided it is invoked af= ter the response has been returned from the server. It is passed the following arguments:

1.) responseText or responseXML value (depending on the = value of the dataType option).
2.) statusText
3.) xhr (or the jQuery-wrapped form element if using jQu= ery < 1.4)
4.) jQuery-wrapped form element (or undefined if using j= Query < 1.4)

Default value: null

target

Identifies the element(s) in the page to be updated with the = server response. This value may be specified as a jQuery selection string, a j= Query object, or a DOM element.
Default value: null

type

The method in which the form data should be submitted, 'GET' = or 'POST'.
Default value: value of form's

method<=
/code> attribute (or 'GET' if none found)


				uploadProgress
				
					Callback function to be invoked with upload progress information (if s=
upported by the browser).
		            The callback is passed the following arguments:
		            
		            	1.) event; the browser event
		            	
2.) position (integer)
		            	
3.) total (integer)
		            	
4.) percentComplete (integer)
		            
		            
		            Default value: null
				
		        url
		        URL to which the form data will be submitted.

		        Default value: value of form's action attribute


		        Example:
		        
// prepare Options Object
var options =3D {
    target:     '#divToUpdate',
    url:        'comment.php',
    success:    function() {
        alert('Thanks for your comment!');
    }
};

// pass options to ajaxForm
$('#myForm').ajaxForm(options);
			
		    Note that the Options Object can also be used to pass values to jQuer=
y's
		    $.ajax=
 method.
		    If you are familiar with the options supported by $.ajax
		    you may use them in the Options Object passed to ajaxForm and
		    ajaxSubmit.
			
	=09


=09
=09


        
            
            
           =20
        
       Code Samples


            
                ajax=
Form
                ajax=
Submit
                Vali=
dation
                JSON=

                XML<=
/a>

                HTML=

                File=
 Uploads
            
            
            
            The following code controls the HTML form beneath it. It uses <=
code class=3D"inline">ajaxForm
                to bind the form and demonstrates how to use pre- and post-=
submit callbacks.
                
// prepare the form when the D=
OM is ready
$(document).ready(function() {
    var options =3D {
        target:        '#output1',   // target element(s) to be updated wit=
h server response
        beforeSubmit:  showRequest,  // pre-submit callback
        success:       showResponse  // post-submit callback

        // other available options:
        //url:       url         // override for form's 'action' attribute
        //type:      type        // 'get' or 'post', override for form's 'm=
ethod' attribute
        //dataType:  null        // 'xml', 'script', or 'json' (expected se=
rver response type)
        //clearForm: true        // clear all form fields after successful =
submit
        //resetForm: true        // reset the form after successful submit

        // $.ajax options can be used here too, for example:
        //timeout:   3000
    };

    // bind form using 'ajaxForm'
    $('#myForm1').ajaxForm(options);
});

// pre-submit callback
function showRequest(formData, jqForm, options) {
    // formData is an array; here we use $.param to convert it to a string =
to display it
    // but the form plugin does this for you automatically when it submits =
the data
    var queryString =3D $.param(formData);

    // jqForm is a jQuery object encapsulating the form element.  To access=
 the
    // DOM element for the form do this:
    // var formElement =3D jqForm[0];

    alert('About to submit: \n\n' + queryString);

    // here we could return false to prevent the form from being submitted;
    // returning anything other than false will allow the form submit to co=
ntinue
    return true;
}

// post-submit callback
function showResponse(responseText, statusText, xhr, $form)  {
    // for normal html responses, the first argument to the success callbac=
k
    // is the XMLHttpRequest object's responseText property

    // if the ajaxForm method was passed an Options Object with the dataTyp=
e
    // property set to 'xml' then the first argument to the success callbac=
k
    // is the XMLHttpRequest object's responseXML property

    // if the ajaxForm method was passed an Options Object with the dataTyp=
e
    // property set to 'json' then the first argument to the success callba=
ck
    // is the json data object returned by the server

    alert('status: ' + statusText + '\n\nresponseText: \n' + responseText +
        '\n\nThe output div should have already been updated with the respo=
nseText.');
}

                
                        
                        
                        Name: 
                        Password: 
                        Multiple: 
                        Single: 
                        Single2: 

                        Check: 
                            
                            
                            
                        
                        Radio: 
                            
                            

                            
                        
                        Text: This is Form1
                        
                        
                        
                        
                        
                        
						
                
                Output Div (#output1):
                AJAX response will replace this content=
.

The following code controls the HTML form beneath it. It uses <= code class=3D"inline">ajaxSubmit to submit the form.

// prepare the form when the D=
OM is ready
$(document).ready(function() {
    var options =3D {
        target:        '#output2',   // target element(s) to be updated wit=
h server response
        beforeSubmit:  showRequest,  // pre-submit callback
        success:       showResponse  // post-submit callback

        // other available options:
        //url:       url         // override for form's 'action' attribute
        //type:      type        // 'get' or 'post', override for form's 'm=
ethod' attribute
        //dataType:  null        // 'xml', 'script', or 'json' (expected se=
rver response type)
        //clearForm: true        // clear all form fields after successful =
submit
        //resetForm: true        // reset the form after successful submit

        // $.ajax options can be used here too, for example:
        //timeout:   3000
    };

    // bind to the form's submit event
    $('#myForm2').submit(function() {
        // inside event callbacks 'this' is the DOM element so we first
        // wrap it in a jQuery object and then invoke ajaxSubmit
        $(this).ajaxSubmit(options);

        // !!! Important !!!
        // always return false to prevent standard browser submit and page =
navigation
        return false;
    });
});

// pre-submit callback
function showRequest(formData, jqForm, options) {
    // formData is an array; here we use $.param to convert it to a string =
to display it
    // but the form plugin does this for you automatically when it submits =
the data
    var queryString =3D $.param(formData);

    // jqForm is a jQuery object encapsulating the form element.  To access=
 the
    // DOM element for the form do this:
    // var formElement =3D jqForm[0];

    alert('About to submit: \n\n' + queryString);

    // here we could return false to prevent the form from being submitted;
    // returning anything other than false will allow the form submit to co=
ntinue
    return true;
}

// post-submit callback
function showResponse(responseText, statusText, xhr, $form)  {
    // for normal html responses, the first argument to the success callbac=
k
    // is the XMLHttpRequest object's responseText property

    // if the ajaxSubmit method was passed an Options Object with the dataT=
ype
    // property set to 'xml' then the first argument to the success callbac=
k
    // is the XMLHttpRequest object's responseXML property

    // if the ajaxSubmit method was passed an Options Object with the dataT=
ype
    // property set to 'json' then the first argument to the success callba=
ck
    // is the json data object returned by the server

    alert('status: ' + statusText + '\n\nresponseText: \n' + responseText +
        '\n\nThe output div should have already been updated with the respo=
nseText.');
}

Name:
Password:
Multiple:
Single:
Single2:
Check:
Radio:
Text:	This is Form2

Output Div (#output2):

AJAX response will replace this content= .

This page gives several examples of how form data can be valida= ted before it is sent to the server. The secret is in the before= Submit option. If this pre-submit callback returns false, the submit process is aborte= d.

The following login form is used for each of the examples that = follow. Each example will validate that both the username and password<= /em> fields have been filled in by the user.

Form Markup:

<form id=3D"validationForm" act=
ion=3D"dummy.php" method=3D"post">
    Username: <input type=3D"text" name=3D"username" />
    Password: <input type=3D"password" name=3D"password" />
    <input type=3D"submit" value=3D"Submit" />
</form>

First, we initialize the form and give it a beforeSubmit callback function - this is the validation function.
// prepare the form when the DOM i= s ready $(document).ready(function() { // bind form using ajaxForm $('#myForm2').ajaxForm( { beforeSubmit: validate } ); });

Validate Using the formData Argument

Username: Password:

function validate(formData, jqForm, op= tions) { // formData is an array of objects representing the name and value of e= ach field // that will be sent to the server; it takes the following form: // // [ // { name: username, value: valueOfUsernameInput }, // { name: password, value: valueOfPasswordInput } // ] // // To validate, we can examine the contents of this array to see if the // username and password fields have values. If either value evaluates // to false then we return false from this method. for (var i=3D0; i < formData.length; i++) { if (!formData[i].value) { alert('Please enter a value for both Username and Password'); return false; } } alert('Both fields contain values.'); }

Validate Using the jqForm Argument

Username: Password:

function validate(formData, jqForm, op= tions) { // jqForm is a jQuery object which wraps the form DOM element // // To validate, we can access the DOM elements directly and return true // only if the values of both the username and password fields evaluate // to true var form =3D jqForm[0]; if (!form.username.value || !form.password.value) { alert('Please enter a value for both Username and Password'); return false; } alert('Both fields contain values.'); }

Validate Using the fieldValue Method

Username: Password:

function validate(formData, jqForm, op= tions) { // fieldValue is a Form Plugin method that can be invoked to find the // current value of a field // // To validate, we can capture the values of both the username and pass= word // fields and return true only if both evaluate to true var usernameValue =3D $('input[name=3Dusername]').fieldValue(); var passwordValue =3D $('input[name=3Dpassword]').fieldValue(); // usernameValue and passwordValue are arrays but we can do simple // "not" tests to see if the arrays are empty if (!usernameValue[0] || !passwordValue[0]) { alert('Please enter a value for both Username and Password'); return false; } alert('Both fields contain values.'); }

Note
You can find jQuery plugins that deal specifically with field v= alidation on the jQuery Plugins Page.

This page shows how to handle JSON data returned from the serve= r.
The form below submits a message to the server and the server echos it back in JSON format.
Form markup:
<form id=3D"jsonForm" action=3D= "json-echo.php" method=3D"post"> Message: <input type=3D"text" name=3D"message" value=3D"Hello JSON" = /> <input type=3D"submit" value=3D"Echo as JSON" /> </form>

Message:

Server code in json-ech= o.php:
<?php echo '{ "message": "' . $_PO= ST['message'] . '" }'; ?>
JavaScript:
// prepare the form when the DOM is re= ady $(document).ready(function() { // bind form using ajaxForm $('#jsonForm').ajaxForm({ // dataType identifies the expected content type of the server resp= onse dataType: 'json', // success identifies the function to invoke when the server respon= se // has been received success: processJson }); });
Callback function
function processJson(data) { // 'data' is the json object returned from the server alert(data.message); }

This page shows how to handle XML data returned from the ser= ver.
The form below submits a message to the server and the serve= r echos it back in XML format.
Form markup:
<form id=3D"xmlForm" action= =3D"xml-echo.php" method=3D"post"> Message: <input type=3D"text" name=3D"message" value=3D"Hello XML" /= > <input type=3D"submit" value=3D"Echo as XML" /> </form>

Message:

Server code in xml-e= cho.php:
<?php // !!! IMPORTANT !!! - the server must set the content type to XML header('Content-type: text/xml'); echo '<root><message>' . $_POST['message'] . '</message>&= lt;/root>'; ?>
JavaScript:
// prepare the form when the DOM is= ready $(document).ready(function() { // bind form using ajaxForm $('#xmlForm').ajaxForm({ // dataType identifies the expected content type of the server resp= onse dataType: 'xml', // success identifies the function to invoke when the server respon= se // has been received success: processXml }); });
Callback function
function processXml(responseXML) { // 'responseXML' is the XML document returned by the server; we use // jQuery to extract the content of the message node from the XML doc var message =3D $('message', responseXML).text(); alert(message); }

This page shows how to handle HTML data returned from the serve= r.
The form below submits a message to the server and the server echos it back in an HTML div. The response is added to this page in the htmlExampleTarget div= below.
Form markup:
<form id=3D"htmlForm" action=3D= "html-echo.php" method=3D"post"> Message: <input type=3D"text" name=3D"message" value=3D"Hello HTML" = /> <input type=3D"submit" value=3D"Echo as HTML" /> </form>

Message:

Server code in html-ech= o.php:
<?php echo '<div style=3D"background-color:#ffa; padding:20px">' . $_POST['= message'] . '</div>'; ?>
JavaScript:
// prepare the form when the DOM is re= ady $(document).ready(function() { // bind form using ajaxForm $('#htmlForm').ajaxForm({ // target identifies the element(s) to update with the server respo= nse target: '#htmlExampleTarget', // success identifies the function to invoke when the server respon= se // has been received; here we apply a fade-in effect to the new con= tent success: function() { $('#htmlExampleTarget').fadeIn('slow'); } }); });

htmlExampleTarget (output will be added below):

This page demonstrates the Form Plugin's file upload capabiliti= es. There is no special coding required to handle file uploads. File input elements are= automatically detected and processed for you.
Browsers that support the XMLHttpRequest Level 2 will be able to upload files seamlessly and even get progress updates as= the upload proceeds. For older browsers, a fallback technology is used which involves iframes= since it is =09 not possible to upload files using the level 1 implmenentation = of the XMLHttpRequest object. This is a common fallback technique, but it has inherent limita= tions. The iframe element is used as the target of the form's submit operation which means that the server resp= onse is written to the iframe. This is fine if the response type is HTML or XML, but doesn't w= ork as well if the response type is script or JSON, both of which often contain characters that nee= d to be repesented using entity references when found in HTML markup.
To account for the challenges of script and JSON responses when= using the iframe mode, the Form Plugin allows these responses to be embedded in a textarea elem= ent and it is recommended that you do so for these response types when used in conjuction with fil= e uploads and older browsers.=20
It is important to note that even when the dataType option is s= et to 'script', and the server is=20 actually responding with some javascript to a multipart form su= bmission,=20 the response's Content-Type header should be forced to te= xt/html, otherwise Internet Explorer will prompt the user to download a "file".
Also note that if there is no file input in the form then the request us= es normal XHR to submit the form (not an iframe). This puts the burden o= n your server code to know when to use a textarea and when not to. If you like, you can use th= e iframe option of the plugin to force it to always use an iframe mo= de and then your server can always embed the response in a textarea. But the recommended s= olution is to test for the 'X-Requested-With' request header. If the value of that header is 'XMLH= ttpRequest' then you know that the form was posted via ajax. The following PHP snippet shows how you can be sure to return c= ontent successfully:
<?php =09 $xhr =3D $_SERVER['HTTP_X_REQUESTED_WITH'] =3D=3D 'XMLHttpRequest'; if (!$xhr)=20 echo '<textarea>'; ?> // main content of response here =09 <?php if (!$xhr) =20 echo '</textarea>'; ?>

The form below provides an input element of type "file" along w= ith a select element to specify the dataType of the response. The form is submitted= to files.php which uses the dataType to determine what type of response to return.

File: Return Type:

Output:

Examples that show how to display upload progress:

Progress D= emo 1
Prog= ress Demo 2
Prog= ress Demo 3

Working With Fields
This page describes and demonstrates the Form Plugin's fieldValue and fieldSerialize methods.

fieldValue
fieldValue allows you to retrieve the current value of a field. For e= xample, to retrieve the value of the password field in a form with the id of 'myForm' you would write:
var pwd =3D $('#myForm :password')= .fieldValue()[0];
This method always returns an array. If n= o valid value can be determined the array will be empty, otherwise it will contain one or more = values.

fieldSerialize
fieldSerialize allows you to = serialize a subset of a form into a query string. This is useful when you need to process only= certain fields. For example, to serialize only the text inputs of a form you would write= :
var queryString =3D $('#myForm :te= xt').fieldSerialize();

Demonstration
Enter a jQuery expression into the textbox below and th= en click 'Test' to see the results of the fieldValue and fieldSerialize methods. These methods are run against the test form t= hat follows.
jQuery expression: (ie: textarea, [@type=3D'hid= den'], :radio, :checkbox, etc)
Successful controls only ^[1]

Test Form

<input type=3D"hidden" name=3D"Hidden" value=3D"secret" />

<input name=3D"Name" type=3D"text" value=3D"MyName1" />

<input name=3D"Password= " type=3D"password" />

<select name=3D"Multipl= e" multiple=3D"multiple">

<select name=3D"Single"= >

<input type=3D"checkbox" name=3D"Check" value=3D"1" />

<input type=3D"checkbox" name=3D"Check" value=3D"2" />

<input type=3D"checkbox" name=3D"Check" value=3D"3" />

<input type=3D"checkbox" name=3D"Check2" value=3D"4" />

<input type=3D"checkbox" name=3D"Check2" value=3D"5" />

<input type=3D"checkbox" name=3D"Check3" />

<input type=3D"radio" n= ame=3D"Radio" value=3D"1" />

<input type=3D"radio" n= ame=3D"Radio" value=3D"2" />

<input type=3D"radio" n= ame=3D"Radio" value=3D"3" />

<input type=3D"radio" n= ame=3D"Radio2" value=3D"4" />

<input type=3D"radio" n= ame=3D"Radio2" value=3D"5" />

<textarea name=3D"Text"= rows=3D"2" cols=3D"20"></textarea>

<input type=3D"reset" n= ame=3D"resetButton" value=3D"Reset" />

<input type=3D"submit" = name=3D"sub" value=3D"Submit" />

[1] http://www.w3.org/TR/html4/inter= act/forms.html#successful-controls.
By default, fieldValue= and fieldSerialize only function on 'successful controls'. This means that if you run the foll= owing code on a checkbox that is not checked, the result will be an empty array.
// value will be an empty arra= y if checkbox is not checked: var value =3D $('#myUncheckedCheckbox').fieldValue(); // value.length =3D=3D 0
However, if you really want to know the 'value' of the chec= kbox element, even if it's unchecked, you can write this:
// value will hold the checkbox va= lue even if it's not checked: var value =3D $('#myUncheckedCheckbox').fieldValue(false); // value.length =3D=3D 1

Frequently Asked Questions

What versions of jQuery is the Form Plugin compatible with?
The Form Plugin is compatible with jQuery v1.5 and later.

Does the Form Plugin have any dependencies on other plugins?
No.

Is the Form Plugin fast? Does it serialize forms accurately?
Yes! See our c= omparison page for a look at how the Form Plugin compares to other libr= aries (including Prototype and dojo).

What is the easiet way to use the Form Plugin?

ajaxForm provides the simplest wa= y to enable your HTML form to use AJAX. It's the one-stop-shopping method for preparing forms.

What is the difference between ajaxForm<= /code> and ajaxSubmit?
There are two main differences between these methods:
ajaxSubmit submits the fo= rm, ajaxForm does not. When you invoke ajaxSubmit it immediately serializes the form data and sends it to the server. When you invoke = ajaxForm it adds the necessary event listener= s to the form so that it can detect when the form is submitted by the= user. When this occurs ajaxSubmit is called= for you.

When using ajaxForm the s= ubmitted data will include the name and value of the submitting element (or= its click coordinates if the submitting element is an image).

How can I cancel a form submit?

You can prevent a form from being submitted by adding a 'before= Submit' callback function and returning false from that function. See the Code = Samples page for an example.

Is there a unit test suite for the Form Plugin?

Yes! The Form Plugin has an extensive set of tests that are us= ed to validate its functionality. Run unit tests.

Does the Form Plugin support file uploads?

Yes!

Why aren't all my input values posted?

jQuery form serialization aheres closely to the HTML spec. Onl= y=20 successful controls=20 are valid for submission.

How do I display upload progress information?

Demo

Download

The Official Form Plugin is available here: jquery.form.js or from the plugin's Github repository.
Minified version: jquery.form.min.js
There are many other useful Form Plugins available from the jQuery Plugins page.

Support
Support for the Form Plugin is available through the jQuery Google Group. This is a very active group to which many jQuery developers and users sub= scribe.

Contributors

Development of the Form Plugin was a community effort with many peo= ple contributing ideas and code. The following people have made contributions of one kind or another= :

John Resig

Mike Alsup

Mark Constable

Klaus Hartl

Matt Grimm

Yehuda Katz

J=C3=B6rn Zaefferer

Sam Collett

Gilles van den Hoven

Kevin Glowacz

Alex Andrienko

Send me an email if I've forgotten someone.

=20
This site is maintained by Mike Alsup.

Output Div (#output1):

Output Div (#output2):

Validate Using the `formData` Argument

Validate Using the `jqForm` Argument

Validate Using the `fieldValue` Method

Note

htmlExampleTarget (output will be added below):

Support

Contributors

jQuery Form Plugin

Overview

Quick Start Guide

Form Plugin API

ajaxForm and ajaxSubmit Options

Code Samples

Working With Fields

fieldValue

fieldSerialize

Frequently Asked Questions

Download

<input type=3D"hidden" name=3D"Hidden" value=3D"secret" />
<input name=3D"Name" type=3D"text" value=3D"MyName1" />
<input name=3D"Password= " type=3D"password" />
<select name=3D"Multipl= e" multiple=3D"multiple">
<select name=3D"Single"= >
<input type=3D"checkbox" name=3D"Check" value=3D"1" />
<input type=3D"checkbox" name=3D"Check" value=3D"2" />
<input type=3D"checkbox" name=3D"Check" value=3D"3" />
<input type=3D"checkbox" name=3D"Check2" value=3D"4" />
<input type=3D"checkbox" name=3D"Check2" value=3D"5" />
<input type=3D"checkbox" name=3D"Check3" />
<input type=3D"radio" n= ame=3D"Radio" value=3D"1" />
<input type=3D"radio" n= ame=3D"Radio" value=3D"2" />
<input type=3D"radio" n= ame=3D"Radio" value=3D"3" />
<input type=3D"radio" n= ame=3D"Radio2" value=3D"4" />
<input type=3D"radio" n= ame=3D"Radio2" value=3D"5" />
<textarea name=3D"Text"= rows=3D"2" cols=3D"20"></textarea>
<input type=3D"reset" n= ame=3D"resetButton" value=3D"Reset" />
<input type=3D"submit" = name=3D"sub" value=3D"Submit" />

jQuery Form Plugin

Overview

Quick Start Guide

Form Plugin API

ajaxForm and ajaxSubmit Options

Code Samples

Output Div (#output1):

Output Div (#output2):

Validate Using the formData Argument

Validate Using the jqForm Argument

Validate Using the fieldValue Method

Note

htmlExampleTarget (output will be added below):

Working With Fields

fieldValue

fieldSerialize

Frequently Asked Questions

Download

Support

Contributors

Validate Using the `formData` Argument

Validate Using the `jqForm` Argument

Validate Using the `fieldValue` Method