From dee57462e2805421a0fe0d786229446bbaef677b Mon Sep 17 00:00:00 2001 From: Jacob Thornton Date: Tue, 14 Aug 2012 21:06:08 -0700 Subject: get affix actually working and update docs --- docs/templates/pages/base-css.mustache | 2 +- docs/templates/pages/components.mustache | 2 +- docs/templates/pages/customize.mustache | 2 +- docs/templates/pages/extend.mustache | 2 +- docs/templates/pages/getting-started.mustache | 2 +- docs/templates/pages/javascript.mustache | 20 +++++++++----------- docs/templates/pages/scaffolding.mustache | 2 +- 7 files changed, 15 insertions(+), 17 deletions(-) (limited to 'docs/templates') diff --git a/docs/templates/pages/base-css.mustache b/docs/templates/pages/base-css.mustache index b0fe47c55..a65233160 100644 --- a/docs/templates/pages/base-css.mustache +++ b/docs/templates/pages/base-css.mustache @@ -14,7 +14,7 @@ ================================================== -->
-
    +
    • {{_i}}Typography{{/i}}
    • {{_i}}Code{{/i}}
    • {{_i}}Tables{{/i}}
      • 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 @@ ================================================== -->
      -
        +
        • {{_i}}Dropdowns{{/i}}
        • {{_i}}Button groups{{/i}}
        • {{_i}}Button dropdowns{{/i}}
          • diff --git a/docs/templates/pages/customize.mustache b/docs/templates/pages/customize.mustache index 53b1f98ea..31844bd45 100644 --- a/docs/templates/pages/customize.mustache +++ b/docs/templates/pages/customize.mustache @@ -14,7 +14,7 @@ ================================================== -->
          -
            +
            • {{_i}}1. Choose components{{/i}}
            • {{_i}}2. Select jQuery plugins{{/i}}
            • {{_i}}3. Customize variables{{/i}}
              • 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 @@ ================================================== -->
              -
                +
                • {{_i}}Built with LESS{{/i}}
                • {{_i}}Compiling Bootstrap{{/i}}
                • {{_i}}Use as static assets{{/i}}
                  • 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 @@ ================================================== -->
                  -
                    +
                    • {{_i}}Download{{/i}}
                    • {{_i}}File structure{{/i}}
                    • {{_i}}What's included{{/i}}
                      • diff --git a/docs/templates/pages/javascript.mustache b/docs/templates/pages/javascript.mustache index 296ccef81..1109dbaf1 100644 --- a/docs/templates/pages/javascript.mustache +++ b/docs/templates/pages/javascript.mustache @@ -13,7 +13,7 @@ ================================================== -->
                      -
                      -

                      {{_i}}Example{{/i}}

                      {{_i}}The subnavigation on the left is a live demo of the affix plugin.{{/i}}

                      @@ -1535,13 +1534,13 @@ $('.carousel').carousel({

                      {{_i}}Usage{{/i}}

                      {{_i}}Via data attributes{{/i}}

                      -

                      {{_i}}To easily add affix behavior to any element, just add data-spy="affix" to the element you want to spy on. When the affix offsets are satisified, an .affix class is added to the element. {{/i}}

                      +

                      {{_i}}To easily add affix behavior to any element, just add data-spy="affix" 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}}

                      - 
                      <div data-spy="affix">...</body>
                      + 
                      <div data-spy="affix" data-offset-top="200">...</body>
                      {{_i}}Heads up!{{/i}} - {{_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 affix, affix-top, and affix-bottom.{{/i}}

                      {{_i}}Via JavaScript{{/i}}

                      @@ -1549,16 +1548,15 @@ $('.carousel').carousel({ 
                      $('#navbar').affix()

                      {{_i}}Methods{{/i}}

                      -

                      .scrollspy('refresh')

                      -

                      {{_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}}

                      +

                      .affix('refresh')

                      +

                      {{_i}}When using affix in conjunction with adding or removing of elements from the DOM, you'll want to call the refresh method:{{/i}}

                       $('[data-spy="affix"]').each(function () {
   $(this).affix('refresh')
 });
                      -

                      {{_i}}Options{{/i}}

                      -

                      {{_i}}Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-offset-y="".{{/i}}

                      +

                      {{_i}}Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-offset-top="200".{{/i}}

                      @@ -1571,9 +1569,9 @@ $('[data-spy="affix"]').each(function () { - + - +
                      {{_i}}offset{{/i}}{{_i}}number | object{{/i}}{{_i}}number | function | object{{/i}} {{_i}}10{{/i}}{{_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 offset: { x: 10 }.{{/i}}{{_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 offset: { x: 10 }. Use a function when you need to dynamically provide an offset (useful for some responsive designs).{{/i}}
                      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 @@ ================================================== -->
                      -