g3-toolkit API Reference
    Preparing search index...

    Interface UseOverlaySequenceOptions

    interface UseOverlaySequenceOptions {
        autoplay?: boolean;
        ids: readonly string[];
        loop?: boolean;
        mode?: OverlaySequenceMode;
        speedMs?: number;
    }
    Index

    Properties

    autoplay? ids loop? mode? speedMs?

    Properties

    autoplay?: boolean

    Start playing on mount. Default false.

    ids: readonly string[]

    Overlay ids in step order. The sequence owns these and nothing else. Compared by content, so a fresh array literal is fine.

    loop?: boolean

    Wrap at both ends (and keep playing past the last step). Default false: the sequence clamps, and playback pauses on the last step.

    mode?: OverlaySequenceMode

    "single" shows only step N's overlay; "cumulative" shows steps 0..N together. Default "single".

    speedMs?: number

    Interval between steps while playing, in ms. Default 1000.

    Settings

    Member Visibility

    On This Page

    Properties