ICarouselItemsProps
@spartanfx/react / index / ICarouselItemsProps
Interface: ICarouselItemsProps<T>
Props for items-driven mode where the carousel manages its own items.
Extends
ICarouselBaseProps
Type Parameters
T
T = unknown
The type of data in each carousel item
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
ariaLabel? | string | Accessible label for the carousel region. | ICarouselBaseProps.ariaLabel |
autoPlay? | boolean | IAutoPlayConfig | Auto-play configuration. Pass true for defaults or an object for custom config. | ICarouselBaseProps.autoPlay |
className? | string | Additional CSS class for the carousel container. | ICarouselBaseProps.className |
currentIndex? | number | Controlled current index. When provided, the carousel becomes controlled. | ICarouselBaseProps.currentIndex |
initialIndex? | number | Initial slide index to display. Default 0 | ICarouselBaseProps.initialIndex |
items | ICarouselItem<T>[] | Array of items to display in the carousel. | - |
keyboardNavigation? | boolean | Whether to enable keyboard navigation. Default true | ICarouselBaseProps.keyboardNavigation |
maxWidth? | string | number | Maximum width of the carousel container. Can be any valid CSS value (e.g., '800px', '100%', '50rem'). The carousel will be centered when maxWidth is set. | ICarouselBaseProps.maxWidth |
navigation? | INavigationConfig | Navigation configuration. | ICarouselBaseProps.navigation |
onIndexChange? | (index) => void | Callback fired when the active slide changes. | ICarouselBaseProps.onIndexChange |
renderItem | (item, index, isActive) => ReactNode | Render function for each item. | - |
style? | CSSProperties | Additional inline styles for the carousel container. | ICarouselBaseProps.style |
swipeThreshold? | number | Minimum swipe distance in pixels to trigger navigation. Default 50 | ICarouselBaseProps.swipeThreshold |
touchEnabled? | boolean | Whether to enable touch/swipe gestures. Default true | ICarouselBaseProps.touchEnabled |
transition? | ITransitionConfig | Transition animation configuration. | ICarouselBaseProps.transition |