API Documentation • Docs

---

API Documentation / UseLinkReturn

Interface: UseLinkReturn<Name>

Internal

Return type of useLink.

Type Parameters

• Name extends keyof RouteMap = keyof RouteMap

Properties

href

href: ComputedRef<string>

---

isActive

isActive: ComputedRef<boolean>

---

isExactActive

isExactActive: ComputedRef<boolean>

---

route

route: ComputedRef<RouteLocationResolvedGeneric>

Methods

navigate()

navigate(e?): Promise<void | NavigationFailure>

Parameters

• e?: MouseEvent

Returns

Promise<void | NavigationFailure>