mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-12 15:19:58 +08:00
c93bd326f4
* docs(update): removed 3.x version description in 4.0-prepare ref #19815 * docs(update): update docs remove carousel/index.zh-CN.md empty version column * docs(update): update docs remove carousel/index.en-US.md empty version column
1.4 KiB
1.4 KiB
| category | type | title |
|---|---|---|
| Components | Data Display | 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 | Version |
|---|---|---|---|---|
| afterChange | Callback function called after the current index changes | function(current) | - | |
| autoplay | Whether to scroll automatically | boolean | false |
|
| beforeChange | Callback function called before the current index changes | function(from, to) | - | |
| dotPosition | The position of the dots, which can be one of top bottom left right |
string | bottom | |
| dots | Whether to show the dots at the bottom of the gallery | boolean | true |
|
| easing | Transition interpolation function name | string | linear |
|
| effect | Transition effect | scrollx | fade |
scrollx |
Methods
| Name | Description |
|---|---|
| goTo(slideNumber, dontAnimate) | Go to slide index, if dontAnimate=true, it happens without animation |
| next() | Change current slide to next slide |
| prev() | Change current slide to previous slide |
For more info on the parameters, refer to the https://github.com/akiran/react-slick