(Quick Reference)
formRemote
Purpose
Creates a form tag that uses a remote uri to execute an ajax call serializing the form elements falling back to a normal form submit if javascript is not supported.
Examples
Example controller for an application called "shop":
class BookController {
def show = { [ book : Book.get( params['id'] ) ] }
def byAuthor = { [ books: Book.findByAuthor( params['author'], params ) ] }
}Example usages for above controller:
<g:formRemote name="myForm" on404="alert('not found!')" update="updateMe"
url="[ controller: 'book', action:'show' ]">
Book Id: <input name="id" type="text"></input>
</g:formRemote>
<div id="updateMe">this div is updated with the result of the show call</div><g:formRemote name="myForm" update="updateMe"
url="[ controller: 'book', action: 'byAuthor', params: [ sort: 'title', order: 'desc' ]]">
Author: <input name="author" type="text"></input>
</g:formRemote>
<div id="updateMe">this div is updated with the result of the byAuthor call</div>You can override both the form method and action to use when javascript is unavailable by providing
method and
action attributes. This example will submit the form to
/<context>/book/show using a GET if javascript is unavailable:
<g:formRemote name="myForm" update="updateMe" method="GET"
action="${createLink(controller: 'book', action: 'show')}"
url="[controller: 'book', action: 'show']">
Book Id: <input name="id" type="text" />
</g:formRemote><div id="updateMe"></div>Description
Attributes
name (required) - The name of the form. This attribute will be assigned to id attribute if not present, otherwise, the value of this attribute will be omittedurl (required) - The url to submit to as either a map (containing values for the controller, action, id, and params) or a URL stringid (optional) - The id of the form rendered to the output. If id is not set, the value of name will be assignedaction (optional) - The action to execute as a fallback, defaults to the url if non specifiedupdate (optional) - Either a map containing the elements to update for 'success' or 'failure' states, or a string with the element to update in which cause failure events would be ignoredbefore (optional) - The javascript function to call before the remote function callafter (optional) - The javascript function to call after the remote function callasynchronous (optional) - Whether to do the call asynchronously or not (defaults to true)method (optional) - The method to use the execute the call (defaults to "post")
Events
onSuccess (optional) - The javascript function to call if successfulonFailure (optional) - The javascript function to call if the call failedon_ERROR_CODE (optional) - The javascript function to call to handle specified error codes (eg on404="alert('not found!')")onUninitialized (optional) - The javascript function to call if the ajax engine failed to initialiseonLoading (optional) - The javascript function to call when the remote function is loading the responseonLoaded (optional) - The javascript function to call when the remote function completed loading the responseonComplete (optional) - The javascript function to call when the remote function is complete, including any updates
Source
