Skip to content

Commit 9bd8f3c

Browse files
yyx990803yyx990803
committed
docs: merge api into single page
1 parent bb5ba6e commit 9bd8f3c

File tree

121 files changed

+4544
-1070
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

121 files changed

+4544
-1070
lines changed

Diff for: ‎docs/.vuepress/config.js

+62-94
Original file line numberDiff line numberDiff line change
@@ -35,53 +35,37 @@ module.exports = {
3535
link: 'https://github.com/vuejs/vue-router/releases'
3636
}
3737
],
38-
sidebar: {
39-
'/api/': [
40-
{
41-
title: 'API Reference',
42-
collapsable: false,
43-
children: [
44-
'/api/options.md',
45-
'/api/router-instance.md',
46-
'/api/route-object.md',
47-
'/api/component-injections.md',
48-
'/api/router-link.md',
49-
'/api/router-view.md'
50-
]
51-
}
52-
],
53-
'/': [
54-
'/installation.md',
55-
'/',
56-
{
57-
title: 'Essentials',
58-
collapsable: false,
59-
children: [
60-
'/guide/essentials/getting-started.md',
61-
'/guide/essentials/dynamic-matching.md',
62-
'/guide/essentials/nested-routes.md',
63-
'/guide/essentials/navigation.md',
64-
'/guide/essentials/named-routes.md',
65-
'/guide/essentials/named-views.md',
66-
'/guide/essentials/redirect-and-alias.md',
67-
'/guide/essentials/passing-props.md',
68-
'/guide/essentials/history-mode.md'
69-
]
70-
},
71-
{
72-
title: 'Advanced',
73-
collapsable: false,
74-
children: [
75-
'/guide/advanced/navigation-guards.md',
76-
'/guide/advanced/meta.md',
77-
'/guide/advanced/transitions.md',
78-
'/guide/advanced/data-fetching.md',
79-
'/guide/advanced/scroll-behavior.md',
80-
'/guide/advanced/lazy-loading.md'
81-
]
82-
}
83-
]
84-
}
38+
sidebar: [
39+
'/installation.md',
40+
'/',
41+
{
42+
title: 'Essentials',
43+
collapsable: false,
44+
children: [
45+
'/guide/',
46+
'/guide/essentials/dynamic-matching.md',
47+
'/guide/essentials/nested-routes.md',
48+
'/guide/essentials/navigation.md',
49+
'/guide/essentials/named-routes.md',
50+
'/guide/essentials/named-views.md',
51+
'/guide/essentials/redirect-and-alias.md',
52+
'/guide/essentials/passing-props.md',
53+
'/guide/essentials/history-mode.md'
54+
]
55+
},
56+
{
57+
title: 'Advanced',
58+
collapsable: false,
59+
children: [
60+
'/guide/advanced/navigation-guards.md',
61+
'/guide/advanced/meta.md',
62+
'/guide/advanced/transitions.md',
63+
'/guide/advanced/data-fetching.md',
64+
'/guide/advanced/scroll-behavior.md',
65+
'/guide/advanced/lazy-loading.md'
66+
]
67+
}
68+
]
8569
},
8670
'/zh/': {
8771
label: '简体中文',
@@ -101,53 +85,37 @@ module.exports = {
10185
link: 'https://github.com/vuejs/vue-router/releases'
10286
}
10387
],
104-
sidebar: {
105-
'/zh/api/': [
106-
{
107-
title: 'API 参考',
108-
collapsable: false,
109-
children: [
110-
'/zh/api/options.md',
111-
'/zh/api/router-instance.md',
112-
'/zh/api/route-object.md',
113-
'/zh/api/component-injections.md',
114-
'/zh/api/router-link.md',
115-
'/zh/api/router-view.md'
116-
]
117-
}
118-
],
119-
'/zh/': [
120-
'/zh/installation.md',
121-
'/zh/',
122-
{
123-
title: '基础',
124-
collapsable: false,
125-
children: [
126-
'/zh/guide/essentials/getting-started.md',
127-
'/zh/guide/essentials/dynamic-matching.md',
128-
'/zh/guide/essentials/nested-routes.md',
129-
'/zh/guide/essentials/navigation.md',
130-
'/zh/guide/essentials/named-routes.md',
131-
'/zh/guide/essentials/named-views.md',
132-
'/zh/guide/essentials/redirect-and-alias.md',
133-
'/zh/guide/essentials/passing-props.md',
134-
'/zh/guide/essentials/history-mode.md'
135-
]
136-
},
137-
{
138-
title: '进阶',
139-
collapsable: false,
140-
children: [
141-
'/zh/guide/advanced/navigation-guards.md',
142-
'/zh/guide/advanced/meta.md',
143-
'/zh/guide/advanced/transitions.md',
144-
'/zh/guide/advanced/data-fetching.md',
145-
'/zh/guide/advanced/scroll-behavior.md',
146-
'/zh/guide/advanced/lazy-loading.md'
147-
]
148-
}
149-
]
150-
}
88+
sidebar: [
89+
'/zh/installation.md',
90+
'/zh/',
91+
{
92+
title: '基础',
93+
collapsable: false,
94+
children: [
95+
'/zh/guide/',
96+
'/zh/guide/essentials/dynamic-matching.md',
97+
'/zh/guide/essentials/nested-routes.md',
98+
'/zh/guide/essentials/navigation.md',
99+
'/zh/guide/essentials/named-routes.md',
100+
'/zh/guide/essentials/named-views.md',
101+
'/zh/guide/essentials/redirect-and-alias.md',
102+
'/zh/guide/essentials/passing-props.md',
103+
'/zh/guide/essentials/history-mode.md'
104+
]
105+
},
106+
{
107+
title: '进阶',
108+
collapsable: false,
109+
children: [
110+
'/zh/guide/advanced/navigation-guards.md',
111+
'/zh/guide/advanced/meta.md',
112+
'/zh/guide/advanced/transitions.md',
113+
'/zh/guide/advanced/data-fetching.md',
114+
'/zh/guide/advanced/scroll-behavior.md',
115+
'/zh/guide/advanced/lazy-loading.md'
116+
]
117+
}
118+
]
151119
}
152120
}
153121
}

