Interface OverlayAnimationOptions

Options for animating an overlay along an edge

interface OverlayAnimationOptions {
    dwell?: number;
    events?: Record<string, ((p) => any)>;
    forwards?: boolean;
    paused?: boolean;
    rate?: number;
    speed?: number;


dwell?: number

How long, in milliseconds, to dwell on the source before beginning to move. Defaults to 350ms.

events?: Record<string, ((p) => any)>

Optional set of event listeners.

Type declaration

forwards?: boolean

Defaults to true, meaning traverse from the source to the target.

paused?: boolean

If true, the animation starts in a paused state.

rate?: number

Time between frames. Defaults to 30ms.

speed?: number

How fast to travel, in pixels per second. Defaults to 100.