0
0
mirror of https://github.com/twbs/bootstrap.git synced 2025-02-20 17:54:23 +01:00

Document Affix plugin's checkPosition method

Fixes #16361
Refs #16356
[skip sauce]
This commit is contained in:
Chris Rebert 2015-05-02 13:01:55 -07:00
parent 1c7e7fdbef
commit 85235c55ac
2 changed files with 14 additions and 0 deletions

View File

@ -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>

View File

@ -117,6 +117,7 @@
<li><a href="#affix-examples">Examples</a></li>
<li><a href="#affix-usage">Usage</a></li>
<li><a href="#affix-options">Options</a></li>
<li><a href="#affix-methods">Methods</a></li>
<li><a href="#affix-events">Events</a></li>
</ul>
</li>