From 7f56c4f28e0be130e4c8e6167b25bf5c6ca3d65f Mon Sep 17 00:00:00 2001
From: jlukic <jacklukic@gmail.com>
Date: Wed, 25 Sep 2013 12:56:34 -0400
Subject: [PATCH] adds settings/behavior docs for sidebar

Former-commit-id: 91d171f8818b78ac78fd30af5fe37074b11ed6fb
Former-commit-id: bdcef3d61d23dccd02eb76d3b14a8bfb79fa61ed
---
 node/src/documents/modules/sidebar.html.eco   | 144 +++++++++++++++++-
 .../src/documents/modules/transition.html.eco |   2 -
 .../src/files/release/less/modules/sidebar.js |  27 ++--
 3 files changed, 153 insertions(+), 20 deletions(-)
 mode change 100644 => 100755 node/src/files/release/less/modules/sidebar.js

diff --git a/node/src/documents/modules/sidebar.html.eco b/node/src/documents/modules/sidebar.html.eco
index 07c36a6db..f17aab277 100755
--- a/node/src/documents/modules/sidebar.html.eco
+++ b/node/src/documents/modules/sidebar.html.eco
@@ -213,29 +213,41 @@ type        : 'UI Module'
 
   <h2 class="ui dividing header">Behavior</h2>
 
-  All the following behaviors can be called using the syntax <code>$('.foo').sidebar('behavior name')</code>
+  All the following behaviors can be called using the syntax <code>$('.foo').sidebar('behavior name', argumentOne, argumentTwo)</code>
 
   <table class="ui definition celled table segment">
     <tr>
-      <td>attach events</td>
-      <td>Attaches sidebar action to given selector</td>
+      <td>attach events(selector, event)</td>
+      <td>Attaches sidebar action to given selector. Default event if none specified is toggle</td>
     </tr>
     <tr>
       <td>show</td>
-      <td>Shows specified selector</td>
+      <td>Shows sidebar</td>
     </tr>
     <tr>
       <td>hide</td>
-      <td>Hides specified selector</td>
+      <td>Hides sidebar</td>
     </tr>
     <tr>
       <td>toggle</td>
       <td>Toggles visibility of sidebar</td>
     </tr>
+    <tr>
+      <td>is open</td>
+      <td>Returns whether sidebar is open</td>
+    </tr>
+    <tr>
+      <td>is closed</td>
+      <td>Returns whether sidebar is closed</td>
+    </tr>
     <tr>
       <td>push page</td>
       <td>Pushes page content to be visible alongside sidebar</td>
     </tr>
+    <tr>
+      <td>get direction</td>
+      <td>Returns direction of current sidebar</td>
+    </tr>
     <tr>
       <td>pull page</td>
       <td>Returns page content to original position</td>
@@ -244,6 +256,128 @@ type        : 'UI Module'
       <td>add body css</td>
       <td>Adds stylesheet to page head to trigger sidebar animations</td>
     </tr>
