GTKX

API Reference / @gtkx/animated / ControllerProps

Interface: ControllerProps<State, Item> ​

Props for Controller methods and constructor.

Extends ​

Type Parameters ​

State ​

State extends Lookup = Lookup

Item ​

Item = undefined

Properties ​

cancel? ​

optional cancel?: MatchProp<State>

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

Inherited from ​

AnimationProps.cancel

config? ​

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

Configure the spring behavior for each key.

Inherited from ​

AnimationProps.config

default? ​

optional default?: boolean | SpringProps<State>

Override the default props with this update.

Inherited from ​

AnimationProps.default

delay? ​

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

Milliseconds to wait before applying the other props.

Inherited from ​

AnimationProps.delay

from? ​

optional from?: Falsy | GoalValues<State>

immediate? ​

optional immediate?: MatchProp<State>

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

Inherited from ​

AnimationProps.immediate

loop? ​

optional loop?: LoopProp<ControllerUpdate<Lookup<any>, undefined>>

onChange? ​

optional onChange?: OnChange<SpringValue<State>, Controller<State>, Item> | { [P in string | number | symbol]?: OnChange<SpringValue<State[P]>, Controller<State>, Item> }

Called once per frame when animations are active

Also accepts an object for per-key events

onPause? ​

optional onPause?: OnPause<SpringValue<State>, Controller<State>, Item> | { [P in string | number | symbol]?: OnPause<SpringValue<State[P]>, Controller<State>, Item> }

onProps? ​

optional onProps?: OnProps<State> | { [P in string | number | symbol]?: OnProps<State[P]> }

Called after an animation is updated by new props. Useful for manipulation

Also accepts an object for per-key events

onResolve? ​

optional onResolve?: OnResolve<SpringValue<State>, Controller<State>, Item>

Called when the promise for this update is resolved.

onRest? ​

optional onRest?: OnRest<SpringValue<State>, Controller<State>, Item> | { [P in string | number | symbol]?: OnRest<SpringValue<State[P]>, Controller<State>, Item> }

Called when the # of animating values hits 0

Also accepts an object for per-key events

onResume? ​

optional onResume?: OnResume<SpringValue<State>, Controller<State>, Item> | { [P in string | number | symbol]?: OnResume<SpringValue<State[P]>, Controller<State>, Item> }

onStart? ​

optional onStart?: OnStart<SpringValue<State>, Controller<State>, Item> | { [P in string | number | symbol]?: OnStart<SpringValue<State[P]>, Controller<State>, Item> }

Called when the # of animating values exceeds 0

Also accepts an object for per-key events

pause? ​

optional pause?: MatchProp<State>

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

Inherited from ​

AnimationProps.pause

ref? ​

optional ref?: SpringRef<State>

reset? ​

optional reset?: MatchProp<State>

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

Inherited from ​

AnimationProps.reset

reverse? ​

optional reverse?: boolean

Swap the to and from props.

Inherited from ​

AnimationProps.reverse