The API

Executed after a view has rendered, used to include bufferred code blocks.

Create a text field with Autocomplete.

Creates an autocomplete field with the given ID and options.

options['with'] defaults to "Form.Element.serialize('$field')", but can be any valid javascript expression defining the additional fields.

Return Javascript text for callbacks.

Return JavaScript text for an observer...

Returns a string of JavaScript with the given option data as a JavaScript options hash.

Creates an Ajax-updateable DIV element

Closes an Ajax-updateable DIV element

Creates a draggable element. For a reference on the options for this function, check out http://github.com/madrobby/scriptaculous/wikis/draggable

For a reference on the options for this function, check out http://github.com/madrobby/scriptaculous/wikis/droppables

Make an element with the given $id droppable, and trigger an Ajax call when a draggable is dropped on it.

For a reference on the options for this function, check out http://wiki.script.aculo.us/scriptaculous/show/Droppables.add

Makes an Ajax In Place editor control.

Returns form tag that will submit using Ajax.

Returns a form tag that will submit using XMLHttpRequest in the background instead of the regular reloading POST arrangement. Even though it's using Javascript to serialize the form elements, the form submission will work just like a regular submission as viewed by the receiving side (all elements available in params). The options for defining callbacks is the same as AjaxHelper::link().

Detects Ajax requests

Returns link to remote action

Returns a link to a remote action defined by <i>options[url]</i> (using the url() format) that's called in the background using XMLHttpRequest. The result of that request can then be inserted into a DOM object whose id can be specified with <i>options[update]</i>.

Examples: <code> link("Delete this post", array("update" => "posts", "url" => "delete/{$postid->id}")); link(imageTag("refresh"), array("update" => "emails", "url" => "list_emails" )); </code>

By default, these remote requests are processed asynchronous during which various callbacks can be triggered (for progress indicators and the likes).

Example: <code> link (word, array("url" => "undo", "n" => word_counter), array("complete" => "undoRequestCompleted(request)")); </code>

The callbacks that may be specified are:

• <i>loading</i>:: Called when the remote document is being loaded with data by the browser.
• <i>loaded</i>:: Called when the browser has finished loading the remote document.
• <i>interactive</i>:: Called when the user can interact with the remote document, even though it has not finished loading.
• <i>complete</i>:: Called when the XMLHttpRequest is complete.

If you for some reason or another need synchronous processing (that'll block the browser while the request is happening), you can specify <i>options[type] = synchronous</i>.

You can customize further browser side call logic by passing in Javascript code snippets via some optional parameters. In their order of use these are:

• <i>confirm</i>:: Adds confirmation dialog. -<i>condition</i>:: Perform remote request conditionally by this expression. Use this to describe browser-side conditions when request should not be initiated.
• <i>before</i>:: Called before request is initiated.
• <i>after</i>:: Called immediately after request was initiated and before <i>loading</i>.

Observe field and call ajax on change.

Observes the field with the DOM ID specified by <i>field</i> and makes an Ajax when its contents have changed.

Required +options+ are: - <i>frequency</i>:: The frequency (in seconds) at which changes to this field will be detected. - <i>url</i>:: @see url() -style options for the action to call when the field has changed.

Additional options are: - <i>update</i>:: Specifies the DOM ID of the element whose innerHTML should be updated with the XMLHttpRequest response text. - <i>with</i>:: A Javascript expression specifying the parameters for the XMLHttpRequest. This defaults to Form.Element.serialize('$field'), which can be accessed from params['form']['field_id'].

Additionally, you may specify any of the options documented in

Observe entire form and call ajax on change.

Like @see observeField(), but operates on an entire form identified by the DOM ID <b>form</b>. <b>options</b> are the same as <b>observeField</b>, except the default value of the <i>with</i> option evaluates to the serialized (request string) value of the form.

Creates JavaScript function for remote AJAX call

This function creates the javascript needed to make a remote call it is primarily used as a helper for AjaxHelper::link.

Periodically call remote url via AJAX.

Periodically calls the specified url (<i>options[url]</i>) every <i>options[frequency]</i> seconds (default is 10). Usually used to update a specified div (<i>options[update]</i>) with the results of the remote call. The options for specifying the target with url and defining callbacks is the same as AjaxHelper::link().

Makes a slider control.

Makes a list or group of floated objects sortable.

Returns a button input tag that will submit using Ajax

Returns a button input tag that will submit form using XMLHttpRequest in the background instead of regular reloading POST arrangement. <i>options</i> argument is the same as in AjaxHelper::form().