Document .direction & .relatedTarget properties of Carousel events.

Fixes #13395
twbs · Apr 21, 2014 · 10cd0ff · 10cd0ff
1 parent cf18b06
commit 10cd0ff
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/_includes/js/carousel.html b/docs/_includes/js/carousel.html
@@ -203,6 +203,11 @@ <h4>.carousel('next')</h4>
 
   <h3>Events</h3>
   <p>Bootstrap's carousel class exposes two events for hooking into carousel functionality.</p>
+  <p>Both events have the following additional properties:</p>
+  <ul>
+    <li><code>direction</code>: The direction in which the carousel is sliding (either <code>"left"</code> or <code>"right"</code>).</li>
+    <li><code>relatedTarget</code>: The DOM element that is being slid into place as the active item.</li>
+  </ul>
   <div class="table-responsive">
     <table class="table table-bordered table-striped">
       <thead>