GTKX

API Reference / @gtkx/animated / AnimationProps

Interface: AnimationProps<T> ​

Most of the reserved animation props, except to, from, loop, and the event props.

Extended by ​

Type Parameters ​

T ​

T = any

Properties ​

cancel? ​

optional cancel?: MatchProp<T>

Cancel all animations by using true, or some animations by using a key or an array of keys.

config? ​

optional config?: Partial<AnimationConfig> | ((key) => SpringConfig)

Configure the spring behavior for each key.

default? ​

optional default?: boolean | SpringProps<T>

Override the default props with this update.

delay? ​

optional delay?: number | ((key) => number)

Milliseconds to wait before applying the other props.

immediate? ​

optional immediate?: MatchProp<T>

When true, props jump to their goal values instead of animating.

pause? ​

optional pause?: MatchProp<T>

Pause all animations by using true, or some animations by using a key or an array of keys.

reset? ​

optional reset?: MatchProp<T>

Start the next animations at their values in the from prop.

reverse? ​

optional reverse?: boolean

Swap the to and from props.