Skip to content

API Reference / @gtkx/animated / SpringToFn

Interface: SpringToFn()<T> ​

An async function that can update or stop the animations of a spring. Typically defined as the to prop.

The T parameter can be a set of animated values (as an object type) or a primitive type for a single animated value.

Type Parameters ​

T ​

T = any

SpringToFn(start, stop): void | Promise<any>

An async function that can update or stop the animations of a spring. Typically defined as the to prop.

The T parameter can be a set of animated values (as an object type) or a primitive type for a single animated value.

Parameters ​

start ​

StartFn<T>

stop ​

StopFn<T>

Returns ​

void | Promise<any>