diff options
| author | Kevin Kirsche <[email protected]> | 2015-02-09 10:45:22 -0500 |
|---|---|---|
| committer | Kevin Kirsche <[email protected]> | 2015-02-19 16:38:03 -0500 |
| commit | 744c3646f5ae667aadf15d39a465aae00e05ebec (patch) | |
| tree | c872d61b397e3a6be011f4d503cc6bccaf912819 /docs | |
| parent | 3efa9c46a40e49109e7a14d58ee7f8b170a3d17b (diff) | |
| download | bootstrap-744c3646f5ae667aadf15d39a465aae00e05ebec.tar.xz bootstrap-744c3646f5ae667aadf15d39a465aae00e05ebec.zip | |
[Fixes #15766] Need Clearer Affix plugin documentation
[Fixes #15766] Need Clearer Affix plugin documentation
Remove trailing whitespace
Update the documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/_includes/js/affix.html | 4 |
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> |