retro-react
Version:
A React component library for building retro-style websites
40 lines (39 loc) • 1.31 kB
TypeScript
/** @jsxImportSource theme-ui */
import { ReactNode } from 'react';
import { ThemeUICSSObject } from 'theme-ui';
export interface CarouselProps extends React.HTMLAttributes<HTMLDivElement> {
/**
* The interval between slides, in milliseconds.
*
* @default 3000
*/
interval?: number;
/**
* The slides of the Carousel.
*
* @default []
*/
children: ReactNode[];
/**
* Hide the arrow buttons.
*
* @default false
*/
hideArrows?: boolean;
sx?: ThemeUICSSObject;
}
/**
* Carousel component with authentic WIN31 styling for displaying a slideshow of content.
* Features retro-styled navigation buttons and dot indicators reminiscent of early multimedia software.
*
* The component will automatically change the size depending on the content. To minimize layout shifts,
* it is recommended to set a fixed size for images that will work for all screen sizes.
*
* @example
* <Carousel interval={5000}>
* <img src="image1.jpg" alt="Slide 1" />
* <img src="image2.jpg" alt="Slide 2" />
* <img src="image3.jpg" alt="Slide 3" />
* </Carousel>
*/
export declare const Carousel: import("react").ForwardRefExoticComponent<CarouselProps & import("react").RefAttributes<HTMLDivElement>>;