From: Lonewolf <nikhilkalige@gmail.com>
Date: Mon, 7 Apr 2014 06:39:19 +0000 (+0530)
Subject: Updated docs for offcanvas with data-offcanvas
X-Git-Tag: v5.2.3~82^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F4913%2Fhead;p=thirdparty%2Ffoundation%2Ffoundation-sites.git

Updated docs for offcanvas with data-offcanvas
---

diff --git a/doc/includes/examples_javascript_data_options.html b/doc/includes/examples_javascript_data_options.html
index 853c1b3e1..14454fb25 100644
--- a/doc/includes/examples_javascript_data_options.html
+++ b/doc/includes/examples_javascript_data_options.html
@@ -147,6 +147,11 @@
       <td>throttle_delay</td>
       <td>50</td>
     </tr>
+    <tr>
+      <td rowspan="1">OffCanvas</td>
+      <td>close_on_click</td>
+      <td>true</td>
+    </tr>
     <tr>
       <td rowspan="29">Orbit</td>
       <td>animation</td>
diff --git a/doc/includes/off_canvas/examples_offcanvas_basic.html b/doc/includes/off_canvas/examples_offcanvas_basic.html
index 917654dc7..ab95c6a79 100644
--- a/doc/includes/off_canvas/examples_offcanvas_basic.html
+++ b/doc/includes/off_canvas/examples_offcanvas_basic.html
@@ -1,4 +1,4 @@
-<div class="off-canvas-wrap docs-wrap">
+<div class="off-canvas-wrap docs-wrap" data-offcanvas>
   <div class="inner-wrap">
     <nav class="tab-bar">
       <section class="left-small">
@@ -44,4 +44,4 @@
   <a class="exit-off-canvas"></a>
 
   </div>
