Documentation
Orbit
< Menu

Carousel

### Description
The Carousel widget allows you to showcase a scrolling list of content items.

### Instance Options
| Option  | Property | Comments | Default Value |Source |
| ----- |:-----| ----| ---- | ---- |
| Content source|`source` | The content source from which to pull published content items. |`null` | Options Schema |
| Encoded query|`encoded_query` | The filter to be applied to the content source. | `null` |Options Schema |
| Limit| `limit` |The maximum number of content items to show. | `null` | Options Schema |
| Order by|`order_by` | The field used to order the items in the list. | `sys_updated_on`| Options Schema |
| Descending order|`order_desc` | Option to order items in descending (true) or ascending (false)order. | `True` | Options Schema |
| Interval|`interval` | The amount of time (in milliseconds) between scrolling. | `3000` |Options Schema |
| Enable pause|`enable_pause` | Enables users to pause the scrolling of the carousel. | `true`| Options Schema |
| Container class|`container_class` | Enables you to add a bootstrap column class for the carousel object. | `null` | Options Schema |

### CSS/SASS Variables
*Dependencies are included and configured as part of the provided Update Set.*
| Variable | Comments|
| -------- |:---|
|`$orbit-carousel-height` | Controls the height of the carousel, especially important for images. |
|`$orbit-carousel-bg` | Controls the background color. | |
|`$orbit-carousel-color` | Controls the color of the font. | |
|`$orbit-carousel-padding` | Controls the padding around the edges of the carousel. | |
|`$orbit-carousel-control-color` | Controls the color of the carousel controls (e.g., the pause button). | |

### Templates
| Name | Comments |
| -------- |:---|
|`carousel-simple.html` | Display the default carousel template. |
|`carousel-image-left.html` | Places an image on the left side of the carousel. |

Enter your email address for news and updates from NewRocket.

Thanks for your email!
There was an error, please try submitting again.