Diff for: ‎docs/.vuepress/dist/404.html

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width,initial-scale=1">
6+
<title>Vue Router</title>
7+
<meta name="description" content="The official router for Vue.js.">
8+
9+
10+
<link rel="preload" href="/assets/css/46.styles.f7bf332b.css" as="style"><link rel="preload" href="/assets/js/app.ad2c2e78.js" as="script"><link rel="prefetch" href="/assets/js/24.09c707c1.js"><link rel="prefetch" href="/assets/js/1.57050575.js"><link rel="prefetch" href="/assets/js/2.f5a49f3a.js"><link rel="prefetch" href="/assets/js/3.ebfd1333.js"><link rel="prefetch" href="/assets/js/4.0e195647.js"><link rel="prefetch" href="/assets/js/5.683e9889.js"><link rel="prefetch" href="/assets/js/6.0fe50ed4.js"><link rel="prefetch" href="/assets/js/7.f37d172c.js"><link rel="prefetch" href="/assets/js/8.8e3c7d9e.js"><link rel="prefetch" href="/assets/js/9.2ccaaf9d.js"><link rel="prefetch" href="/assets/js/10.f0e09295.js"><link rel="prefetch" href="/assets/js/11.80b1d131.js"><link rel="prefetch" href="/assets/js/12.81bfd822.js"><link rel="prefetch" href="/assets/js/13.5d7752b0.js"><link rel="prefetch" href="/assets/js/14.304b67f1.js"><link rel="prefetch" href="/assets/js/15.ffb727f8.js"><link rel="prefetch" href="/assets/js/16.74e83634.js"><link rel="prefetch" href="/assets/js/17.cf5b0129.js"><link rel="prefetch" href="/assets/js/18.8cb980cc.js"><link rel="prefetch" href="/assets/js/19.a2cda62d.js"><link rel="prefetch" href="/assets/js/20.276b83f1.js"><link rel="prefetch" href="/assets/js/21.08a08928.js"><link rel="prefetch" href="/assets/js/22.f68686b9.js"><link rel="prefetch" href="/assets/js/23.71db9bc5.js"><link rel="prefetch" href="/assets/js/0.3028103b.js"><link rel="prefetch" href="/assets/js/25.9dc6bb36.js"><link rel="prefetch" href="/assets/js/26.04527bf5.js"><link rel="prefetch" href="/assets/js/27.6437f73d.js"><link rel="prefetch" href="/assets/js/28.15cd3d6b.js"><link rel="prefetch" href="/assets/js/29.70f41011.js"><link rel="prefetch" href="/assets/js/30.41682606.js"><link rel="prefetch" href="/assets/js/31.c78f8679.js"><link rel="prefetch" href="/assets/js/32.3e88f0da.js"><link rel="prefetch" href="/assets/js/33.90414ec1.js"><link rel="prefetch" href="/assets/js/34.23cd3cb2.js"><link rel="prefetch" href="/assets/js/35.e8e3806c.js"><link rel="prefetch" href="/assets/js/36.ea101143.js"><link rel="prefetch" href="/assets/js/37.ed086ace.js"><link rel="prefetch" href="/assets/js/38.d3d58f69.js"><link rel="prefetch" href="/assets/js/39.5464bead.js"><link rel="prefetch" href="/assets/js/40.8bb79be3.js"><link rel="prefetch" href="/assets/js/41.677c6627.js"><link rel="prefetch" href="/assets/js/42.607297de.js"><link rel="prefetch" href="/assets/js/43.ab66895e.js"><link rel="prefetch" href="/assets/js/44.7962d8de.js"><link rel="prefetch" href="/assets/js/45.87d7d073.js">
11+
<link rel="stylesheet" href="/assets/css/46.styles.f7bf332b.css">
12+
</head>
13+
<body>
14+
<div id="app" data-server-rendered="true"><div class="theme-container"><div class="content"><h1>404</h1><blockquote>There's nothing here.</blockquote><a href="/" class="router-link-active">Take me home.</a></div></div></div>
15+
<script src="/assets/js/app.ad2c2e78.js" defer></script>
16+
</body>
17+
</html>

