aboutsummaryrefslogtreecommitdiff
path: root/docs/components/carousel.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/components/carousel.md')
-rw-r--r--docs/components/carousel.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/components/carousel.md b/docs/components/carousel.md
index 79658eb6e..76278281e 100644
--- a/docs/components/carousel.md
+++ b/docs/components/carousel.md
@@ -4,7 +4,7 @@ title: Carousel
group: components
---
-A slideshow component for cycling through elements—images or slides of text—like a carousel. **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](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.**
## Contents
@@ -144,9 +144,9 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap
<thead>
<tr>
<th style="width: 100px;">Name</th>
- <th style="width: 50px;">type</th>
- <th style="width: 50px;">default</th>
- <th>description</th>
+ <th style="width: 50px;">Type</th>
+ <th style="width: 50px;">Default</th>
+ <th>Description</th>
</tr>
</thead>
<tbody>
@@ -180,7 +180,7 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap
### Methods
-#### .carousel(options)
+#### `.carousel(options)`
Initializes the carousel with an optional options `object` and starts cycling through items.
@@ -190,23 +190,23 @@ $('.carousel').carousel({
})
{% endhighlight %}
-#### .carousel('cycle')
+#### `.carousel('cycle')`
Cycles through the carousel items from left to right.
-#### .carousel('pause')
+#### `.carousel('pause')`
Stops the carousel from cycling through items.
-#### .carousel(number)
+#### `.carousel(number)`
Cycles the carousel to a particular frame (0 based, similar to an array).
-#### .carousel('prev')
+#### `.carousel('prev')`
Cycles to the previous item.
-#### .carousel('next')
+#### `.carousel('next')`
Cycles to the next item.