ILink
interface
Navigation
Internal return type of useLink — wraps vue-router's useLink return value with Origam-specific computed flags and a resolved href ref.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- tagrequiredComputedRef<string>
- The HTML tag or component to render — "a" when a href/to is provided, "button" otherwise.
- isLinkrequiredComputedRef<boolean>
- True when the component resolves to an anchor (href or to is set).
- isClickablerequiredComputedRef<boolean>
- True when the element is interactive (isLink or an onClick handler is present).
- hrefrequiredRef<string | undefined>
- Resolved href string — replaces the vue-router version to provide a consistent Ref shape.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Consuming ILink from useLink