]> git.ipfire.org Git - thirdparty/bootstrap.git/commitdiff
Properly document Modal#handleUpdate 15984/head
authorHeinrich Fenkart <hnrch02@gmail.com>
Tue, 3 Mar 2015 05:45:38 +0000 (06:45 +0100)
committerHeinrich Fenkart <hnrch02@gmail.com>
Tue, 3 Mar 2015 05:45:38 +0000 (06:45 +0100)
docs/_includes/js/modal.html
docs/_includes/nav/javascript.html

index 0e2de1d61b68d05838f40eb259e0d6b16dd99d96..2e32331431793504c3e7c62ff941feeb8a7c2b8f 100644 (file)
@@ -394,9 +394,6 @@ $('#exampleModal').on('show.bs.modal', function (event) {
 })
 {% 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>
 
@@ -479,6 +476,11 @@ $('#myModal').modal({
   <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>
index 8e8b830e14c2b6d6869291d30a6a122fd31670c1..eba53771b0e91d1ab3af2ea02703fa0ea93a9ba7 100644 (file)
@@ -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>