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.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- audioDatarequiredRef<any>
- Reactive audio analysis data (frequency/amplitude array) when the parallax is driven by audio input.
- eventDatarequiredRef<TPoint>
- Reactive current pointer/mouse position as a normalised TPoint { x, y }.
- movementrequiredRef<{ x: number, y: number, target?: IBox | DOMRect }>
- Reactive current movement vector plus optional target bounding box. Consumed by OrigamParallaxElement to compute transforms.
- isMovingrequiredRef<boolean>
- True while a pointer/scroll movement is in progress.
- eventrequiredRef<TParallaxEvent>
- The active event type (scroll | move | audio…) driving this parallax instance.
- durationrequiredRef<number>
- Transition duration (ms) shared with all children for interpolation.
- easingrequiredRef<string>
- CSS timing-function string shared with children for transition easing.
- shaperequiredRef<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