aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris Rebert <[email protected]>2015-02-19 15:53:49 -0800
committerChris Rebert <[email protected]>2015-02-19 15:53:49 -0800
commit3748e44b2eba2e1a1e89bdd28f4461e1f718c5b4 (patch)
treed802ef17a785f3fd3cc2991ad046b15c0e43561d /docs
parent9677d6685a575e1c5a54d887df5974c342536abc (diff)
parent744c3646f5ae667aadf15d39a465aae00e05ebec (diff)
downloadbootstrap-3748e44b2eba2e1a1e89bdd28f4461e1f718c5b4.tar.xz
bootstrap-3748e44b2eba2e1a1e89bdd28f4461e1f718c5b4.zip
Merge pull request #15773 from kkirsche/patch-16
Fix #15766: Clarify Affix plugin docs
Diffstat (limited to 'docs')
-rw-r--r--docs/_includes/js/affix.html4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/_includes/js/affix.html b/docs/_includes/js/affix.html
index 86b9a98e8..da2fb4127 100644
--- a/docs/_includes/js/affix.html
+++ b/docs/_includes/js/affix.html
@@ -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>