retro-react/dist/cjs/components/marquee/Marquee.d.ts

A React component library for building retro-style websites

/// <reference types="react" />
import { ThemeUICSSObject } from 'theme-ui';
export declare type MarqueeSize = 'small' | 'medium' | 'large';
export interface MarqueeProps extends React.HTMLAttributes<HTMLDivElement> {
    /**
     * The size of the Marquee.
     *
     * @default 'medium'
     */
    size?: MarqueeSize;
    /**
     * The hex color of the Marquee.
     *
     * @default '#000000'
     */
    color?: string;
    /**
     * The speed of the Marquee.
     *
     * @default '10s'
     */
    speed?: string;
    /**
     * Amount of space between the two Marquee elements.
     *
     * @default '1rem'
     */
    gap?: string;
    /**
     * If true, the Marquee will pause on hover.
     *
     * @default false
     */
    pauseOnHover?: boolean;
    sx?: ThemeUICSSObject;
}
/**
 * Marquees are used to display scrolling text.
 * Used as a fun way to display information.
 *
 * @example
 * <Marquee size="large" color="#ffffff" speed="10s">
 * 	Hello World!
 * </Marquee>
 */
export declare const Marquee: import("react").ForwardRefExoticComponent<MarqueeProps & import("react").RefAttributes<HTMLDivElement>>;