Merge pull request #16409 from twbs/fix-16361

Document Affix plugin's `checkPosition` method

1 files changed, 13 insertions, 0 deletions

diff --git a/docs/_includes/js/affix.html b/docs/_includes/js/affix.html
index c94efc03f..bdd896b82 100644
--- a/docs/_includes/js/affix.html
+++ b/docs/_includes/js/affix.html
@@ -74,6 +74,19 @@ $('#myAffix').affix({
     </table>
   </div><!-- /.table-responsive -->
 
+  <h3 id="affix-methods">Methods</h3>
+
+  <h4><code>.affix(options)</code></h4>
+  <p>Activates your content as affixed content. Accepts an optional options <code>object</code>.</p>
+{% highlight js %}
+$('#myAffix').affix({
+  offset: 15
+})
+{% endhighlight %}
+
+  <h4><code>.affix('checkPosition')</code></h4>
+  <p>Recalculates the state of the affix based on the dimensions, position, and scroll position of the relevant elements. The <code>.affix</code>, <code>.affix-top</code>, and <code>.affix-bottom</code> classes are added to or removed from the affixed content according to the new state. This method needs to be called whenever the dimensions of the affixed content or the target element are changed, to ensure correct positioning of the affixed content.</p>
+  {% highlight js %}$('#myAffix').affix('checkPosition'){% endhighlight %}
 
   <h3 id="affix-events">Events</h3>
   <p>Bootstrap's affix plugin exposes a few events for hooking into affix functionality.</p>