g3-toolkit API Reference
    Preparing search index...

    Interface OverlayTransportProps

    interface OverlayTransportProps {
        ariaLabel?: string;
        className?: string;
        labels?: Partial<OverlayTransportLabels>;
        loop?: boolean;
        onLoopChange?: (loop: boolean) => void;
        onSpeedChange?: (speedMs: number) => void;
        sequence: OverlaySequence;
        showLoop?: boolean;
        showNext?: boolean;
        showPlayPause?: boolean;
        showPrev?: boolean;
        showReadout?: boolean;
        showSpeed?: boolean;
        speedMs?: number;
        speedOptions?: readonly number[];
        style?: CSSProperties;
    }
    Index

    Properties

    ariaLabel? className? labels? loop? onLoopChange? onSpeedChange? sequence showLoop? showNext? showPlayPause? showPrev? showReadout? showSpeed? speedMs? speedOptions? style?

    Properties

    ariaLabel?: string

    Accessible name of the whole group. Default "Overlay sequence".

    className?: string
    labels?: Partial<OverlayTransportLabels>

    Override any accessible label or the readout text.

    loop?: boolean

    Current loop flag. The loop toggle renders only when BOTH this and onLoopChange are provided (and showLoop is not false).

    onLoopChange?: (loop: boolean) => void
    onSpeedChange?: (speedMs: number) => void
    sequence: OverlaySequence

    The result of useOverlaySequence, or any object of that shape.

    showLoop?: boolean
    showNext?: boolean
    showPlayPause?: boolean
    showPrev?: boolean
    showReadout?: boolean
    showSpeed?: boolean
    speedMs?: number

    Current interval. The speed control renders only when BOTH this and onSpeedChange are provided (and showSpeed is not false).

    speedOptions?: readonly number[]

    Interval choices for the speed control. Default DEFAULT_SPEED_OPTIONS; the current speedMs is always offered.

    style?: CSSProperties

    Settings

    Member Visibility

    On This Page

    Properties