Types: UseLink
ts
type UseLink = object;Properties
| Property | Type | Description |
|---|---|---|
element | Ref<HTMLElement | undefined> | A template ref to bind to the dom for automatic prefetching |
href | ComputedRef<Url | undefined> | Resolved URL with params interpolated and query applied. Same value as router.resolve. |
isActive | ComputedRef<boolean> | True if route matches current URL, or is a parent route that matches the parent of the current URL. |
isExactActive | ComputedRef<boolean> | True if route matches current URL exactly. |
isExactMatch | ComputedRef<boolean> | True if route matches current URL. Route is the same as what's currently stored at router.route. |
isExternal | ComputedRef<boolean> | - |
isMatch | ComputedRef<boolean> | True if route matches current URL or is ancestor of route that matches current URL |
push | (options?) => Promise<void> | Convenience method for executing router.push with route context passed in. |
replace | (options?) => Promise<void> | Convenience method for executing router.replace with route context passed in. |
route | ComputedRef<ResolvedRoute | undefined> | ResolvedRoute if matched. Same value as router.find |