API Reference / @gtkx/animated / AnimationProps

Interface: AnimationProps<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:882

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

Extended by

• ControllerProps
• SpringProps

Type Parameters

T

T = any

Properties

cancel?

optional cancel?: MatchProp<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:899

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)

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:886

Configure the spring behavior for each key.

---

default?

optional default?: boolean | SpringProps<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:916

Override the default props with this update.

---

delay?

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

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:890

Milliseconds to wait before applying the other props.

---

immediate?

optional immediate?: MatchProp<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:894

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

---

pause?

optional pause?: MatchProp<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:904

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

---

reset?

optional reset?: MatchProp<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:908

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

---

reverse?

optional reverse?: boolean

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:912

Swap the to and from props.