feat(link): deprecate v-slot without custom prop

posva · posva · commit ceeda4ce542c · 2021-01-05T11:30:09.000+01:00
diff --git a/examples/basic/app.js b/examples/basic/app.js
@@ -79,7 +79,7 @@ const vueInstance = new Vue({
         <li><router-link :to="encodeURI('/é')">/é</router-link></li>
         <li><router-link :to="encodeURI('/é?t=%ñ')">/é?t=%ñ</router-link></li>
         <li><router-link :to="encodeURI('/é#%ñ')">/é#%25ñ</router-link></li>
-        <router-link to="/foo" v-slot="props">
+        <router-link to="/foo" v-slot="props" custom>
           <li :class="[props.isActive && 'active', props.isExactActive && 'exact-active']">
             <a :href="props.href" @click="props.navigate">{{ props.route.path }} (with v-slot).</a>
           </li>
diff --git a/src/components/link.js b/src/components/link.js
@@ -11,6 +11,8 @@ const eventTypes: Array<Function> = [String, Array]
 
 const noop = () => {}
 
+let warnedCustomSlot
+
 export default {
   name: 'RouterLink',
   props: {
@@ -22,6 +24,7 @@ export default {
       type: String,
       default: 'a'
     },
+    custom: Boolean,
     exact: Boolean,
     append: Boolean,
     replace: Boolean,
@@ -106,13 +109,17 @@ export default {
       })
 
     if (scopedSlot) {
+      if (process.env.NODE_ENV !== 'production' && !this.custom) {
+        !warnedCustomSlot && warn(false, 'In Vue Router 4, the v-slot API will by default wrap its content with an <a> element. Use the custom prop to remove this warning:\n<router-link v-slot="{ navigate, href }" custom></router-link>\n')
+        warnedCustomSlot = true
+      }
       if (scopedSlot.length === 1) {
         return scopedSlot[0]
       } else if (scopedSlot.length > 1 || !scopedSlot.length) {
         if (process.env.NODE_ENV !== 'production') {
           warn(
             false,
-            `RouterLink with to="${
+            `<router-link> with to="${
               this.to
             }" is trying to use a scoped slot but it didn't provide exactly one child. Wrapping the content with a span element.`
           )
