From 744c3646f5ae667aadf15d39a465aae00e05ebec Mon Sep 17 00:00:00 2001 From: Kevin Kirsche Date: Mon, 9 Feb 2015 10:45:22 -0500 Subject: [PATCH] [Fixes #15766] Need Clearer Affix plugin documentation [Fixes #15766] Need Clearer Affix plugin documentation Remove trailing whitespace Update the documentation --- docs/_includes/js/affix.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_includes/js/affix.html b/docs/_includes/js/affix.html index 86b9a98e8c..da2fb4127b 100644 --- a/docs/_includes/js/affix.html +++ b/docs/_includes/js/affix.html @@ -2,7 +2,7 @@

Affix affix.js

Example

-

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

+

The affix plugin toggles position: fixed; on and off emulating the effect found with position: sticky;. The subnavigation on the right is a live demo of the affix plugin.

@@ -10,7 +10,7 @@

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.

+

The affix plugin toggles between three classes, each representing a particular state: .affix, .affix-top, and .affix-bottom. You must provide the styles, with the exception of position: fixed; on .affix, 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. -- 2.47.2