Skip to content
Snippets Groups Projects
Commit 1b375298 authored by Earl Miles's avatar Earl Miles
Browse files

Add a little more documentation to the ajax responder.

parent 9398d6a6
No related branches found
No related tags found
No related merge requests found
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
* a function in the Drupal.CTools.AJAX.Command space). The object can * a function in the Drupal.CTools.AJAX.Command space). The object can
* contain any other data that the command needs to process. * contain any other data that the command needs to process.
* *
* Built in commands: * Built in commands include:
* - replace * - replace
* - selector: The CSS selector. This can be any selector jquery uses in $(). * - selector: The CSS selector. This can be any selector jquery uses in $().
* - data: The data to use with the jquery replace() function. * - data: The data to use with the jquery replace() function.
...@@ -27,13 +27,23 @@ ...@@ -27,13 +27,23 @@
* - selector: The CSS selector. This can be any selector jquery uses in $(). * - selector: The CSS selector. This can be any selector jquery uses in $().
* - data: The data to use with the jquery append() function. * - data: The data to use with the jquery append() function.
* *
* - addClass * - changed
* - selector: The CSS selector. This can be any selector jquery uses in $(). * - selector: The CSS selector. This selector will have 'changed' added as a clas.
* - data: The class to add. * - star: If set, will add a star to this selector. It must be within the 'selector' above.
* *
* - alert * - alert
* - title: The title of the alert. * - title: The title of the alert.
* - data: The data in the alert. * - data: The data in the alert.
*
* Commands are usually created with a couple of helper functions, so they
* look like this:
*
* @code{
* $commands = array();
* $commands[] = ctools_ajax_command_replace('#ctools-object-1', 'some html here');
* $commands[] = ctools_ajax_command_add
* ctools_ajax_render($commands); // this function exits.
* }
*/ */
/** /**
......
// $Id $ // $Id$
/** /**
* @file * @file
* *
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment