Components
iOSAndroid
Installation
pnpm dlx @docyrus/cli add @docyrus/rn-carouselUsage
import { Carousel } from '@/components/docyrus-native/carousel';
<Carousel
data={[<Image source={img1} />, <Image source={img2} />, <Image source={img3} />]}
showDots
showArrows
/>API Reference
| Prop | Type | Default | Description |
|---|---|---|---|
data | ReactNode[] | — | Array of slide content (required) |
autoPlay | boolean | false | Enable auto-play |
autoPlayInterval | number | 3000 | Auto-play interval (ms) |
showDots | boolean | true | Show pagination dots |
showArrows | boolean | false | Show navigation arrows |
loop | boolean | false | Enable infinite loop |
onIndexChange | (index: number) => void | — | Slide change callback |
className | string | — | Additional CSS classes |
itemClassName | string | — | Slide item CSS classes |
dotClassName | string | — | Inactive dot CSS classes |
activeDotClassName | string | — | Active dot CSS classes |
Type Exports
| Type | Description |
|---|---|
CarouselProps | Props for Carousel component |