Skip to main content

OverlayAnimationOptions

Options for animating an overlay along an edge

Properties

dwell?

optional dwell: number

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


events?

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

Optional set of event listeners.


forwards?

optional forwards: boolean

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


loop?

optional loop: boolean

If true, the animation will loop.


paused?

optional paused: boolean

If true, the animation starts in a paused state.


rate?

optional rate: number

Time between frames. Defaults to 30ms.


speed?

optional speed: number

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