IParallaxProvide

interface
Motion & Parallax

Provide context exposed by OrigamParallax to its OrigamParallaxElement children via Vue inject. Carries reactive refs for audio data, pointer event position, movement state, easing and container shape.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

audioData
required
Ref<any>
Reactive audio analysis data (frequency/amplitude array) when the parallax is driven by audio input.
eventData
required
Ref<TPoint>
Reactive current pointer/mouse position as a normalised TPoint { x, y }.
movement
required
Ref<{ x: number, y: number, target?: IBox | DOMRect }>
Reactive current movement vector plus optional target bounding box. Consumed by OrigamParallaxElement to compute transforms.
isMoving
required
Ref<boolean>
True while a pointer/scroll movement is in progress.
event
required
Ref<TParallaxEvent>
The active event type (scroll | move | audio…) driving this parallax instance.
duration
required
Ref<number>
Transition duration (ms) shared with all children for interpolation.
easing
required
Ref<string>
CSS timing-function string shared with children for transition easing.
shape
required
Ref<IBox | null>
Bounding box of the host parallax container, updated on resize. Null before mount.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Injecting the parallax context in a child component

typescript