From 2e4bbb1cb6d8bed29816a3d82b2cd0c7a427112c Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sat, 12 Jul 2014 02:17:42 -0700 Subject: move over all js pages --- docs/_includes/js/affix.html | 115 ------------------------------------------- 1 file changed, 115 deletions(-) delete mode 100644 docs/_includes/js/affix.html (limited to 'docs/_includes/js/affix.html') diff --git a/docs/_includes/js/affix.html b/docs/_includes/js/affix.html deleted file mode 100644 index 4ce51cb34..000000000 --- a/docs/_includes/js/affix.html +++ /dev/null @@ -1,115 +0,0 @@ -
-

Affix affix.js

- -

Example

-

The subnavigation on the right is a live demo of the affix plugin.

- -
- -

Usage

-

Use the affix plugin via data attributes or manually with your own JavaScript. In both situations, you must provide CSS for the positioning and width of your affixed content.

- -

Positioning via CSS

-

The affix plugin toggles between three classes, each representing a particular state: .affix, .affix-top, and .affix-bottom. You must provide the styles for these classes yourself (independent of this plugin) to handle the actual positions.

-

Here's how the affix plugin works:

-
    -
  1. To start, the plugin adds .affix-top to indicate the element is in its top-most position. At this point no CSS positioning is required.
  2. -
  3. Scrolling past the element you want affixed should trigger the actual affixing. This is where .affix replaces .affix-top and sets position: fixed; (provided by Bootstrap's code CSS).
  4. -
  5. If a bottom offset is defined, scrolling past that should replace .affix with .affix-bottom. Since offsets are optional, setting one requires you to set the appropriate CSS. In this case, add position: absolute; when necessary. The plugin uses the data attribute or JavaScript option to determine where to position the element from there.
  6. -
-

Follow the above steps to set your CSS for either of the usage options below.

- -

Via data attributes

-

To easily add affix behavior to any element, just add data-spy="affix" to the element you want to spy on. Use offsets to define when to toggle the pinning of an element.

- -{% highlight html %} -
- ... -
-{% endhighlight %} - -

Via JavaScript

-

Call the affix plugin via JavaScript:

-{% highlight js %} - $('#my-affix').affix({ - offset: { - top: 100 - , bottom: function () { - return (this.bottom = $('.footer').outerHeight(true)) - } - } - }) -{% endhighlight %} - - -

Options

-

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

- -
- - - - - - - - - - - - - - - - - - - - - - - - -
Nametypedefaultdescription
offsetnumber | function | object10Pixels to offset from screen when calculating position of scroll. If a single number is provided, the offset will be applied in both top and bottom directions. To provide a unique, bottom and top offset just provide an object offset: { top: 10 } or offset: { top: 10, bottom: 5 }. Use a function when you need to dynamically calculate an offset.
targetselector | node | jQuery elementthe window objectSpecifies the target element of the affix.
-
- - -

Events

-

Bootstrap's affix class exposes a few events for hooking into affix functionality.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event TypeDescription
affix.bs.affixThis event fires immediately before the element has been affixed.
affixed.bs.affixThis event is fired after the element has been affixed.
affix-top.bs.affixThis event fires immediately before the element has been affixed-top.
affixed-top.bs.affixThis event is fired after the element has been affixed-top.
affix-bottom.bs.affixThis event fires immediately before the element has been affixed-bottom.
affixed-bottom.bs.affixThis event is fired after the element has been affixed-bottom.
-
-
-- cgit v1.2.3