jquery-serializejson

jquery.serializeJSON
====================

Adds the method .serializeJSON() to jQuery to serializes a form into a JavaScript Object. Supports the same format for nested parameters that is used in Ruby on Rails.

Install
-------

Install with bower bower install jquery.serializeJSON, or npm npm install jquery-serializejson, or just download the jquery.serializejson.js script.

And make sure it is included after jQuery, for example:
``html


`

Usage Example
-------------

HTML form:
`html









`

JavaScript:
`javascript
$('form').serializeJSON();

// returns =>
{
title: "Dune",
author: {
name: "Frank Herbert",
period: "1945–1986"
}
}
`

Nested attributes and arrays can be specified by naming fields with the syntax: name="attr[nested][nested]".

HTML form:
`html


serializeJSON
javascript

tinytest.js
javascript

Paper
Rock
Scissors

Red
Blue
Yellow

`

JavaScript:

`javascript
$('#my-profile').serializeJSON();

// returns =>
{
fullName: "Mario",

address: {
city: "San Francisco",
state: {
name: "California",
abbr: "CA"
}
},

jobbies: ["code", "climbing"],

projects: {
'0': { name: "serializeJSON", language: "javascript", popular: "1" },
'1': { name: "tinytest.js", language: "javascript", popular: "0" }
},

selectOne: "rock",
selectMultiple: ["red", "blue"]
}
`

The serializeJSON function returns a JavaScript object, not a JSON String. The plugin should probably have been called serializeObject or similar, but that plugin name was already taken.

To convert into a JSON String, use the JSON.stringify method, that is available on all major new browsers.
If you need to support very old browsers, just include the json2.js polyfill (as described on stackoverfow).

`javascript
var obj = $('form').serializeJSON();
var jsonString = JSON.stringify(obj);
`

The plugin serializes the same inputs supported by .serializeArray(), following the standard W3C rules for successful controls. In particular, the included elements cannot be disabled and must contain a name attribute. No submit button value is serialized since the form was not submitted using a button. And data from file select elements is not serialized.


Parse values with :types
------------------------

Fields values are :string by default. But can be parsed with types by appending a :type suffix to the field name:

`html


`

`javascript
$('form').serializeJSON();

// returns =>
{
"default": ":string is the default",
"text": "some text string",
// excluded:skip is ignored in the output

"numbers": {
"1": 1,
"1.1": 1.1,
"other": NaN, // <-- "other" is parsed as NaN
},
"bools": {
"true": true,
"false": false,
"0": false, // <-- "false", "null", "undefined", "", "0" are parsed as false
},
"nulls": {
"null": null, // <-- "false", "null", "undefined", "", "0" are parsed as null
"other": "other" // <-- if not null, the type is a string
},
"arrays": { // <-- uses JSON.parse
"empty": [],
"not empty": [1,2,3]
},
"objects": { // <-- uses JSON.parse
"empty": {},
"not empty": {"my": "stuff"}
}
}
`

Types can also be specified with the attribute data-value-type, instead of adding the :type suffix in the field name:

`html










`

If your field names contain colons (e.g. name="article[my::key][active]") the last part after the colon will be confused as an invalid type. One way to avoid that is to explicitly append the type :string (e.g. name="article[my::key][active]:string"), or to use the attribute data-value-type="string". Data attributes have precedence over :type name suffixes. It is also possible to disable parsing :type suffixes with the option { disableColonTypes: true }.




$3

Use the customTypes option to provide your own parsing functions. The parsing functions receive the input name as a string, and the DOM elment of the serialized input.

`html









`

`javascript
$('form').serializeJSON({
customTypes: {
alwaysBoo: (strVal, el) => {
// strVal: is the input value as a string
// el: is the dom element. $(el) would be the jQuery element
return "boo"; // value returned in the serialization of this type
},
}
});

// returns =>
{
"scary": "boo", // <-- parsed with custom type "alwaysBoo"
"str": "str",
"five": 5,
}
`

The provided customTypes can include one of the detaultTypes to override the default behavior:

`javascript
$('form').serializeJSON({
customTypes: {
alwaysBoo: (strVal) => { return "boo"; },
string: (strVal) => { return strVal + "-OVERDRIVE"; },
}
});

