]> git.ipfire.org Git - thirdparty/bootstrap.git/commitdiff
Clarify valid values of Carousel's `pause` option
authorPvanhesteren <pavanhesteren@gmail.com>
Fri, 4 Mar 2016 21:30:06 +0000 (22:30 +0100)
committerChris Rebert <code@chrisrebert.com>
Sun, 17 Jul 2016 07:11:52 +0000 (00:11 -0700)
Fixes #18205
Closes #19410

[skip sauce]

docs/_includes/js/carousel.html

index 63cc9e5543c2ce68a0d6cd40a03e0417d266a057..0c3a0f4d070d1183b5508b6a72ec2f9b058e82d0 100644 (file)
@@ -178,9 +178,9 @@ $('.carousel').carousel()
        </tr>
        <tr>
          <td>pause</td>
-         <td>string</td>
+         <td>string | null</td>
          <td>"hover"</td>
-         <td>Pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave.</td>
+         <td>If set to <code>"hover"</code>, pauses the cycling of the carousel on <code>mouseenter</code> and resumes the cycling of the carousel on <code>mouseleave</code>. If set to <code>null</code>, hovering over the carousel won't pause it.</td>
        </tr>
        <tr>
          <td>wrap</td>