From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Fri, 18 Sep 2020 11:49:07 +0000 (+0200)
Subject: docs: more details about custom
X-Git-Tag: v4.0.0-beta.11~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a072a5fb600752bcb642649ba4beed169665ff54;p=thirdparty%2Fvuejs%2Frouter.git

docs: more details about custom
---

diff --git a/docs/api/index.md b/docs/api/index.md
index 7c285b5e..97571255 100644
--- a/docs/api/index.md
+++ b/docs/api/index.md
@@ -68,13 +68,25 @@ sidebar: auto
 - **Default**: `false`
 - **Details**:
 
-  Whether `<router-link>` should not wrap its content in an `<a>` element. Useful when using [`v-slot`](#router-link-s-v-slot) to create a custom RouterLink.
+  Whether `<router-link>` should not wrap its content in an `<a>` element. Useful when using [`v-slot`](#router-link-s-v-slot) to create a custom RouterLink. By default, `<router-link>` will render its content wrapped in an `<a>` element, even when using `v-slot`. Passing the `custom` prop, removes that behavior.
 
-```html
-<router-link to="/home" custom v-slot="{ navigate, href, route }">
-  <a :href="href" @click="navigate">{{ route.fullPath }}</a>
-</router-link>
-```
+- **Examples**:
+
+  ```html
+  <router-link to="/home" custom v-slot="{ navigate, href, route }">
+    <a :href="href" @click="navigate">{{ route.fullPath }}</a>
+  </router-link>
+  ```
+
+  Renders `<a href="/home">/home</a>`.
+
+  ```html
+  <router-link to="/home" v-slot="{ route }">
+    <span>{{ route.fullPath }}</span>
+  </router-link>
+  ```
+
+  Renders `<a href="/home"><span>/home</span></a>`.
 
 ### exact-active-class