From: Eduardo San Martin Morote Date: Tue, 8 Sep 2020 14:13:54 +0000 (+0200) Subject: docs(api): add router-view X-Git-Tag: v4.0.0-beta.10~49 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9373e29d33a3dcfd1d5fa2da31daa80f3b4b6e1f;p=thirdparty%2Fvuejs%2Frouter.git docs(api): add router-view --- diff --git a/docs/api/index.md b/docs/api/index.md index e25332d4..2ac12265 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -10,7 +10,7 @@ sidebar: auto - [Interfaces](./vue-router-interface.md) - [Types](./vue-router-typealias.md) -## `` props +## `` Props ### to @@ -54,14 +54,14 @@ Setting `replace` prop will call `router.replace()` instead of `router.push()` w ### active-class - type: `string` -- default: `'router-link-active'` (or global [`routerLinkActiveClass`](#TODO)) +- default: `"router-link-active"` (or global [`routerLinkActiveClass`](#TODO)) Class to apply on the rendered `a` when the link is active. ### aria-current-value - type: `'page' | 'step' | 'location' | 'date' | 'time' | 'true' | 'false'` (`string`) -- default: `'page'` +- default: `"page"` Value passed to the attribute `aria-current` when the link is exactly active. @@ -81,7 +81,7 @@ Whether `` should not wrap its content in an `` element. Useful ### exact-active-class - type: `string` -- default: `'router-link-exact-active'` (or global [`routerLinkExactActiveClass`](#TODO)) +- default: `"router-link-exact-active"` (or global [`routerLinkExactActiveClass`](#TODO)) Class to apply when the link is exact active. @@ -129,3 +129,16 @@ Sometimes we may want the active class to be applied to an outer element rather :::tip If you add a `target="_blank"` to your `a` element, you must omit the `@click="navigate"` handler. ::: + +## `` Props + +### name + +- type: `string` +- default: `"default"` + +When a `` 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. + +### route + +- type: `RouteLocationNormalizedLoaded`. A route location that has all of its component resolved (if any was lazy loaded) so it can be displayed. diff --git a/docs/api/vue-router-interface.md b/docs/api/vue-router-interface.md index 6b869557..478b5162 100644 --- a/docs/api/vue-router-interface.md +++ b/docs/api/vue-router-interface.md @@ -711,8 +711,6 @@ Custom implementation to stringify a query object. Should not prepend a leading stringifyQuery?: typeof originalStringifyQuery; ``` -## RouterViewProps - ### Methods ### Properties