diff options
Diffstat (limited to 'docs/components/carousel.md')
| -rw-r--r-- | docs/components/carousel.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/components/carousel.md b/docs/components/carousel.md index 76278281e..64b012b0e 100644 --- a/docs/components/carousel.md +++ b/docs/components/carousel.md @@ -1,10 +1,11 @@ --- layout: docs title: Carousel +description: A slideshow component for cycling through elements—images or slides of text—like a carousel. group: components --- -A slideshow component for cycling through elements—images or slides of text—like a carousel. In browsers where the [Page Visibility API](http://www.w3.org/TR/page-visibility/) is supported, the carousel will avoid sliding when the webpage is not visible to the user (such as when the browser tab is inactive, the browser window is minimized, etc.). **Nested carousels are not supported.** +A slideshow component for cycling through elements—images or slides of text—like a carousel. In browsers where the [Page Visibility API](https://www.w3.org/TR/page-visibility/) is supported, the carousel will avoid sliding when the webpage is not visible to the user (such as when the browser tab is inactive, the browser window is minimized, etc.). **Nested carousels are not supported.** ## Contents @@ -158,9 +159,9 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap </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> |