Skip to content

Commit 9373e29

Browse files
committed
docs(api): add router-view
1 parent 242a6aa commit 9373e29

File tree

2 files changed

+17
-6
lines changed

2 files changed

+17
-6
lines changed

docs/api/index.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ sidebar: auto
1010
- [Interfaces](./vue-router-interface.md)
1111
- [Types](./vue-router-typealias.md)
1212

13-
## `<router-link>` props
13+
## `<router-link>` Props
1414

1515
### to
1616

@@ -54,14 +54,14 @@ Setting `replace` prop will call `router.replace()` instead of `router.push()` w
5454
### active-class
5555

5656
- type: `string`
57-
- default: `'router-link-active'` (or global [`routerLinkActiveClass`](#TODO))
57+
- default: `"router-link-active"` (or global [`routerLinkActiveClass`](#TODO))
5858

5959
Class to apply on the rendered `a` when the link is active.
6060

6161
### aria-current-value
6262

6363
- type: `'page' | 'step' | '___location' | 'date' | 'time' | 'true' | 'false'` (`string`)
64-
- default: `'page'`
64+
- default: `"page"`
6565

6666
Value passed to the attribute `aria-current` when the link is exactly active.
6767

@@ -81,7 +81,7 @@ Whether `<router-link>` should not wrap its content in an `<a>` element. Useful
8181
### exact-active-class
8282

8383
- type: `string`
84-
- default: `'router-link-exact-active'` (or global [`routerLinkExactActiveClass`](#TODO))
84+
- default: `"router-link-exact-active"` (or global [`routerLinkExactActiveClass`](#TODO))
8585

8686
Class to apply when the link is exact active.
8787

@@ -129,3 +129,16 @@ Sometimes we may want the active class to be applied to an outer element rather
129129
:::tip
130130
If you add a `target="_blank"` to your `a` element, you must omit the `@click="navigate"` handler.
131131
:::
132+
133+
## `<router-view>` Props
134+
135+
### name
136+
137+
- type: `string`
138+
- default: `"default"`
139+
140+
When a `<router-view>` has a `name`, it will render the component with the corresponding name in the matched route record's `components` option. See [Named Views](/guide/essentials/named-views.md) for an example.
141+
142+
### route
143+
144+
- type: `RouteLocationNormalizedLoaded`. A route ___location that has all of its component resolved (if any was lazy loaded) so it can be displayed.

docs/api/vue-router-interface.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -711,8 +711,6 @@ Custom implementation to stringify a query object. Should not prepend a leading
711711
stringifyQuery?: typeof originalStringifyQuery;
712712
```
713713

714-
## RouterViewProps
715-
716714
### Methods
717715

718716
### Properties

0 commit comments

Comments
 (0)