IGoToOptions
interface
Navigation & Scroll
Configuration object for the useGoTo() smooth-scroll service — controls container, duration, offset, easing and named easing patterns.
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.
- containerrequiredComponentPublicInstance | HTMLElement | string
- Scrollable container — a Vue component instance, a DOM element, or a CSS selector string. Defaults to window.
- durationrequirednumber
- Scroll animation duration in milliseconds.
- layoutrequiredboolean
- When true, the scroll target offset accounts for layout-registered sticky elements (appbar, footer).
- offsetrequirednumber
- Additional pixel offset applied on top of the target element position.
- easingrequiredstring | ((t: number) => number)
- Easing function — a named key from `patterns` or an inline timing function that maps progress t ∈ [0,1] to an output value.
- patternsrequiredIGoToOptionsPatterns
- Named easing function registry — a record of name → timing function used to resolve the `easing` string.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Smooth-scrolling to a target with custom options