Making a basic javascript API for the toolbar.

Author: tim-schilling

debug_toolbar/static/debug_toolbar/js/toolbar.js

@@ -1,4 +1,4 @@
-(function ($) {
+(function ($, publicAPI) {
     var djdt = {
         handleDragged: false,
         events: {
@@ -280,5 +280,11 @@
             }
         }
     };
+    $.extend(publicAPI, {
+        show_toolbar: djdt.show_toolbar,
+        hide_toolbar: djdt.hide_toolbar,
+        close: djdt.close,
+        cookie: djdt.cookie
+    });
     $(document).ready(djdt.init);
-})(djdt.jQuery);
+})(djdt.jQuery, djdt);

docs/panels.rst

@@ -240,8 +240,7 @@ according to the public API described below. Unless noted otherwise, all
 methods are optional.
 
 Panels can ship their own templates, static files and views. They're no public
-CSS or JavaScript API at this time, but they can assume jQuery is available in
-``djdt.jQuery``.
+CSS API at this time.
 
 .. autoclass:: debug_toolbar.panels.Panel(*args, **kwargs)
 
@@ -272,3 +271,49 @@ CSS or JavaScript API at this time, but they can assume jQuery is available in
     .. automethod:: debug_toolbar.panels.Panel.process_view
 
     .. automethod:: debug_toolbar.panels.Panel.process_response
+
+JavaScript API
+~~~~~~~~~~~~~~
+
+Panel templates should include any JavaScript files they need. There are a few
+common methods available, as well as the toolbar's version of jQuery.
+
+
+.. js:function:: djdt.close
+
+    Triggers the event to close any active panels.
+
+.. js:function:: djdt.cookie.get
+
+    This is a helper function to fetch values stored in the cookies.
+
+    :param string key: The key for the value to be fetched.
+
+.. js:function:: djdt.cookie.set
+
+    This is the toolbar's version of jQuery.
+
+    :param string key: The key to be used.
+
+    :param string value: The value to be set.
+
+    :param Object options: The key for the value to be fetched. It should contain
+    the properties ``expires`` and ``path``.
+
+.. js:function:: djdt.hide_toolbar
+
+    Closes any panels and hides the toolbar.
+
+    :param boolean setCookie: Whether or not it should set the display cookie for
+    the toolbar.
+
+.. js:function:: djdt.jQuery
+
+    This is the toolbar's version of jQuery.
+
+.. js:function:: djdt.show_toolbar
+
+    Shows the toolbar.
+
+    :param boolean animate: Whether or not it should use an animation when calling
+    ``show`` on the toolbar.