@szum-tech/design-system/dist/components/marquee/index.d.ts

Szum-Tech design system with tailwindcss support

import * as React from 'react';

type MarqueeProps = React.ComponentPropsWithoutRef<"div"> & {
    /**
     * Optional CSS class name to apply custom styles
     */
    className?: string;
    /**
     * Whether to reverse the animation direction
     * @default false
     */
    reverse?: boolean;
    /**
     * Whether to pause the animation on hover
     * @default false
     */
    pauseOnHover?: boolean;
    /**
     * Content to be displayed in the marquee
     */
    children: React.ReactNode;
    /**
     * Whether to animate vertically instead of horizontally
     * @default false
     */
    vertical?: boolean;
    /**
     * Number of times to repeat the content
     * @default 4
     */
    repeat?: number;
    /**
     * ARIA label for accessibility
     */
    ariaLabel?: string;
    /**
     * ARIA live region politeness
     */
    ariaLive?: "off" | "polite" | "assertive";
    /**
     * ARIA role
     */
    ariaRole?: string;
};
declare function Marquee({ className, reverse, pauseOnHover, children, vertical, repeat, ariaLabel, ariaLive, ariaRole, ...props }: MarqueeProps): React.JSX.Element;

export { Marquee, type MarqueeProps };