@etsoo/website/lib/components/BSCarousel.d.ts

ETSOO CMS Based NextJs Website Framework

/// <reference types="react" />
/**
 * Bootstrap Carousel Item
 */
export type BSCarouselItem = {
    image: string;
    title?: string;
    content?: string;
} | {
    title: string;
    content?: string;
};
/**
 * Bootstrap Carousel Properties
 */
export type BSCarouselProps = {
    /**
     * Carousel ID, not required when only one instance
     */
    id?: string;
    /**
     * Carousel Items
     */
    items: BSCarouselItem[];
    /**
     * Carousel Interval, default is 5000
     */
    interval?: number;
    /**
     * Show Controls, default is true
     */
    controls?: boolean;
    /**
     * Show Indicators, default is true
     */
    indicators?: boolean;
    /**
     * Fade Effect, default is false
     */
    fade?: boolean;
    /**
     * Dark Theme, default is false
     */
    dark?: boolean;
    /**
     * Show Caption, default is true
     */
    caption?: boolean;
    /**
     * Caption Display Size
     */
    captionDisplay?: 'sm' | 'md' | 'lg' | 'xl';
};
/**
 * Bootstrap Carousel Component
 * @param props Properties
 * @returns Component
 */
export declare function BSCarousel(props: BSCarouselProps): JSX.Element;