+    <tr>
+      <td>remove body css</td>
+      <td>Removes any inline stylesheets for sidebar animation</td>
+    </tr>
+    <tr>
+      <td>get transition event</td>
+      <td>Returns vendor prefixed transition end event</td>
+    </tr>
+  </table>
+
+  <h2 class="ui dividing header">Settings</h2>
+
+  <h3 class="ui header">
+    Transition Settings
+    <div class="sub header">Form settings modify the transition behavior</div>
+  </h3>
+  <table class="ui red celled definition table segment">
+    <thead>
+      <th>Setting</th>
+      <th class="four wide">Default</th>
+      <th>Description</th>
+    </thead>
+    <tbody>
+      <tr>
+        <td>overlay</td>
+        <td>false</td>
+        <td>Whether sidebar should overlay page instead of pushing page to the side</td>
+      </tr>
+      <tr>
+        <td>useCSS</td>
+        <td>true</td>
+        <td>Whether to use css animations or fallback javascript animations</td>
+      </tr>
+      <tr>
+        <td>duration</td>
+        <td>300</td>
+        <td>Duration of side bar animation</td>
+      </tr>
+    </tbody>
+  </table>
+
+  <h3 class="ui header">
+    DOM Settings
+    <div class="sub header">DOM settings specify how this module should interface with the DOM</div>
+  </h3>
+  <table class="ui celled purple definition table segment">
+    <thead>
+      <th>Setting</th>
+      <th class="six wide">Default</th>
+      <th>Description</th>
+    </thead>
+    <tbody>
+      <tr>
+        <td>namespace</td>
+        <td>sidebar</td>
+        <td>Event namespace. Makes sure module teardown does not effect other events attached to an element.</td>
+      </tr>
+      <tr>
+        <td>className</td>
+        <td>
+          <div class="code">
+    className: {
+      active : 'active',
+      pushed : 'pushed',
+      top    : 'top',
+      left   : 'left',
+      right  : 'right',
+      bottom : 'bottom'
+    }
+          </div>
+        </td>
+        <td>Class names used to attach style to state</td>
+      </tr>
+    </tbody>
+  </table>
+
+  <div class="ui horizontal divider"><i class="icon setting"></i></div>
+
+  <h3 class="ui header">
+    Debug Settings
+    <div class="sub header">Debug settings controls debug output to the console</div>
+  </h3>
+
+  <table class="ui blue celled definition table segment">
+    <thead>
+      <th>Setting</th>
+      <th class="four wide">Default</th>
+      <th>Description</th>
+    </thead>
+    <tbody>
+      <tr>
+        <td>name</td>
+        <td>Sidebar</td>
+        <td>Name used in debug logs</td>
+      </tr>
+      <tr>
+        <td>debug</td>
+        <td>True</td>
+        <td>Provides standard debug output to console</td>
+      </tr>
+      <tr>
+        <td>performance</td>
+        <td>True</td>
+        <td>Provides standard debug output to console</td>
+      </tr>
+      <tr>
+        <td>verbose</td>
+        <td>True</td>
+        <td>Provides ancillary debug output to console</td>
+      </tr>
+      <tr>
+        <td>errors</td>
+        <td colspan="2">
+          <div class="code">
+    error   : {
+      method   : 'The method you called is not defined.',
+      notFound : 'There were no elements that matched the specified selector'
+    }
+          </div>
+        </td>
+      </tr>
+    </tbody>
   </table>
 
 </div>
diff --git a/node/src/documents/modules/transition.html.eco b/node/src/documents/modules/transition.html.eco
index 3ab8eb708..587e500ca 100755
--- a/node/src/documents/modules/transition.html.eco
+++ b/node/src/documents/modules/transition.html.eco
@@ -413,8 +413,6 @@ type        : 'UI Module'
           </tr>
         </tbody>
       </table>
-
-
     </div>
     <div class="five wide right floated fixed column">
       <img src="/images/demo/vector.png" class="ui dog image">
diff --git a/node/src/files/release/less/modules/sidebar.js b/node/src/files/release/less/modules/sidebar.js
old mode 100644
new mode 100755
index ac24c68f1..03ab0b451
--- a/node/src/files/release/less/modules/sidebar.js
+++ b/node/src/files/release/less/modules/sidebar.js
@@ -453,24 +453,25 @@ $.fn.sidebar = function(parameters) {
 
 $.fn.sidebar.settings = {
 
-  name   : 'Sidebar',
-  namespace    : 'sidebar',
+  name        : 'Sidebar',
+  namespace   : 'sidebar',
 
-  verbose      : true,
-  debug        : true,
-  performance  : true,
+  verbose     : true,
+  debug       : true,
+  performance : true,
 
-  useCSS       : true,
-  overlay      : false,
-  duration     : 300,
+  useCSS      : true,
+  overlay     : false,
+  duration    : 300,
 
-  side         : 'left',
+  side        : 'left',
 
-  onChange     : function(){},
-  onShow       : function(){},
-  onHide       : function(){},
+  /* callbacks not currently implemented */
+  onChange    : function(){},
+  onShow      : function(){},
+  onHide      : function(){},
 
-  className: {
+  className   : {
     active : 'active',
     pushed : 'pushed',
     top    : 'top',