API Documentation / UseLinkOptions

Interface: UseLinkOptions<Name>

Options passed to useLink.

Type parameters

Name	Type
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.