Carousel

A carousel component. Scales with its container.

Carousel

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.


Basic

Basic usage.

Position

There are 4 position options available.

Scroll automatically

Timing of scrolling to the next card/picture.

Fade in

Slides use fade for transition.

API

PropertyDescriptionTypeDefault
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

NameDescriptionVersion
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