Skip to main content
OverlayAnimationOptions
Options for animating an overlay along an edge
NameTypeDescription
dwell?numberHow long, in milliseconds, to dwell on the source before beginning to move. Defaults to 350ms.
events?Record<string,(p:AnimationEventCallbackParams) => any>Optional set of event listeners.
forwards?booleanDefaults to true, meaning traverse from the source to the target.
loop?booleanIf true, the animation will loop.
paused?booleanIf true, the animation starts in a paused state.
rate?numberTime between frames. Defaults to 30ms.
speed?numberHow fast to travel, in pixels per second. Defaults to 100.