-</div>
\ No newline at end of file
+</div>
diff --git a/doc/includes/off_canvas/examples_offcanvas_basic_markup.html b/doc/includes/off_canvas/examples_offcanvas_basic_markup.html
index 06187e7e2..f10952896 100644
--- a/doc/includes/off_canvas/examples_offcanvas_basic_markup.html
+++ b/doc/includes/off_canvas/examples_offcanvas_basic_markup.html
@@ -1,6 +1,6 @@
 {{#markdown}}
 ```html
-<div class="off-canvas-wrap">
+<div class="off-canvas-wrap" data-offcanvas>
   <div class="inner-wrap">
     <nav class="tab-bar">
 
@@ -33,4 +33,4 @@
   </div>
 </div>
 ```
-{{/markdown}}
\ No newline at end of file
+{{/markdown}}
diff --git a/doc/includes/off_canvas/examples_offcanvas_basic_rendered.html b/doc/includes/off_canvas/examples_offcanvas_basic_rendered.html
index 917654dc7..ab95c6a79 100644
--- a/doc/includes/off_canvas/examples_offcanvas_basic_rendered.html
+++ b/doc/includes/off_canvas/examples_offcanvas_basic_rendered.html
@@ -1,4 +1,4 @@
-<div class="off-canvas-wrap docs-wrap">
+<div class="off-canvas-wrap docs-wrap" data-offcanvas>
   <div class="inner-wrap">
     <nav class="tab-bar">
       <section class="left-small">
@@ -44,4 +44,4 @@
   <a class="exit-off-canvas"></a>
 
   </div>
-</div>
\ No newline at end of file
+</div>
diff --git a/doc/includes/off_canvas/examples_offcanvas_javascript_options.html b/doc/includes/off_canvas/examples_offcanvas_javascript_options.html
new file mode 100644
index 000000000..b54d5b5fe
--- /dev/null
+++ b/doc/includes/off_canvas/examples_offcanvas_javascript_options.html
@@ -0,0 +1,9 @@
+{{#markdown}}
+```javascript
+$(document).foundation({
+  offcanvas : {
+    close_on_click : true,
+  }
+});
+```
+{{/markdown}}
diff --git a/doc/includes/off_canvas/examples_offcanvas_minimal_markup.html b/doc/includes/off_canvas/examples_offcanvas_minimal_markup.html
index 48404e02c..ff2f0e3c8 100644
--- a/doc/includes/off_canvas/examples_offcanvas_minimal_markup.html
+++ b/doc/includes/off_canvas/examples_offcanvas_minimal_markup.html
@@ -1,9 +1,9 @@
 {{#markdown}}
 ```html
-<div class="off-canvas-wrap">
+<div class="off-canvas-wrap" data-offcanvas>
   <div class="inner-wrap">
-    
-    <a class="left-off-canvas-toggle" href="#" >Menu</a> 
+
+    <a class="left-off-canvas-toggle" href="#" >Menu</a>
 
     <!-- Off Canvas Menu -->
     <aside class="left-off-canvas-menu">
diff --git a/doc/includes/off_canvas/examples_offcanvas_minimal_rendered.html b/doc/includes/off_canvas/examples_offcanvas_minimal_rendered.html
index 614329727..99139c099 100644
--- a/doc/includes/off_canvas/examples_offcanvas_minimal_rendered.html
+++ b/doc/includes/off_canvas/examples_offcanvas_minimal_rendered.html
@@ -1,11 +1,11 @@
-<div class="off-canvas-wrap docs-wrap">
+<div class="off-canvas-wrap docs-wrap" data-offcanvas>
   <div class="inner-wrap">
-    
-    <a class="left-off-canvas-toggle" >Menu</a> 
+
+    <a class="left-off-canvas-toggle" >Menu</a>
 
     <!-- Off Canvas Menu -->
     <aside class="left-off-canvas-menu">
-    	
+
       <ul>
         <li><a href="#">Item 1</a></li>
         <li><a href="#">Item 2</a></li>
@@ -25,4 +25,4 @@
   <a class="exit-off-canvas"></a>
 
   </div>
-</div>
\ No newline at end of file
+</div>
diff --git a/doc/includes/off_canvas/examples_offcanvas_multiple_markup.html b/doc/includes/off_canvas/examples_offcanvas_multiple_markup.html
index b5d89967c..022782ab8 100644
--- a/doc/includes/off_canvas/examples_offcanvas_multiple_markup.html
+++ b/doc/includes/off_canvas/examples_offcanvas_multiple_markup.html
@@ -1,6 +1,6 @@
 {{#markdown}}
 ```html
-<div class="off-canvas-wrap">
+<div class="off-canvas-wrap" data-offcanvas>
   <div class="inner-wrap">
     <nav class="tab-bar">
       <section class="left-small">
diff --git a/doc/includes/off_canvas/examples_offcanvas_multiple_rendered.html b/doc/includes/off_canvas/examples_offcanvas_multiple_rendered.html
index d86316714..b5a874a1e 100644
--- a/doc/includes/off_canvas/examples_offcanvas_multiple_rendered.html
+++ b/doc/includes/off_canvas/examples_offcanvas_multiple_rendered.html
@@ -1,4 +1,4 @@
-<div class="off-canvas-wrap docs-wrap">
+<div class="off-canvas-wrap docs-wrap" data-offcanvas>
   <div class="inner-wrap">
     <nav class="tab-bar">
       <section class="left-small">
@@ -66,4 +66,4 @@
   <a class="exit-off-canvas"></a>
 
   </div>
-</div>
\ No newline at end of file
+</div>
diff --git a/doc/pages/components/offcanvas.html b/doc/pages/components/offcanvas.html
index 74bd52801..df5161371 100644
--- a/doc/pages/components/offcanvas.html
+++ b/doc/pages/components/offcanvas.html
@@ -35,7 +35,7 @@ This is the outer-most element. It contains the entire off-canvas layout and hid
 <h4>HTML</h4>
 
 ```html
-<div class="off-canvas-wrap"><!-- page layout goes here --></div>
+<div class="off-canvas-wrap" data-offcanvas><!-- page layout goes here --></div>
 ```
 
 ### Inner Wrap
@@ -45,7 +45,7 @@ This is the element that is animated. All of your page content needs to be insid
 <h4>HTML</h4>
 
 ```html
-<div class="off-canvas-wrap">
+<div class="off-canvas-wrap" data-offcanvas>
   <div class="inner-wrap"><!-- all content goes here --></div>
 </div>
 ```
@@ -297,6 +297,10 @@ Just add `foundation.offcanvas.js` AFTER the `foundation.js` file. Your markup s
 
 Required Foundation Library: `foundation.offcanvas.js`
 
+### Optional Javascript Configuration
+
+{{> examples_offcanvas_javascript_options}}
+
 ***
 
 ### Sass Errors?