[Jifty-commit] r6579 - jifty/trunk/share/web/static/js

[Jifty commits]

Author: c9s
Date: Fri Mar 13 12:09:00 2009
New Revision: 6579

Modified:
   jifty/trunk/share/web/static/js/jifty.js

Log:
 - add comments to Jifty.Update.response_hooks


Modified: jifty/trunk/share/web/static/js/jifty.js
==============================================================================
--- jifty/trunk/share/web/static/js/jifty.js	(original)
+++ jifty/trunk/share/web/static/js/jifty.js	Fri Mar 13 12:09:00 2009
@@ -1,6 +1,20 @@
 /* An empty class so we can create things inside it */
 var Jifty = {};
 
+// to add a response_hook
+// the handler will get two arguments:
+//
+// response_fragment:
+//     - response xml dom object
+//
+// f:
+//     - 'region' is the name of the region to update
+//     - 'args' is a hash of arguments to override
+//     - 'path' is the path of the fragment (if this is a new fragment)
+//     - 'element' is the CSS selector of the element to update, if 'region' isn't supplied
+//     - 'mode' is one of 'Replace', 'Top', 'Bottom', 'Before', or 'After'
+//     - 'effect' is the name of an effect
+//
 Jifty.Update = {
     response_hooks: [],
     handler_hooks: [],