ENGLISH·COURSE API
    Preparing search index...

    Type Alias

    GuidePlayback

    What a guide needs to play itself.

    type GuidePlayback = {
        frameIndex: number;
        isPlaying: boolean;
        showNext: () => void;
        showPrevious: () => void;
        showFrame: (index: number) => void;
        swipeHandlers: HorizontalSwipeHandlers;
    }
    Index

    Properties

    frameIndex isPlaying showNext showPrevious showFrame swipeHandlers

    Properties

    frameIndex: number

    The frame to draw.

    isPlaying: boolean

    Whether the guide is advancing on its own. false under a reduced-motion preference, which is what stops a countdown being drawn for a timer that is not running.

    showNext: () => void

    Show the frame after this one, wrapping past the last.

    showPrevious: () => void

    Show the frame before this one, wrapping past the first.

    showFrame: (index: number) => void

    Show one frame by index, wrapping at both ends.

    swipeHandlers: HorizontalSwipeHandlers

    Spread onto the element a horizontal drag should move the guide by.

    Settings

    Member Visibility

    On This Page

    Properties