English | 中文

A slideshow component for cycling through elements (image or text), just like a carousel. It supports the following features:

• horizontal/vertical two directions
• loop mode
• auto play mode
• center mode, item would be adjusted to the screen's center
• supports children that have lengths smaller than the container

⚠️ NOTE

1. When carousel is in horizontal mode, width and itemWidth must be set.
2. When carousel is in vertical mode, height and itemHeight must be set.
3. If the data source of carousel's children would change, you should set the data prop. Or the children of carousel would not be updated.
4. Following picture will help you understand some important required variables:

npm install @rn-components-kit/carousel --save

Preview	Code
	Demo1 Code
	Demo2 Code
	Demo3 Code
	Demo4 Code
	Demo5 Code
	Demo6 Code
	Demo7 Code

• style
• initialIndex
• draggable
• vertical
• width
• height
• itemWidth
• itemHeight
• gap
• loop
• cloneCount
• centerModeEnabled
• autoPlay
• autoPlayDelay
• showPagination
• paginationStyle
• dotStyle
• curDotStyle
• renderPagination
• onIndexChange
• scrollToPrev
• scrollToNext
• scrollToIndex

Allows you to customize style

Determines the position when carousel first show

Determines whether carousel can be dragged to slide to prev/next one

Determines whether caousel is in horizontal or vertical direction

The width of carousel (when carousel is in horizontal mode, it must be set)

The height of carousel (when carousel is in vertical mode, it must be set)

The width of each item in carousel (when carousel is in horizontal mode, it must be set)

The height of each item in carousel (when carousel is in vertical mode, it must be set)

When item's length is smaller than container, gap can be used to separate items

Determines whether carousel's loop mode is enabled

When loop mode is enabled, there will be cloneCount copied elements placed at both sides of items

When item's length is smaller than container, item would be adjusted to the center of carousel if centerModeEnabled is true. In this case, prev/current/next elements will be all in one screen

Determines whether auto play mode is enabled

When auto play mode is enabled, it determines how long it takes between two scrolling animations (ms)

Determines whether pagination module is shown in carousel

Allow you to customize pagination's container style

Allow you to customize pagination's dot style

Allow you to customize pagination's current dot style

(info: {curIndex: number, total: number}) => React.ReactElement | null

Allow you to customize pagination module

(from: number, to: number) => void

A callback will be triggered when carousel's scrollIndex changes

scrollToPrev();

Scrolls to prev item

scrollToNext();

Scrolls to next item

scrollToIndex([options]: {index: number, animated: boolean});

Scrolls to the item at the specified index