aboutsummaryrefslogtreecommitdiff
path: root/docs/templates
diff options
context:
space:
mode:
authorMark Otto <[email protected]>2012-08-15 14:45:41 -0700
committerMark Otto <[email protected]>2012-08-15 14:45:41 -0700
commitfd509cb370867d6a2d2ad45d3bae88d4fecdd088 (patch)
treeeabc447b12d1cc05b5922db475d2b0b3e5071d04 /docs/templates
parentada5589184550ea87b37ae3cba9edfce57c04e99 (diff)
parent74bda55d4caa3fd68b5993e5301cf2cc03fb48e8 (diff)
downloadbootstrap-fd509cb370867d6a2d2ad45d3bae88d4fecdd088.tar.xz
bootstrap-fd509cb370867d6a2d2ad45d3bae88d4fecdd088.zip
Merge branch '2.1.0-wip' of github.com:twitter/bootstrap into 2.1.0-wip
Diffstat (limited to 'docs/templates')
-rw-r--r--docs/templates/pages/base-css.mustache2
-rw-r--r--docs/templates/pages/components.mustache2
-rw-r--r--docs/templates/pages/customize.mustache2
-rw-r--r--docs/templates/pages/extend.mustache2
-rw-r--r--docs/templates/pages/getting-started.mustache2
-rw-r--r--docs/templates/pages/javascript.mustache20
-rw-r--r--docs/templates/pages/scaffolding.mustache2
7 files changed, 15 insertions, 17 deletions
diff --git a/docs/templates/pages/base-css.mustache b/docs/templates/pages/base-css.mustache
index 9f96cc634..36f0d1ea5 100644
--- a/docs/templates/pages/base-css.mustache
+++ b/docs/templates/pages/base-css.mustache
@@ -14,7 +14,7 @@
================================================== -->
<div class="row">
<div class="span3 bs-docs-sidebar">
- <ul class="nav nav-list bs-docs-sidenav" data-spy="affix" data-offset-y="80">
+ <ul class="nav nav-list bs-docs-sidenav">
<li><a href="#typography"><i class="icon-chevron-right"></i> {{_i}}Typography{{/i}}</a></li>
<li><a href="#code"><i class="icon-chevron-right"></i> {{_i}}Code{{/i}}</a></li>
<li><a href="#tables"><i class="icon-chevron-right"></i> {{_i}}Tables{{/i}}</a></li>
diff --git a/docs/templates/pages/components.mustache b/docs/templates/pages/components.mustache
index 2f2f5a78a..fe9e9f464 100644
--- a/docs/templates/pages/components.mustache
+++ b/docs/templates/pages/components.mustache
@@ -14,7 +14,7 @@
================================================== -->
<div class="row">
<div class="span3 bs-docs-sidebar">
- <ul class="nav nav-list bs-docs-sidenav" data-spy="affix" data-offset-y="80">
+ <ul class="nav nav-list bs-docs-sidenav">
<li><a href="#dropdowns"><i class="icon-chevron-right"></i> {{_i}}Dropdowns{{/i}}</a></li>
<li><a href="#buttonGroups"><i class="icon-chevron-right"></i> {{_i}}Button groups{{/i}}</a></li>
<li><a href="#buttonDropdowns"><i class="icon-chevron-right"></i> {{_i}}Button dropdowns{{/i}}</a></li>
diff --git a/docs/templates/pages/customize.mustache b/docs/templates/pages/customize.mustache
index 0932fa71a..0e78f99fd 100644
--- a/docs/templates/pages/customize.mustache
+++ b/docs/templates/pages/customize.mustache
@@ -14,7 +14,7 @@
================================================== -->
<div class="row">
<div class="span3 bs-docs-sidebar">
- <ul class="nav nav-list bs-docs-sidenav" data-spy="affix" data-offset-y="80">
+ <ul class="nav nav-list bs-docs-sidenav">
<li><a href="#components"><i class="icon-chevron-right"></i> {{_i}}1. Choose components{{/i}}</a></li>
<li><a href="#plugins"><i class="icon-chevron-right"></i> {{_i}}2. Select jQuery plugins{{/i}}</a></li>
<li><a href="#variables"><i class="icon-chevron-right"></i> {{_i}}3. Customize variables{{/i}}</a></li>
diff --git a/docs/templates/pages/extend.mustache b/docs/templates/pages/extend.mustache
index f925e7b29..a4332e62e 100644
--- a/docs/templates/pages/extend.mustache
+++ b/docs/templates/pages/extend.mustache
@@ -13,7 +13,7 @@
================================================== -->
<div class="row">
<div class="span3 bs-docs-sidebar">
- <ul class="nav nav-list bs-docs-sidenav" data-spy="affix" data-offset-y="80">
+ <ul class="nav nav-list bs-docs-sidenav">
<li><a href="#built-with-less"><i class="icon-chevron-right"></i> {{_i}}Built with LESS{{/i}}</a></li>
<li><a href="#compiling"><i class="icon-chevron-right"></i> {{_i}}Compiling Bootstrap{{/i}}</a></li>
<li><a href="#static-assets"><i class="icon-chevron-right"></i> {{_i}}Use as static assets{{/i}}</a></li>
diff --git a/docs/templates/pages/getting-started.mustache b/docs/templates/pages/getting-started.mustache
index a298e719b..2b1b189ad 100644
--- a/docs/templates/pages/getting-started.mustache
+++ b/docs/templates/pages/getting-started.mustache
@@ -14,7 +14,7 @@
================================================== -->
<div class="row">
<div class="span3 bs-docs-sidebar">
- <ul class="nav nav-list bs-docs-sidenav" data-spy="affix" data-offset-y="80">
+ <ul class="nav nav-list bs-docs-sidenav" >
<li><a href="#download-bootstrap"><i class="icon-chevron-right"></i> {{_i}}Download{{/i}}</a></li>
<li><a href="#file-structure"><i class="icon-chevron-right"></i> {{_i}}File structure{{/i}}</a></li>
<li><a href="#contents"><i class="icon-chevron-right"></i> {{_i}}What's included{{/i}}</a></li>
diff --git a/docs/templates/pages/javascript.mustache b/docs/templates/pages/javascript.mustache
index d6d49a7ec..b62bbfc3c 100644
--- a/docs/templates/pages/javascript.mustache
+++ b/docs/templates/pages/javascript.mustache
@@ -13,7 +13,7 @@
================================================== -->
<div class="row">
<div class="span3 bs-docs-sidebar">
- <ul class="nav nav-list bs-docs-sidenav" data-spy="affix" data-offset-y="80">
+ <ul class="nav nav-list bs-docs-sidenav">
<li><a href="#overview"><i class="icon-chevron-right"></i> {{_i}}Overview{{/i}}</a></li>
<li><a href="#transitions"><i class="icon-chevron-right"></i> {{_i}}Transitions{{/i}}</a></li>
<li><a href="#modals"><i class="icon-chevron-right"></i> {{_i}}Modal{{/i}}</a></li>
@@ -1526,7 +1526,6 @@ $('.carousel').carousel({
<h1>{{_i}}Affix{{/i}} <small>bootstrap-affix.js</small></h1>
</div>
-
<h2>{{_i}}Example{{/i}}</h2>
<p>{{_i}}The subnavigation on the left is a live demo of the affix plugin.{{/i}}</p>
@@ -1535,13 +1534,13 @@ $('.carousel').carousel({
<h2>{{_i}}Usage{{/i}}</h2>
<h3>{{_i}}Via data attributes{{/i}}</h3>
- <p>{{_i}}To easily add affix behavior to any element, just add <code>data-spy="affix"</code> to the element you want to spy on. When the affix offsets are satisified, an <code>.affix</code> class is added to the element. {{/i}}</p>
+ <p>{{_i}}To easily add affix behavior to any element, just add <code>data-spy="affix"</code> to the element you want to spy on. Then use offsets to define when to toggle the pinning of an element on and off.{{/i}}</p>
- <pre class="prettyprint linenums">&lt;div data-spy="affix"&gt;...&lt;/body&gt;</pre>
+ <pre class="prettyprint linenums">&lt;div data-spy="affix" data-offset-top="200"&gt;...&lt;/body&gt;</pre>
<div class="alert alert-info">
<strong>{{_i}}Heads up!{{/i}}</strong>
- {{_i}}It's up to you to maintain the dimensions of an element when toggling between relative and fixed positions. To see how this is done, refer to this pages subnavigation.{{/i}}
+ {{_i}}It's up to you to manage the position of a pinned element. This is done by styling <code>affix</code>, <code>affix-top</code>, and <code>affix-bottom</code>.{{/i}}
</div>
<h3>{{_i}}Via JavaScript{{/i}}</h3>
@@ -1549,16 +1548,15 @@ $('.carousel').carousel({
<pre class="prettyprint linenums">$('#navbar').affix()</pre>
<h3>{{_i}}Methods{{/i}}</h3>
- <h4>.scrollspy('refresh')</h4>
- <p>{{_i}}When using affix in conjunction with adding or removing of elements from the DOM, you'll need to call the refresh method like so:{{/i}}</p>
+ <h4>.affix('refresh')</h4>
+ <p>{{_i}}When using affix in conjunction with adding or removing of elements from the DOM, you'll want to call the refresh method:{{/i}}</p>
<pre class="prettyprint linenums">
$('[data-spy="affix"]').each(function () {
$(this).affix('refresh')
});
</pre>
-
<h3>{{_i}}Options{{/i}}</h3>
- <p>{{_i}}Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-offset-y=""</code>.{{/i}}</p>
+ <p>{{_i}}Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-offset-top="200"</code>.{{/i}}</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
@@ -1571,9 +1569,9 @@ $('[data-spy="affix"]').each(function () {
<tbody>
<tr>
<td>{{_i}}offset{{/i}}</td>
- <td>{{_i}}number | object{{/i}}</td>
+ <td>{{_i}}number | function | object{{/i}}</td>
<td>{{_i}}10{{/i}}</td>
- <td>{{_i}}Pixels to offset from screen when calculating position of scroll. If a single number is provide, the offset will be applied in both top and left directions. To listen for a single direction, or multiple unique offsets, just provided an object <code>offset: { x: 10 }</code>.{{/i}}</td>
+ <td>{{_i}}Pixels to offset from screen when calculating position of scroll. If a single number is provide, the offset will be applied in both top and left directions. To listen for a single direction, or multiple unique offsets, just provided an object <code>offset: { x: 10 }</code>. Use a function when you need to dynamically provide an offset (useful for some responsive designs).{{/i}}</td>
</tr>
</tbody>
</table>
diff --git a/docs/templates/pages/scaffolding.mustache b/docs/templates/pages/scaffolding.mustache
index e5ec29817..b22b1b4e9 100644
--- a/docs/templates/pages/scaffolding.mustache
+++ b/docs/templates/pages/scaffolding.mustache
@@ -13,7 +13,7 @@
================================================== -->
<div class="row">
<div class="span3 bs-docs-sidebar">
- <ul class="nav nav-list bs-docs-sidenav" data-spy="affix" data-offset-y="80">
+ <ul class="nav nav-list bs-docs-sidenav">
<li><a href="#global"><i class="icon-chevron-right"></i> {{_i}}Global styles{{/i}}</a></li>
<li><a href="#gridSystem"><i class="icon-chevron-right"></i> {{_i}}Grid system{{/i}}</a></li>
<li><a href="#fluidGridSystem"><i class="icon-chevron-right"></i> {{_i}}Fluid grid system{{/i}}</a></li>