Diff for: ‎docs/.vuepress/dist/_redirects

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# redirect old urls to root
2+
3+
/en/essentials/* /guide/essentials/*
4+
/en/advanced/* /guide/advanced/*
5+
/en/* /:splat
6+
7+
/zh-cn/essentials/* /zh/guide/essentials/*
8+
/zh-cn/advanced/* /zh/guide/advanced/*
9+
/zh-cn/* /zh/:splat

Diff for: ‎docs/.vuepress/dist/api/component-injections.html

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width,initial-scale=1">
6+
<title>Vue Router | Component Injections</title>
7+
<meta name="description" content="The official router for Vue.js.">
8+
9+
10+
<link rel="preload" href="/assets/css/46.styles.f7bf332b.css" as="style"><link rel="preload" href="/assets/js/app.ad2c2e78.js" as="script"><link rel="preload" href="/assets/js/44.7962d8de.js" as="script"><link rel="prefetch" href="/assets/js/24.09c707c1.js"><link rel="prefetch" href="/assets/js/1.57050575.js"><link rel="prefetch" href="/assets/js/2.f5a49f3a.js"><link rel="prefetch" href="/assets/js/3.ebfd1333.js"><link rel="prefetch" href="/assets/js/4.0e195647.js"><link rel="prefetch" href="/assets/js/5.683e9889.js"><link rel="prefetch" href="/assets/js/6.0fe50ed4.js"><link rel="prefetch" href="/assets/js/7.f37d172c.js"><link rel="prefetch" href="/assets/js/8.8e3c7d9e.js"><link rel="prefetch" href="/assets/js/9.2ccaaf9d.js"><link rel="prefetch" href="/assets/js/10.f0e09295.js"><link rel="prefetch" href="/assets/js/11.80b1d131.js"><link rel="prefetch" href="/assets/js/12.81bfd822.js"><link rel="prefetch" href="/assets/js/13.5d7752b0.js"><link rel="prefetch" href="/assets/js/14.304b67f1.js"><link rel="prefetch" href="/assets/js/15.ffb727f8.js"><link rel="prefetch" href="/assets/js/16.74e83634.js"><link rel="prefetch" href="/assets/js/17.cf5b0129.js"><link rel="prefetch" href="/assets/js/18.8cb980cc.js"><link rel="prefetch" href="/assets/js/19.a2cda62d.js"><link rel="prefetch" href="/assets/js/20.276b83f1.js"><link rel="prefetch" href="/assets/js/21.08a08928.js"><link rel="prefetch" href="/assets/js/22.f68686b9.js"><link rel="prefetch" href="/assets/js/23.71db9bc5.js"><link rel="prefetch" href="/assets/js/0.3028103b.js"><link rel="prefetch" href="/assets/js/25.9dc6bb36.js"><link rel="prefetch" href="/assets/js/26.04527bf5.js"><link rel="prefetch" href="/assets/js/27.6437f73d.js"><link rel="prefetch" href="/assets/js/28.15cd3d6b.js"><link rel="prefetch" href="/assets/js/29.70f41011.js"><link rel="prefetch" href="/assets/js/30.41682606.js"><link rel="prefetch" href="/assets/js/31.c78f8679.js"><link rel="prefetch" href="/assets/js/32.3e88f0da.js"><link rel="prefetch" href="/assets/js/33.90414ec1.js"><link rel="prefetch" href="/assets/js/34.23cd3cb2.js"><link rel="prefetch" href="/assets/js/35.e8e3806c.js"><link rel="prefetch" href="/assets/js/36.ea101143.js"><link rel="prefetch" href="/assets/js/37.ed086ace.js"><link rel="prefetch" href="/assets/js/38.d3d58f69.js"><link rel="prefetch" href="/assets/js/39.5464bead.js"><link rel="prefetch" href="/assets/js/40.8bb79be3.js"><link rel="prefetch" href="/assets/js/41.677c6627.js"><link rel="prefetch" href="/assets/js/42.607297de.js"><link rel="prefetch" href="/assets/js/43.ab66895e.js"><link rel="prefetch" href="/assets/js/45.87d7d073.js">
11+
<link rel="stylesheet" href="/assets/css/46.styles.f7bf332b.css">
12+
</head>
13+
<body>
14+
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div><a href="/" class="home-link router-link-active"><!----><span class="site-name">
15+
Vue Router
16+
</span></a><div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""><!----></div><nav class="nav-links can-hide"><div class="nav-item"><a href="/guide/" class="nav-link">Guide</a></div><div class="nav-item"><a href="/api/" class="nav-link router-link-active">API Reference</a></div><div class="nav-item"><a href="https://github.com/vuejs/vue-router/releases" target="_blank" rel="noopener noreferrer" class="nav-link external">
17+
Release Notes
18+
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div><div class="nav-item"><div class="dropdown-wrapper"><a class="dropdown-title"><span class="title">Languages</span><span class="arrow right"></span></a><ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----><a href="/api/component-injections.html" class="nav-link router-link-exact-active router-link-active">English</a></li><li class="dropdown-item"><!----><a href="/zh/api/component-injections.html" class="nav-link">简体中文</a></li></ul></div></div><a href="https://github.com/vuejs/vue-router" target="_blank" rel="noopener noreferrer" class="repo-link">
19+
GitHub
20+
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav></div></header><div class="sidebar-mask"></div><div class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/guide/" class="nav-link">Guide</a></div><div class="nav-item"><a href="/api/" class="nav-link router-link-active">API Reference</a></div><div class="nav-item"><a href="https://github.com/vuejs/vue-router/releases" target="_blank" rel="noopener noreferrer" class="nav-link external">
21+
Release Notes
22+
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div><div class="nav-item"><div class="dropdown-wrapper"><a class="dropdown-title"><span class="title">Languages</span><span class="arrow right"></span></a><ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----><a href="/api/component-injections.html" class="nav-link router-link-exact-active router-link-active">English</a></li><li class="dropdown-item"><!----><a href="/zh/api/component-injections.html" class="nav-link">简体中文</a></li></ul></div></div><a href="https://github.com/vuejs/vue-router" target="_blank" rel="noopener noreferrer" class="repo-link">
23+
GitHub
24+
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav><div class="carbon-ads"></div><ul class="sidebar-links"><li><div class="sidebar-group first"><p class="sidebar-heading open"><span>API Reference</span><!----></p><ul class="sidebar-group-items"><li><a href="/api/options.html" class="sidebar-link">Router Construction Options</a></li><li><a href="/api/router-instance.html" class="sidebar-link">The Router Instance</a></li><li><a href="/api/route-object.html" class="sidebar-link">The Route Object</a></li><li><a href="/api/component-injections.html" class="active sidebar-link">Component Injections</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/api/component-injections.html#injected-properties" class="sidebar-link">Injected Properties</a></li><li class="sidebar-sub-header"><a href="/api/component-injections.html#enabled-options" class="sidebar-link">Enabled Options</a></li></ul></li><li><a href="/api/router-link.html" class="sidebar-link">&lt;router-link&gt;</a></li><li><a href="/api/router-view.html" class="sidebar-link">&lt;router-view&gt;</a></li></ul></div></li></ul></div><div class="page"><div class="content"><h1 id="component-injections"><a href="#component-injections" aria-hidden="true" class="header-anchor">#</a> Component Injections</h1><h2 id="injected-properties"><a href="#injected-properties" aria-hidden="true" class="header-anchor">#</a> Injected Properties</h2><p>These properties are injected into every child component by passing the router instance to the root instance as the <code>router</code> option.</p><ul><li><h3 id="router"><a href="#router" aria-hidden="true" class="header-anchor">#</a> $router</h3><p>The router instance.</p></li><li><h3 id="route"><a href="#route" aria-hidden="true" class="header-anchor">#</a> $route</h3><p>The current active <a href="/api/route-object.html">Route</a>. This property is read-only and its properties are immutable, but it can be watched.</p></li></ul><h2 id="enabled-options"><a href="#enabled-options" aria-hidden="true" class="header-anchor">#</a> Enabled Options</h2><ul><li><p><strong>beforeRouteEnter</strong></p></li><li><p><strong>beforeRouteUpdate</strong> (added in 2.2)</p></li><li><p><strong>beforeRouteLeave</strong></p><p>See <a href="/advanced/navigation-guards.html#incomponent-guards">In Component Guards</a>.</p></li></ul></div><!----><div class="content page-nav"><p class="inner"><span class="prev">
25+
← <a href="/api/route-object.html" class="prev">
26+
The Route Object
27+
</a></span><span class="next"><a href="/api/router-link.html">
28+
&lt;router-link&gt;
29+
</a> →
30+
</span></p></div><div class="bsa-cpc-wrapper"><div class="bsa-cpc"></div></div></div></div></div>
31+
<script src="/assets/js/44.7962d8de.js" defer></script><script src="/assets/js/app.ad2c2e78.js" defer></script>
32+
</body>
33+
</html>

0 commit comments

Comments
 (0)