Skip to content

vue-router / RouterLinkProps

RouterLinkProps ​

Extends ​

  • RouterLinkOptions

Properties ​

activeClass? ​

ts
activeClass?: string;

Class to apply when the link is active


ariaCurrentValue? ​

ts
ariaCurrentValue?: "location" | "time" | "true" | "false" | "page" | "step" | "date";

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

Default Value ​

'page'


custom? ​

ts
custom?: boolean;

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


exactActiveClass? ​

ts
exactActiveClass?: string;

Class to apply when the link is exact active


replace? ​

ts
replace?: boolean;

Calls router.replace instead of router.push.

Inherited from ​

RouterLinkOptions.replace


to ​

ts
to: 
  | string
  | RouteLocationAsRelativeGeneric
  | RouteLocationAsPathGeneric;

Route Location the link should navigate to when clicked on.

Inherited from ​

RouterLinkOptions.to


viewTransition? ​

ts
viewTransition?: boolean;

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

Released under the MIT License.