API Documentation • Docs

---

API Documentation / UseLinkOptions

Interface: UseLinkOptions<Name>

Options passed to useLink.

Type Parameters

• Name extends keyof RouteMap = keyof RouteMap

Properties

replace?

optional replace: MaybeRef<undefined | boolean>

---

to

to: MaybeRef<string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric | RouteLocationAsRelativeTyped<RouteMapGeneric, Name>>

---

viewTransition?

optional viewTransition: boolean

Pass the returned promise of router.push() to document.startViewTransition() if supported.