no-deprecated-router-link-tag-prop.md

pageClass	sidebarDepth	title	description	since
rule-details	0	vue/no-deprecated-router-link-tag-prop	disallow using deprecated `tag` property on `RouterLink` (in Vue.js 3.0.0+)	v7.20.0

vue/no-deprecated-router-link-tag-prop

disallow using deprecated tag property on RouterLink (in Vue.js 3.0.0+)

• ⚙️ This rule is included in all of "plugin:vue/vue3-essential", "plugin:vue/vue3-strongly-recommended" and "plugin:vue/vue3-recommended".

📖 Rule Details

This rule reports deprecated the tag attribute on RouterLink elements (removed in Vue.js v3.0.0+).

<template>
  <!-- ✓ GOOD -->
  <RouterLink to="/">Home</RouterLink>
  <router-link to="/">Home</router-link>

  <RouterLink to="/">
    <div>Home</div>
  </RouterLink>

  <router-link to="/">
    <div>Home</div>
  </router-link>

  <NuxtLink tag="div" to="/">Home</NuxtLink>
  <nuxt-link tag="div" to="/">Home</nuxt-link>

  <!-- ✗ BAD -->
  <RouterLink tag="div" to="/">Home</RouterLink>
  <router-link tag="div" to="/">Home</router-link>
  <RouterLink :tag="someVariable" to="/">Home</RouterLink>
  <router-link :tag="someVariable" to="/">Home</router-link>
</template>

🔧 Options

{
  "vue/no-deprecated-router-link-tag-prop": ["error", {
    "components": ['RouterLink']
  }]
}

• components (string[]) ... Component names which will be checked with the tag attribute. default ['RouterLink'].

Note: this rule will check both kebab-case and PascalCase versions of the given component names.

{ "components": ['RouterLink', 'NuxtLink'] }

<template>
  <!-- ✗ BAD -->
  <RouterLink tag="div" to="/">Home</RouterLink>
  <router-link tag="div" to="/">Home</router-link>

  <RouterLink :tag="someVariable" to="/">Home</RouterLink>
  <router-link :tag="someVariable" to="/">Home</router-link>

  <NuxtLink tag="div" to="/">Home</NuxtLink>
  <nuxt-link tag="div" to="/">Home</nuxt-link>

  <NuxtLink :tag="someVariable" to="/">Home</NuxtLink>
  <nuxt-link :tag="someVariable" to="/">Home</nuxt-link>
</template>

📚 Further Reading

• Vue RFCs - 0021-router-link-scoped-slot

🚀 Version

This rule was introduced in eslint-plugin-vue v7.20.0

🔍 Implementation

• Rule source
• Test source