Merge pull request #4804 from lkcampbell/fix-issue-4383

peterflynn · peterflynn · commit 7440fbd40628 · 2013-09-09T16:58:04.000-07:00
Fix for Issue #4383: Updated documentation on sidebar view events
diff --git a/src/project/SidebarView.js b/src/project/SidebarView.js
@@ -26,9 +26,17 @@
 /*global define, $, document, window, brackets  */
 
 /**
- * The view that controls the showing and hiding of the sidebar. Dispatches the following events:
- *    hide -- when the sidebar is hidden
- *    show -- when the sidebar is shown
+ * The view that controls the showing and hiding of the sidebar.
+ * 
+ * Although the sidebar view doesn't dispatch any events directly, it is a
+ * resizable element (../utils/Resizer.js), which means it can dispatch Resizer
+ * events.  For example, if you want to listen for the sidebar showing
+ * or hiding itself, set up listeners for the corresponding Resizer events,
+ * panelCollapsed and panelExpanded:
+ * 
+ *      $("#sidebar").on("panelCollapsed", ...);
+ *      $("#sidebar").on("panelExpanded", ...);
+ * 
  */
 
 define(function (require, exports, module) {
@@ -162,8 +170,8 @@ define(function (require, exports, module) {
     CommandManager.register(Strings.CMD_HIDE_SIDEBAR, Commands.VIEW_HIDE_SIDEBAR, toggle);
     
     // Define public API
-    exports.toggle  = toggle;
-    exports.show    = show;
-    exports.hide    = hide;
-    exports.isVisible = isVisible;
+    exports.toggle      = toggle;
+    exports.show        = show;
+    exports.hide        = hide;
+    exports.isVisible   = isVisible;
 });
