IGoToInstance

interface
Navigation & Scroll

Internal service instance for useGoTo() — carries the reactive RTL flag and the resolved options used for smooth-scroll calculations.

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.

rtl
required
Ref<boolean>
Reactive right-to-left flag — when true, scroll direction is inverted for RTL layouts.
options
required
IGoToOptions
Resolved configuration object for the scroll animation (container, duration, offset, easing, patterns).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Shape of the internal instance injected by createGoTo()

typescript