IWindowProvide

interface
State & Interaction

Internal provide contract injected by <OrigamWindow> into its WindowItem children — exposes the active transition name, slide count, height, direction and root ref for coordinated animations.

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.

transition
required
ComputedRef<undefined | string>
Computed transition name currently in use, derived from the active slide direction and parent props.
transitionCount
required
Ref<number>
Running count of slide transitions; used to key animations and prevent stale transitions.
transitionHeight
required
Ref<undefined | string>
Height of the active slide (CSS string or undefined) used to animate the container height during transitions.
isReversed
required
Ref<boolean>
Whether the current navigation direction is reversed — drives the transition enter/leave direction on child items.
rootRef
required
Ref<HTMLElement | undefined>
Template ref to the Window root element; used by items to measure container dimensions.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Consuming the provided context in a custom WindowItem

typescript