Helper function for converting a HTML form to a JavaScript Object


This function is one of many helpers used by the dojo Xhr subsystem for handling AJAX style requests. This particular function takes a HTML form node and converts the form elements into a JavaScript object of name/value pairs. Disabled form elements, buttons, elements with just an id attribute but no name attribute, and other non-valued HTML elements are skipped. The resulting object can then be processed however you like. Note that the form can contain dijit.form.* items.

Since Dojo 1.7, dojo.formToObject is exposed via the toObject method of the dojo/dom-form module. An alias is kept in dojo/_base/xhr for backward-compatibility.


Usage is simple and straightforward, you pass the form node or the string id of a form node to convert:

Dojo 1.7+ (AMD)

require(["dojo/dom-form"], function(domForm){
  var formObj = domForm.toObject("myId");

Dojo < 1.7

var formObj = dojo.formToObject("myId");

The function will hand back a JavaScript object of the name/value pairs from the form elements. The values are either strings or arrays. If a checkbox group has a single item selected, the function will return a string value; if several, an array.


Create an object version of a form


  dojo.connect(dijit.byId("convertForm"), "onClick", function(){
     var formObject1 =  dojo.formToObject("myform");

     // Attach it into the dom as pretty-printed text.
     dojo.byId("formObject").innerHTML = dojo.toJson(formObject1, true);
<p>The FORM</p>
<form id="myform">
   <p>text1: <input type="text" name="text1" value="value1"><br>
   text2: <input type="text" name="text2" value="value2"><br> <input id="f6_checkbox1" type="checkbox" name="cb_group" value="foo" checked><br> <input id="f6_checkbox2" type="checkbox" name="cb_group" value="boo"><br>
   radio_group.baz: <input id="f6_radio1" type="radio" name="radio_group" value="baz"><br>
   radio_group.bam: <input id="f6_radio2" type="radio" name="radio_group" value="bam" checked><br>
   radio_group.baf: <input id="f6_radio3" type="radio" name="radio_group" value="baf"></p>
<p><button id="convertForm" data-dojo-type="dijit.form.Button">Click to convert the form to an object</button></p>
<p>The form as an object:</p>
<pre id="formObject"></pre>

Create an object version of a form with Dijit widgets


  dojo.connect(dijit.byId("convertFormDigits"), "onClick", function(){
     var formObject2 =  dojo.formToObject("myform2");

     // Attach it into the dom as pretty-printed text.
     dojo.byId("formObject2").innerHTML = dojo.toJson(formObject2, true);
<p>The FORM</p>
<form id="myform2">
   <p><input type="text" data-dojo-type="dijit.form.TextBox" name="field1" value="value1"><br>
   <input type="text" data-dojo-type="dijit.form.TextBox" name="field2" value="value2"><br>
   <input id="mycheck" data-dojo-type="dijit.form.CheckBox" name="field3" value="agreed" checked> <label for="mycheck">I agree</label></p>
<p><button id="convertFormDigits" data-dojo-type="dijit.form.Button">Click to convert the form to an object</button></p>
<p>The form as an object:</p>
<pre id="formObject2"></pre>
Error in the documentation? Can’t find what you are looking for? Let us know!