ant-design/components/carousel/index.en-US.md
Wei Zhu 77b78a9389 docs: Unify type naming (#4636)
* Unify name of ReactNode type in document

* Lowser all string type name

* Lowercase all number type name

* Lowercase all boolean type name

* Unify array type

* Lowercase all object type name

* Unify mutilple types
2017-01-20 20:10:50 +08:00

1.5 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 resolving door.
  • Commonly used for a group of pictures/cards.

API

Property Description Type Default
effect Animation effect, either scrollx or fade string 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 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