---
category: Components
type: Data Display
title: Carousel
---

A carousel component. Scales with its container.

## When To Use

- When there is a group of content on the same level.
- When there is insufficient content space, it can be used to save space in the form of a revolving door.
- Commonly used for a group of pictures/cards.

## API

| Property             | Description                                         | Type     | Default                          |
|------------------|----------------------------------------------|----------|---------------------------------|
| effect           | Transition effect   | `scrollx` \| `fade` | `scrollx` |
| dots | Whether to show the dots at the bottom of the gallery                | boolean    | `true` |
| vertical | Whether to use a vertical display                               | boolean   | `false` |
| autoplay | Whether to scroll automatically                                 | boolean   | `false` |
| easing | Transition interpolation function name                            | string   | `linear` |
| beforeChange | Callback function called before the current index changes   | function(from, to) |
| afterChange  | Callback function called after the current index changes    | function(current)  |

For more info on the parameters, refer to the https://github.com/akiran/react-slick