Skip to content

Commit

Permalink
Properly document Modal#handleUpdate
Browse files Browse the repository at this point in the history
  • Loading branch information
hnrch02 committed Mar 3, 2015
1 parent c1005f5 commit be68cdd
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
8 changes: 5 additions & 3 deletions docs/_includes/js/modal.html
Original file line number Diff line number Diff line change
Expand Up @@ -394,9 +394,6 @@ <h4 class="modal-title" id="exampleModalLabel">New message</h4>
})
{% endhighlight %}

<h2 id="modals-handle-update">Modals with dynamic heights</h2>
<p>If the height of a modal changes while it is open, you should call <code>$('#myModal').data('bs.modal').handleUpdate()</code> to readjust the modal's position in case a scrollbar appears.</p>

<h2 id="modals-usage">Usage</h2>
<p>The modal plugin toggles your hidden content on demand, via data attributes or JavaScript. It also adds <code>.modal-open</code> to the <code>&lt;body&gt;</code> to override default scrolling behavior and generates a <code>.modal-backdrop</code> to provide a click area for dismissing shown modals when clicking outside the modal.</p>

Expand Down Expand Up @@ -479,6 +476,11 @@ <h4>.modal('hide')</h4>
<p>Manually hides a modal. <strong>Returns to the caller before the modal has actually been hidden</strong> (i.e. before the <code>hidden.bs.modal</code> event occurs).</p>
{% highlight js %}$('#myModal').modal('hide'){% endhighlight %}

<h4>.modal('handleUpdate')</h4>
<p>Readjusts the modal's positioning to counter a scrollbar in case one should appear, which would make the modal jump to the left.</p>
<p>Only needed when the height of the modal changes while it is open.</p>
{% highlight js %}$('#myModal').modal('handleUpdate'){% endhighlight %}

<h3 id="modals-events">Events</h3>
<p>Bootstrap's modal class exposes a few events for hooking into modal functionality.</p>
<p>All modal events are fired at the modal itself (i.e. at the <code>&lt;div class="modal"&gt;</code>).</p>
Expand Down
1 change: 0 additions & 1 deletion docs/_includes/nav/javascript.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
<li><a href="#modals-sizes">Sizes</a></li>
<li><a href="#modals-remove-animation">Remove animation</a></li>
<li><a href="#modals-related-target">Varying content based on trigger button</a></li>
<li><a href="#modals-handle-update">Modals with dynamic heights</a></li>
<li><a href="#modals-usage">Usage</a></li>
<li><a href="#modals-options">Options</a></li>
<li><a href="#modals-methods">Methods</a></li>
Expand Down

0 comments on commit be68cdd

Please sign in to comment.