[Fixes #15766] Need Clearer Affix plugin documentation #15773
Conversation
| @@ -10,7 +10,7 @@ <h2 id="affix-usage">Usage</h2> | |||
| <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> | |||
There was a problem hiding this comment.
Done. Just waiting on sending the commit till we can work out some of the verbiage so that these commits don't get hidden.
|
What are your thoughts then about: The affix plugin allows you to easily create a backwards-compatible relative positioned element until it crosses a specified threshold, at which point it is treated as fixed positioned. Thoughts? |
|
The "backwards-compatible" part seems like a non-sequitur. |
|
My logic behind that was that you had said that today the same thing can be accomplished with I can certainly make it "The affix plugin allows you to easily create a relative positioned element until it crosses a specified threshold, at which point it is treated as fixed positioned." though if you prefer |
[Fixes twbs#15766] Need Clearer Affix plugin documentation Remove trailing whitespace Update the documentation
|
Changed the verbiage and removed the trailing space. What do you think of it now @cvrebert? |
|
LGTM. Thanks. |
Fix #15766: Clarify Affix plugin docs
[Fixes #15766] Need Clearer Affix plugin documentation