Skip to content
Converts HTML form into JavaScript object
JavaScript CSS HTML
Branch: master
Clone or download

Latest commit


Type Name Latest commit message Commit time
Failed to load latest commit information.
dist bump version to 2.5.0 Jul 8, 2015
test address #107 Sep 7, 2017
.gitignore Refactor plugin into FormSerializer; add tests Sep 14, 2013 style fix Apr 12, 2016 bump version to 2.5.0 Jul 8, 2015
LICENSE Update copyright in LICENSE Mar 10, 2014 fix typo Sep 27, 2017
bower.json loosen jquery version requirement Jan 31, 2015
composer.json Added Composer package support. Apr 7, 2016
jquery.serialize-object.js bump version to 2.5.0 Jul 8, 2015
package.json bump version to 2.5.0 Jul 8, 2015

jQuery Serialize Object

As seen on StackOverflow: Convert forms to JSON LIKE A BOSS.

Adds the method serializeObject to jQuery, to perform complex form serialization into JavaScript objects.

The current implementation relies in jQuery.serializeArray() to grab the form attributes and then create the object using the input name attributes.

This means it will serialize the inputs that are supported by .serializeArray(), that use the standard W3C rules for successful controls to determine which inputs should be included; in particular:

  • The input cannot be disabled and must contain a name attribute.
  • No submit button value is serialized since the form is not submitted using a button.
  • Data from <input type="file"> inputs are not serialized.


option 1: NPM

$ npm install form-serializer

option 2: Bower

$ bower install jquery-serialize-object

option 3: Manual

Copy the dist/jquery.serialize-object.min.js to your project.

You can include the plugin in the HEAD element or at the bottom of your BODY tag. Wherever you choose to add it, it must be included after your jQuery.

  <script src="jquery.min.js"></script>
  <script src="jquery.serialize-object.min.js"></script>


Version 2.0 takes jquery-serialize-object into maturity. It is now backed by a full test suite so you can be confident that it will work in your web app.

Moving ahead, on top of core serialization, .serializeObject will support correct serializaton for boolean and number values, resulting valid types for both cases.

Look forward to these >= 2.5.0

Update: >= 2.4.0 now serializes <input type="checkbox"> as a boolean. See the test for specific behavior.


Given a basic HTML form

<form id="contact">
  <input name="user[email]" value="">
  <input name="user[pets][]" type="checkbox" value="cat" checked>
  <input name="user[pets][]" type="checkbox" value="dog" checked>
  <input name="user[pets][]" type="checkbox" value="bird">
  <input type="submit">

.serializeObject — serializes the selected form into a JavaScript object

//=> {user: {email: "", pets: ["cat", "dog"]}}

.serializeJSON — serializes the selected form into JSON

//=> '{"user":{"email":"","pets":["cat","dog"]}}'

FormSerializer.patterns — modify the patterns used to match field names

Many of you have requested to allow - in field names or use . to nest keys. You can now configure these to your heart's content.

Hyphen example

$.extend(FormSerializer.patterns, {
  validate: /^[a-z][a-z0-9_-]*(?:\[(?:\d*|[a-z0-9_-]+)\])*$/i,
  key:      /[a-z0-9_-]+|(?=\[\])/gi,
  named:    /^[a-z0-9_-]+$/i

Dot-notation example

$.extend(FormSerializer.patterns, {
  validate: /^[a-z][a-z0-9_]*(?:\.[a-z0-9_]+)*(?:\[\])?$/i

Validating and Key parsing

  • validate — only valid input names will be serialized; invalid names will be skipped

  • key — this pattern parses all "keys" from the input name; You will want to use /g as a modifier with this regexp.

Key styles

  • push — push a value to an array

    <input name="foo[]" value="a">
    <input name="foo[]" value="b">
    //=> {foo: [a, b]}
  • fixed — add a value to an array at a specified index

    <input name="foo[2]" value="a">
    <input name="foo[4]" value="b">
    //=> {foo: [, , "a", , "b"]}
  • named — adds a value to the specified key

    <input name="foo[bar]" value="a">
    <input name="foo[bof]" value="b">
    <input name="hello" value="world">
    //=> {foo: {bar: "a", bof: "b"}, hello: "world"}


If you have node.js installed, as a convenience, you can run

$ npm test

If you do not have node installed, simply

$ open ./test/test.html


CoffeeScript has been dropped for >= 2.0.0. If members of the community would like to support this, please feel free to add a CoffeeScript version.

If you'd like to use the the 1.0.0 version, it is still available here.



You can’t perform that action at this time.