2016-06-19 11:19:36 +08:00
|
|
|
---
|
|
|
|
|
category: Components
|
2016-11-09 14:43:32 +08:00
|
|
|
type: Data Display
|
2016-06-19 11:19:36 +08:00
|
|
|
title: Carousel
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
A carousel component. Scales with its container.
|
|
|
|
|
|
2016-09-10 13:43:30 +08:00
|
|
|
## When To Use
|
2016-06-19 11:19:36 +08:00
|
|
|
|
|
|
|
|
- When there is a group of content on the same level.
|
2017-09-16 11:27:46 +08:00
|
|
|
- When there is insufficient content space, it can be used to save space in the form of a revolving door.
|
2016-11-29 17:13:24 +08:00
|
|
|
- Commonly used for a group of pictures/cards.
|
2016-06-19 11:19:36 +08:00
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
|
|
|
|
|
| Property | Description | Type | Default |
|
|
|
|
|
|------------------|----------------------------------------------|----------|---------------------------------|
|
2017-09-16 11:27:46 +08:00
|
|
|
| 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` |
|
2017-09-28 14:26:01 +08:00
|
|
|
| beforeChange | Callback function called before the current index changes | function(from, to) | - |
|
|
|
|
|
| afterChange | Callback function called after the current index changes | function(current) | - |
|
2016-06-19 11:19:36 +08:00
|
|
|
|
2017-10-10 13:41:04 +08:00
|
|
|
## Methods
|
|
|
|
|
|
|
|
|
|
| Name | Description |
|
|
|
|
|
|------|-------------|
|
|
|
|
|
| next() | Change current slide to next slide |
|
|
|
|
|
| prev() | Change current slide to previous slide |
|
|
|
|
|
| goTo(slideNumber) | Change current slide to given slide number |
|
|
|
|
|
|
2016-06-19 11:19:36 +08:00
|
|
|
For more info on the parameters, refer to the https://github.com/akiran/react-slick
|