// returns =>
{
"scary": "boo", // <-- parsed with custom type "alwaysBoo"
"str": "str-OVERDRIVE", // <-- parsed with custom override "string"
"five": 5, // <-- parsed with default type "number"
}
`

Default types used by the plugin are defined in $.serializeJSON.defaultOptions.defaultTypes.


Options
-------

With no options, .serializeJSON() returns the same as a regular HTML form submission when serialized as Rack/Rails params. In particular:

* Values are strings (unless appending a :type to the input name)
* Unchecked checkboxes are ignored (as defined in the W3C rules for successful controls).
* Disabled elements are ignored (W3C rules)
* Keys (input names) are always strings (nested params are objects by default)

Available options:

* checkboxUncheckedValue: string, return this value on checkboxes that are not checked. Without this option, they would be ignored. For example: {checkboxUncheckedValue: ""} returns an empty string. If the field has a :type, the returned value will be properly parsed; for example if the field type is :boolean, it returns false instead of an empty string.
* useIntKeysAsArrayIndex: true, when using integers as keys (i.e. ), serialize as an array ({"foods": ["banana"]}) instead of an object ({"foods": {"0": "banana"}).
* skipFalsyValuesForFields: [], skip given fields (by name) with falsy values. You can use data-skip-falsy="true" input attribute as well. Falsy values are determined after converting to a given type, note that "0" as :string (default) is still truthy, but 0 as :number is falsy.
* skipFalsyValuesForTypes: [], skip given fields (by :type) with falsy values (i.e. skipFalsyValuesForTypes: ["string", "number"] would skip "" for :string fields, and 0 for :number fields).
* customTypes: {}, define your own :type functions. Defined as an object like { type: function(value){...} }. For example: {customTypes: {nullable: function(str){ return str || null; }}. Custom types extend defaultTypes.
* defaultTypes: {defaults}, contains the orignal type functions string, number, boolean, null, array, object and skip.
* defaultType: "string", fields that have no :type suffix and no data-value-type attribute are parsed with the string type function by default, but it could be changed to use a different type function instead.
* disableColonTypes: true, do not parse input names as types, allowing field names to use colons. If this option is used, types can still be specified with the data-value-type attribute. For example will be parsed as a number.

More details about these options in the sections below.

Include unchecked checkboxes

One of the most confusing details when serializing a form is the input type checkbox, because it includes the value if checked, but nothing if unchecked.

To deal with this, a common practice in HTML forms is to use hidden fields for the "unchecked" values:

`html



`

This solution is somehow verbose, but ensures progressive enhancement, it works even when JavaScript is disabled.

But, to make things easier, serializeJSON includes the option checkboxUncheckedValue and the possibility to add the attribute data-unchecked-value to the checkboxes:

`html









`

Serializes like this by default:

`javascript
$('form').serializeJSON();

// returns =>
{check1: 'true'} // check2 and check3 are ignored
`

To include all checkboxes, use the checkboxUncheckedValue option:

`javascript
$('form').serializeJSON({checkboxUncheckedValue: "false"});

// returns =>
{check1: "true", check2: "false", check3: "false"}
`

The data-unchecked-value HTML attribute can be used to targed specific values per field:

`html


`

`javascript
$('form#checkboxes').serializeJSON(); // No option is needed if the data attribute is used

// returns =>
{
'checked': {
'b': true,
'numb': '1',
'cool': 'YUP'
},
'unchecked': {
'bool': false,
'bin': '0'
// 'cool' is not included, because it doesn't use data-unchecked-value
}
}
`

You can use both the option checkboxUncheckedValue and the attribute data-unchecked-value at the same time, in which case the option is used as default value (the data attribute has precedence).

`javascript
$('form#checkboxes').serializeJSON({checkboxUncheckedValue: 'NOPE'});

