]> git.ipfire.org Git - thirdparty/bootstrap.git/commitdiff
[Fixes #15766] Need Clearer Affix plugin documentation 15773/head
authorKevin Kirsche <Kev.Kirsche+GitHub@gmail.com>
Mon, 9 Feb 2015 15:45:22 +0000 (10:45 -0500)
committerKevin Kirsche <kkirsche@ansfederal.com>
Thu, 19 Feb 2015 21:38:03 +0000 (16:38 -0500)
[Fixes #15766] Need Clearer Affix plugin documentation

Remove trailing whitespace

Update the documentation

docs/_includes/js/affix.html

index 86b9a98e8cf968631c06b92f91d55a57ef909b10..da2fb4127b3ce4fdde36131fbad5f60b491f9a3a 100644 (file)
@@ -2,7 +2,7 @@
   <h1 id="affix" class="page-header">Affix <small>affix.js</small></h1>
 
   <h2 id="affix-examples">Example</h2>
-  <p>The subnavigation on the right is a live demo of the affix plugin.</p>
+  <p>The affix plugin toggles <code>position: fixed;</code> on and off emulating the effect found with <code>position: sticky;</code>. The subnavigation on the right is a live demo of the affix plugin.</p>
 
   <hr class="bs-docs-separator">
 
@@ -10,7 +10,7 @@
   <p>Use the affix plugin via data attributes or manually with your own JavaScript. <strong class="text-danger">In both situations, you must provide CSS for the positioning and width of your affixed content.</strong></p>
 
   <h3>Positioning via CSS</h3>
-  <p>The affix plugin toggles between three classes, each representing a particular state: <code>.affix</code>, <code>.affix-top</code>, and <code>.affix-bottom</code>. You must provide the styles for these classes yourself (independent of this plugin) to handle the actual positions.</p>
+  <p>The affix plugin toggles between three classes, each representing a particular state: <code>.affix</code>, <code>.affix-top</code>, and <code>.affix-bottom</code>. You must provide the styles, with the exception of <code>position: fixed;</code> on <code>.affix</code>, for these classes yourself (independent of this plugin) to handle the actual positions.</p>
   <p>Here's how the affix plugin works:</p>
   <ol>
     <li>To start, the plugin adds <code>.affix-top</code> to indicate the element is in its top-most position. At this point no CSS positioning is required.</li>