Using Ajax Forms

To create a form object that uses AJAX, we do this:

from deform import Form
myform = Form(schema, buttons=('submit',), use_ajax=True)

Creating a Form Object indicates how to create a Form object based on a schema and some buttons. Creating an AJAX form uses the same constructor as creating a non-AJAX form: the only difference between the example provided in the Creating a Form Object section and the example above of creating an AJAX form is the additional use_ajax=True argument passed to the Form constructor.

If use_ajax is passed as True to the constructor of a deform.Form object, the form page is rendered in such a way that when a submit button is pressed, the page is not reloaded. Instead, the form is posted, and the result of the post replaces the form element’s DOM node.

Examples of using the AJAX facilities in Deform are showcased on the http://deform2demo.repoze.org demonstration website:

• Redirection on validation success
• No redirection on validation success

Note that for AJAX forms to work, the deform.js and jquery.form.js libraries must be included in the rendering of the page that includes the form itself, and the deform.load() JavaScript function must be called by the rendering in order to associate the form with AJAX. This is the responsibility of the wrapping page. Both libraries are present in the static directory of the deform package itself. See Widget Requirements and Resources for a way to detect which JavaScript libraries are required for a particular form rendering.