@@ -20,37 +20,43 @@ API 文档
20
20
- [ RouteLocationNormalizedLoaded] ( interfaces/RouteLocationNormalizedLoaded.md )
21
21
- [ RouteLocationOptions] ( interfaces/RouteLocationOptions.md )
22
22
- [ RouteMeta] ( interfaces/RouteMeta.md )
23
+ - [ RouteRecordMultipleViews] ( interfaces/RouteRecordMultipleViews.md )
24
+ - [ RouteRecordMultipleViewsWithChildren] ( interfaces/RouteRecordMultipleViewsWithChildren.md )
23
25
- [ RouteRecordNormalized] ( interfaces/RouteRecordNormalized.md )
26
+ - [ RouteRecordRedirect] ( interfaces/RouteRecordRedirect.md )
27
+ - [ RouteRecordSingleView] ( interfaces/RouteRecordSingleView.md )
28
+ - [ RouteRecordSingleViewWithChildren] ( interfaces/RouteRecordSingleViewWithChildren.md )
24
29
- [ Router] ( interfaces/Router.md )
25
30
- [ RouterHistory] ( interfaces/RouterHistory.md )
26
31
- [ RouterLinkProps] ( interfaces/RouterLinkProps.md )
27
32
- [ RouterOptions] ( interfaces/RouterOptions.md )
28
33
- [ RouterScrollBehavior] ( interfaces/RouterScrollBehavior.md )
29
34
- [ RouterViewProps] ( interfaces/RouterViewProps.md )
35
+ - [ \_ RouteRecordBase] ( interfaces/RouteRecordBase.md )
30
36
31
37
## TS 类型别名 %{#Type-Aliases}%
32
38
33
39
### LocationQuery %{#Type-Aliases-LocationQuery}%
34
40
35
- Ƭ ** LocationQuery** : ` Record ` <` string ` , ` LocationQueryValue ` \| ` LocationQueryValue ` [ ] \>
41
+ Ƭ ** LocationQuery** : ` Record ` \ <` string ` , ` LocationQueryValue ` \| ` LocationQueryValue ` [ ] \>
36
42
37
43
出现在 [ RouteLocationNormalized] ( interfaces/RouteLocationNormalized.md ) 中的规范化查询对象。
38
44
39
45
___
40
46
41
47
### LocationQueryRaw %{#Type-Aliases-LocationQueryRaw}%
42
48
43
- Ƭ ** LocationQueryRaw** : ` Record ` <` string ` \| ` number ` , ` LocationQueryValueRaw ` \| ` LocationQueryValueRaw ` [ ] \>
49
+ Ƭ ** LocationQueryRaw** : ` Record ` \ <` string ` \| ` number ` , ` LocationQueryValueRaw ` \| ` LocationQueryValueRaw ` [ ] \>
44
50
45
51
松散的 [ LocationQuery] ( index.md#locationquery ) 对象,可以被传递给诸如
46
- [ push] ( interfaces/Router.md#push ) 、[ replace] ( interfaces/Router.md#replace ) 或任何创建
52
+ [ Router. push] ( interfaces/Router.md#push ) 、[ Router. replace] ( interfaces/Router.md#replace ) 或任何创建
47
53
[ RouteLocationRaw] ( index.md#routelocationraw ) 的函数。
48
54
49
55
___
50
56
51
57
### PathParserOptions %{#Type-Aliases-PathParserOptions}%
52
58
53
- Ƭ ** PathParserOptions** : ` Pick ` <` _PathParserOptions ` , `` "end" `` \| `` "sensitive" `` \| `` "strict" `` \>
59
+ Ƭ ** PathParserOptions** : ` Pick ` \ <` _PathParserOptions ` , `` "end" `` \| `` "sensitive" `` \| `` "strict" `` \>
54
60
55
61
___
56
62
72
78
73
79
### RouteParams %{#Type-Aliases-RouteParams}%
74
80
75
- Ƭ ** RouteParams** : ` Record ` <` string ` , ` RouteParamValue ` \| ` RouteParamValue ` [ ] \>
81
+ Ƭ ** RouteParams** : ` Record ` \ <` string ` , ` RouteParamValue ` \| ` RouteParamValue ` [ ] \>
76
82
77
83
___
78
84
79
85
### RouteParamsRaw %{#Type-Aliases-RouteParamsRaw}%
80
86
81
- Ƭ ** RouteParamsRaw** : ` Record ` <` string ` , ` RouteParamValueRaw ` \| ` Exclude ` <` RouteParamValueRaw ` , `` null `` \| ` undefined ` \> [ ] \>
87
+ Ƭ ** RouteParamsRaw** : ` Record ` \ <` string ` , ` RouteParamValueRaw ` \| ` Exclude ` \ <` RouteParamValueRaw ` , `` null `` \| ` undefined ` \> [ ] \>
82
88
83
89
___
84
90
@@ -100,13 +106,13 @@ ___
100
106
101
107
### RouteRecordRaw %{#Type-Aliases-RouteRecordRaw}%
102
108
103
- Ƭ ** RouteRecordRaw** : ` RouteRecordSingleView ` \| ` RouteRecordSingleViewWithChildren ` \| ` RouteRecordMultipleViews ` \| ` RouteRecordMultipleViewsWithChildren ` \| ` RouteRecordRedirect `
109
+ Ƭ ** RouteRecordRaw** : [ ` RouteRecordSingleView ` ] ( interfaces/RouteRecordSingleView.md ) \| [ ` RouteRecordSingleViewWithChildren ` ] ( interfaces/RouteRecordSingleViewWithChildren.md ) \| [ ` RouteRecordMultipleViews ` ] ( interfaces/RouteRecordMultipleViews.md ) \| [ ` RouteRecordMultipleViewsWithChildren ` ] ( interfaces/RouteRecordMultipleViewsWithChildren.md ) \| [ ` RouteRecordRedirect ` ] ( interfaces/RouteRecordRedirect.md )
104
110
105
111
___
106
112
107
113
### UseLinkOptions %{#Type-Aliases-UseLinkOptions}%
108
114
109
- Ƭ ** UseLinkOptions** : ` VueUseOptions ` <` RouterLinkOptions ` \>
115
+ Ƭ ** UseLinkOptions** : ` VueUseOptions ` \ <` RouterLinkOptions ` \>
110
116
111
117
## 变量 %{#Variables}%
112
118
@@ -120,14 +126,24 @@ ___
120
126
121
127
### RouterView %{#Variables-RouterView}%
122
128
123
- • ` Const ` ** RouterView** : () => { ` $props ` : ` AllowedComponentProps ` & ` ComponentCustomProps ` & ` VNodeProps ` & [ ` RouterViewProps ` ] ( interfaces/RouterViewProps.md ) ; ` $slots ` : { ` default? ` : (` __namedParameters ` : { ` Component ` : ` VNode ` <` RendererNode ` , ` RendererElement ` , { ` [key: string] ` : ` any ` ; }\> ; ` route ` : [ ` RouteLocationNormalizedLoaded ` ] ( interfaces/RouteLocationNormalizedLoaded.md ) }) => ` VNode ` <` RendererNode ` , ` RendererElement ` , { ` [key: string] ` : ` any ` ; }\> [ ] } }
129
+ • ` Const ` ** RouterView** : () => \ { ` $props ` : ` AllowedComponentProps ` & ` ComponentCustomProps ` & ` VNodeProps ` & [ ` RouterViewProps ` ] ( interfaces/RouterViewProps.md ) ; ` $slots ` : \ { ` default? ` : (` __namedParameters ` : \ { ` Component ` : ` VNode ` \ <` RendererNode ` , ` RendererElement ` , \ { ` [key: string] ` : ` any ` ; }\> ; ` route ` : [ ` RouteLocationNormalizedLoaded ` ] ( interfaces/RouteLocationNormalizedLoaded.md ) }) => ` VNode ` \ <` RendererNode ` , ` RendererElement ` , \ { ` [key: string] ` : ` any ` ; }\> [ ] } }
124
130
125
131
#### 类型声明 %{#Variables-RouterView-Type-declaration}%
126
132
127
- • ** new RouterView** ()
133
+ • ** new RouterView** (): ` Object `
128
134
129
135
用于显示用户当前所处路由的组件。
130
136
137
+ ##### 返回值 %{#Variables-RouterView-Returns}%
138
+
139
+ ` Object `
140
+
141
+ | 名称 | 类型 |
142
+ | :------ | :------ |
143
+ | ` $props ` | ` AllowedComponentProps ` & ` ComponentCustomProps ` & ` VNodeProps ` & [ ` RouterViewProps ` ] ( interfaces/RouterViewProps.md ) |
144
+ | ` $slots ` | \{ ` default? ` : (` __namedParameters ` : \{ ` Component ` : ` VNode ` \< ` RendererNode ` , ` RendererElement ` , \{ ` [key: string] ` : ` any ` ; }\> ; ` route ` : [ ` RouteLocationNormalizedLoaded ` ] ( interfaces/RouteLocationNormalizedLoaded.md ) }) => ` VNode ` \< ` RendererNode ` , ` RendererElement ` , \{ ` [key: string] ` : ` any ` ; }\> [ ] } |
145
+ | ` $slots.default? ` | (` __namedParameters ` : \{ ` Component ` : ` VNode ` \< ` RendererNode ` , ` RendererElement ` , \{ ` [key: string] ` : ` any ` ; }\> ; ` route ` : [ ` RouteLocationNormalizedLoaded ` ] ( interfaces/RouteLocationNormalizedLoaded.md ) }) => ` VNode ` \< ` RendererNode ` , ` RendererElement ` , \{ ` [key: string] ` : ` any ` ; }\> [ ] |
146
+
131
147
___
132
148
133
149
### START\_ LOCATION %{#Variables-START_LOCATION}%
194
210
195
211
创建一个 hash 模式的历史。在没有主机的 web 应用 (如 ` file:// ` ) 或无法通过配置服务器来处理任意 URL 的时候非常有用。
196
212
213
+ #### 参数 %{#Functions-createWebHashHistory-Parameters}%
214
+
215
+ | 名称 | 类型 | 描述 |
216
+ | :------ | :------ | :------ |
217
+ | ` base? ` | ` string ` | 可选提供的基础位置。默认为 ` location.pathname + location.search ` 。如果在 ` head ` 中有一个 ` <base> ` 标签,它的值会因此被忽略,** 但注意它会影响所有 history.pushState() 的调用** ,这意味着如果你使用一个 ` <base> ` 标签,它的 ` href ` 值** 必须与这个参数匹配** (忽略 ` # ` 后的任何东西)。 |
218
+
219
+ #### 返回值 %{#Functions-createWebHashHistory-Returns}%
220
+
221
+ [ ` RouterHistory ` ] ( interfaces/RouterHistory.md )
222
+
197
223
** 示例**
198
224
199
225
``` js
@@ -210,16 +236,6 @@ createWebHashHistory('/other-folder/') // 给出一个 `https://example.com/othe
210
236
createWebHashHistory (' /iAmIgnored' ) // 给出一个 `file:///usr/etc/folder/index.html#` 的 URL
211
237
```
212
238
213
- #### 参数 %{#Functions-createWebHashHistory-Parameters}%
214
-
215
- | 名称 | 类型 | 描述 |
216
- | :------ | :------ | :------ |
217
- | ` base? ` | ` string ` | 可选提供的基础位置。默认为 ` location.pathname + location.search ` 。如果在 ` head ` 中有一个 ` <base> ` 标签,它的值会因此被忽略,** 但注意它会影响所有 history.pushState() 的调用** ,这意味着如果你使用一个 ` <base> ` 标签,它的 ` href ` 值** 必须与这个参数匹配** (忽略 ` # ` 后的任何东西)。 |
218
-
219
- #### 返回值 %{#Functions-createWebHashHistory-Returns}%
220
-
221
- [ ` RouterHistory ` ] ( interfaces/RouterHistory.md )
222
-
223
239
___
224
240
225
241
### createWebHistory %{#Functions-createWebHistory}%
246
262
247
263
检查一个对象是否是 [ NavigationFailure] ( interfaces/NavigationFailure.md ) 。
248
264
265
+ #### 参数 %{#Functions-isNavigationFailure-Parameters}%
266
+
267
+ | 名称 | 类型 | 描述 |
268
+ | :------ | :------ | :------ |
269
+ | ` error ` | ` any ` | 可能的 [ NavigationFailure] ( interfaces/NavigationFailure.md ) |
270
+ | ` type? ` | ` NAVIGATION_GUARD_REDIRECT ` | 可选的待检查类型 |
271
+
272
+ #### 返回值 %{#Functions-isNavigationFailure-Returns}%
273
+
274
+ error is NavigationRedirectError
275
+
249
276
** 示例**
250
277
251
278
``` js
@@ -267,17 +294,6 @@ router.afterEach((to, from, failure) => {
267
294
})
268
295
```
269
296
270
- #### 参数 %{#Functions-isNavigationFailure-Parameters}%
271
-
272
- | 名称 | 类型 | 描述 |
273
- | :------ | :------ | :------ |
274
- | ` error ` | ` any ` | 可能的 [ NavigationFailure] ( interfaces/NavigationFailure.md ) |
275
- | ` type? ` | ` NAVIGATION_GUARD_REDIRECT ` | 可选的待检查类型 |
276
-
277
- #### 返回值 %{#Functions-isNavigationFailure-Returns}%
278
-
279
- error is NavigationRedirectError
280
-
281
297
▸ ** isNavigationFailure** (` error ` , ` type? ` ): error is NavigationFailure
282
298
283
299
#### 参数 %{#Functions-isNavigationFailure-Parameters_1}%
295
311
296
312
### loadRouteLocation %{#Functions-loadRouteLocation}%
297
313
298
- ▸ ** loadRouteLocation** (` route ` ): ` Promise ` <[ ` RouteLocationNormalizedLoaded ` ] ( interfaces/RouteLocationNormalizedLoaded.md ) \>
314
+ ▸ ** loadRouteLocation** (` route ` ): ` Promise ` \ <[ ` RouteLocationNormalizedLoaded ` ] ( interfaces/RouteLocationNormalizedLoaded.md ) \>
299
315
300
316
确保路由被加载,所以它可以作为一个 prop 传递给 ` <RouterView> ` 。
301
317
307
323
308
324
#### 返回值 %{#Functions-loadRouteLocation-Returns}%
309
325
310
- ` Promise ` <[ ` RouteLocationNormalizedLoaded ` ] ( interfaces/RouteLocationNormalizedLoaded.md ) \>
326
+ ` Promise ` \ <[ ` RouteLocationNormalizedLoaded ` ] ( interfaces/RouteLocationNormalizedLoaded.md ) \>
311
327
312
328
___
313
329
355
371
356
372
| 名称 | 类型 |
357
373
| :------ | :------ |
358
- | ` props ` | ` VueUseOptions ` <` RouterLinkOptions ` \> |
374
+ | ` props ` | ` VueUseOptions ` \ <` RouterLinkOptions ` \> |
359
375
360
376
#### 返回值 %{#Functions-useLink-Returns}%
361
377
@@ -364,10 +380,10 @@ ___
364
380
| 名称 | 类型 |
365
381
| :------ | :------ |
366
382
| ` href ` | ` ComputedRef<string\> ` |
367
- | ` isActive ` | ` ComputedRef ` <` boolean ` \> |
368
- | ` isExactActive ` | ` ComputedRef ` <` boolean ` \> |
369
- | ` navigate ` | (` e ` : ` MouseEvent ` ) => ` Promise ` <` void ` \| [ ` NavigationFailure ` ] ( interfaces/NavigationFailure.md ) \> |
370
- | ` route ` | ` ComputedRef ` <[ ` RouteLocation ` ] ( interfaces/RouteLocation.md ) & { ` href ` : ` string ` }\> |
383
+ | ` isActive ` | ` ComputedRef ` \ <` boolean ` \> |
384
+ | ` isExactActive ` | ` ComputedRef ` \ <` boolean ` \> |
385
+ | ` navigate ` | (` e ` : ` MouseEvent ` ) => ` Promise ` \ <` void ` \| [ ` NavigationFailure ` ] ( interfaces/NavigationFailure.md ) \> |
386
+ | ` route ` | ` ComputedRef ` \ <[ ` RouteLocation ` ] ( interfaces/RouteLocation.md ) & { ` href ` : ` string ` }\> |
371
387
372
388
___
373
389
0 commit comments