IUseLink

interface
Navigation

Return type of the useLink composable — extends vue-router's useLink return (minus the raw href) with two additional computed flags: isLink and isClickable.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

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.

isLink
required
ComputedRef<boolean>
True when the component renders as an anchor (href or to prop is present).
isClickable
required
ComputedRef<boolean>
True when the component is interactive (isLink or a click handler is bound).
href
required
Ref<string | undefined>
Resolved href string — undefined when no navigation target is set.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Reading isLink to conditionally render an <a> or <button>

typescript