ant-design/components/carousel/index.en-US.md

1.3 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
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) -
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
vertical Whether to use a vertical display boolean false

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