UNPKG

@cerberus-design/react

Version:

The Cerberus Design React component library.

34 lines (33 loc) 1.11 kB
import { PropsWithChildren, ElementType } from 'react'; import { CarouselRootProps } from './primitives'; /** * This module contains an abstraction of the carousel family of components. * @module carousel */ export interface CarouselProps extends CarouselRootProps { /** * Whether to show the carousel indicators (dot list). * @default false */ showIndicators?: boolean; } /** * The Carousel component is an abstraction of the carousel family of * components. It provides a simple interface for creating carousels with * various configurations. * * @remarks * This component uses the `CarouselParts` object to provide the necessary * parts. For customization, we recommend using the `CarouselParts` object * directly in combination with the `css` prop. */ declare function CarouselEl(props: PropsWithChildren<CarouselProps>): import("react/jsx-runtime").JSX.Element; export declare const Carousel: { Root: typeof CarouselEl; ItemGroup: ElementType; Item: ElementType; Control: ElementType; PrevTrigger: ElementType; NextTrigger: ElementType; }; export {};