API Documentation • Docs

---

API Documentation / RouterLinkProps

Interface: RouterLinkProps

Extends

• RouterLinkOptions

Properties

activeClass?

optional activeClass: string

Class to apply when the link is active

---

ariaCurrentValue?

optional ariaCurrentValue: "time" | "location" | "page" | "step" | "date" | "true" | "false"

Value passed to the attribute aria-current when the link is exact active.

Default Value

'page'

---

custom?

optional custom: boolean

Whether RouterLink should not wrap its content in an a tag. Useful when using v-slot to create a custom RouterLink

---

exactActiveClass?

optional exactActiveClass: string

Class to apply when the link is exact active

---

replace?

optional replace: boolean

Calls router.replace instead of router.push.

Inherited from

RouterLinkOptions.replace

---

to

to: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric

Route Location the link should navigate to when clicked on.

Inherited from

RouterLinkOptions.to

---

viewTransition?

optional viewTransition: boolean

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