// returns =>
{
'checked': {
'b': true,
'numb': '1',
'cool': 'YUP'
},
'unchecked': {
'bool': false, // value from data-unchecked-value attribute, and parsed with type "boolean"
'bin': '0', // value from data-unchecked-value attribute
'cool': 'NOPE' // value from checkboxUncheckedValue option
}
}
`

Ignore Empty Form Fields

You can use the option .serializeJSON(skipFalsyValuesForTypes: ["string"]), which ignores any string field with an empty value (default type is :string, and empty strings are falsy).

Another option, since serializeJSON() is called on a jQuery object, is to just use the proper jQuery selector to skip empty values (see Issue #28 for more info):

`javascript
// Select only imputs that have a non-empty value
$('form :input[value!=""]').serializeJSON();

// Or filter them from the form
obj = $('form').find('input').not('[value=""]').serializeJSON();

// For more complicated filtering, you can use a function
obj = $form.find(':input').filter(function () {
return $.trim(this.value).length > 0
}).serializeJSON();
`




Ignore Fields With Falsy Values

When using :types, you can also skip falsy values (false, "", 0, null, undefined, NaN) by using the option skipFalsyValuesForFields: ["fullName", "address[city]"] or skipFalsyValuesForTypes: ["string", "null"].

Or setting a data attribute data-skip-falsy="true" on the inputs that should be ignored. Note that data-skip-falsy is aware of field :types, so it knows how to skip a non-empty input like this (Note that "0" as a string is not falsy, but 0 as number is falsy)).




Use integer keys as array indexes

By default, all serialized keys are strings, this includes keys that look like numbers like this:

`html









`

`javascript
$('form').serializeJSON();

// arr is an object =>
{'arr': {'0': 'foo', '1': 'var', '5': 'inn' }}
`

Which is how Rack parse_nested_query behaves. Remember that serializeJSON input name format is fully compatible with Rails parameters, that are parsed using this Rack method.

Use the option useIntKeysAsArrayIndex to interpret integers as array indexes:

`javascript
$('form').serializeJSON({useIntKeysAsArrayIndex: true});

// arr is an array =>
{'arr': ['foo', 'var', undefined, undefined, undefined, 'inn']}
`

Note: this was the default behavior of serializeJSON before version 2. You can use this option for backwards compatibility.




Option Defaults

All options defaults are defined in $.serializeJSON.defaultOptions. You can just modify it to avoid setting the option on every call to serializeJSON. For example:

`javascript
$.serializeJSON.defaultOptions.checkboxUncheckedValue = ""; // include unckecked checkboxes as empty strings
$.serializeJSON.defaultOptions.customTypes.foo = (str) => { return str + "-foo"; }; // define global custom type ":foo"
`


Alternatives
------------

Other plugins solve the same problem in similar ways:

* https://github.com/macek/jquery-serialize-object
* https://github.com/hongymagic/jQuery.serializeObject
* https://github.com/danheberden/jquery-serializeForm
* https://github.com/maxatwork/form2js (plain js, no jQuery)
* https://github.com/serbanghita/formToObject.js (plain js, no jQuery)
* https://gist.github.com/shiawuen/2634143 (simpler but small)

None of them did what I needed at the time serializeJSON was created. Factors that differentiate serializeJSON from the alternatives:

* Simple and small code base. The minimified version is < 1Kb.
* Yet flexible enough with features like nested objects, unchecked-checkboxes and custom types.
* Implementation follows the same rules as the jQuery method serializeArray, that creates a JavaScript array of objects, ready to be encoded as a JSON string. Taking into account the W3C rules for successful controls for better compatibility.
* The format for the input field names is the same used by Rails (from Rack::Utils.parse_nested_query), that is successfully used by many backend systems and already well understood by many front end developers.
* Exaustive test suite helps iterate on new releases and bugfixes with confidence.
* Compatible with bower, zepto.js and pretty much every version of jQuery.


Contributions
-------------

Contributions are awesome. Feature branch pull requests are the preferred method. Just make sure to add tests for it. To run the jasmine specs, just open spec/spec_runner_jquery.html` in your browser.

Changelog
---------

See CHANGELOG.md

Author
-------

Written and maintained by Mario Izquierdo