Skip to content

vue-router / UseLinkOptions

UseLinkOptions<Name> ​

Options passed to useLink.

Type Parameters ​

Name ​

Name extends keyof RouteMap = keyof RouteMap

Properties ​

replace? ​

ts
optional replace?: MaybeRef<boolean | undefined>;

to ​

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

viewTransition? ​

ts
optional viewTransition?: boolean;

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

Released under the MIT License.