API Reference / @gtkx/animated / SpringToFn

Interface: SpringToFn()<T>

Defined in: node_modules/.pnpm/@react-spring+core@10.1.2_react@19.2.8/node_modules/@react-spring/core/dist/react-spring_core.modern.d.mts:586

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>

Defined in: node_modules/.pnpm/@react-spring+core@10.1.2_react@19.2.8/node_modules/@react-spring/core/dist/react-spring_core.modern.d.mts:587

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>