ant-design/components/carousel/index.en-US.md
Tom Xu d44f404eae
docs: sort api (#27251)
* chore: improve sort api table scripts

* sort api

* add ignore

* Revert "sort api"

This reverts commit 343505d5f09d69349ce1fbdaea2a9faa7e852207.

* sort api

* Update package.json

* sort api

* Delete sort-api.js

* sort api

* sort api

* sort api

* fix

* Update index.zh-CN.md

* fix input-number

* fix input-number

* sort func

* fix

* Method moved to the end

* carousel method
2020-10-21 10:33:43 +08:00

1.5 KiB

category type title cover
Components Data Display Carousel https://gw.alipayobjects.com/zos/antfincdn/%24C9tmj978R/Carousel.svg

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
autoplay Whether to scroll automatically boolean false
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, object for dotsClass and any others boolean | { className?: string } true
easing Transition interpolation function name string linear
effect Transition effect scrollx | fade scrollx
afterChange Callback function called after the current index changes function(current) -
beforeChange Callback function called before the current index changes function(from, to) -

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

Find more APIs in react-slick documentation.