API Reference / @gtkx/animated / FrameValue

Abstract Class: FrameValue<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:46

A kind of FluidValue that manages an AnimatedValue node.

Its underlying value can be accessed and even observed.

Extends

• FluidValue<T, Event<T>>

Extended by

• Interpolation
• SpringValue

Type Parameters

T

T = any

Constructors

Constructor

new FrameValue<T>(get?): FrameValue<T>

Defined in: node_modules/.pnpm/@react-spring+shared@10.1.2_react@19.2.8/node_modules/@react-spring/shared/dist/react-spring_shared.modern.d.mts:62

Parameters

get?

() => T

Returns

FrameValue<T>

Inherited from

FluidValue<T, FrameValue.Event<T>>.constructor

Properties

_priority

protected _priority: 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:50

---

id

readonly id: 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:47

---

key?

abstract optional key?: string

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

Accessors

idle

Get Signature

get abstract idle(): 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:49

Returns

boolean

---

priority

Get Signature

get priority(): 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:51

Returns

number

Set Signature

set priority(priority): void

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

Parameters

priority

number

Returns

void

Methods

_attach()

protected _attach(): void

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

Called when the first child is added.

Returns

void

---

_detach()

protected _detach(): void

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

Called when the last child is removed.

Returns

void

---

_onChange()

protected _onChange(value, idle?): void

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

Tell our children about our new value

Parameters

value

T

idle?

boolean

Returns

void

---

_onPriorityChange()

protected _onPriorityChange(priority): void

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

Tell our children about our new priority

Parameters

priority

number

Returns

void

---

advance()

abstract advance(dt): void

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

Internal

Parameters

dt

number

Returns

void

---

eventObserved()

abstract eventObserved(_event): void

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

Internal

Parameters

_event

Event

Returns

void

---

get()

get(): 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:54

Get the current value

Returns

T

Overrides

FluidValue.get

---

interpolate()

interpolate<Out>(...args): Interpolation<T, Out>

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

Type Parameters

Out

Out

Parameters

args

...InterpolatorArgs<T, Out>

Returns

Interpolation<T, Out>

Deprecated

Use the to method instead.

---

observerAdded()

protected observerAdded(count): void

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

Called after an observer is added.

Parameters

count

number

Returns

void

Overrides

FluidValue.observerAdded

---

observerRemoved()

protected observerRemoved(count): void

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

Called after an observer is removed.

Parameters

count

number

Returns

void

Overrides

FluidValue.observerRemoved

---

to()

to<Out>(...args): Interpolation<T, Out>

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

Create a spring that maps our value to another value

Type Parameters

Out

Out

Parameters

args

...InterpolatorArgs<T, Out>

Returns

Interpolation<T, Out>

---

toJSON()

toJSON(): 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:59

Returns

T