Skip to content

Commit 9ea7052

Browse files
Jinjiangwxsms
Jinjiang
and
wxsms
authored
docs(zh): translate api interfaces (#1821)
* docs(zh): translate api interfaces * Update Router.md * Apply suggestions from code review Co-authored-by: wxsm <[email protected]> --------- Co-authored-by: wxsm <[email protected]>
1 parent 7505b5b commit 9ea7052

20 files changed

+284
-313
lines changed

‎packages/docs/zh/api/enums/NavigationFailureType.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
editLink: false
33
---
44

5-
[API Documentation](../index.md) / NavigationFailureType
5+
[API 参考](../index.md) / NavigationFailureType
66

77
# 枚举：NavigationFailureType %{#enumeration-navigationfailuretype}%
88

‎packages/docs/zh/api/interfaces/HistoryState.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
editLink: false
33
---
44

5-
[API Documentation](../index.md) / HistoryState
5+
[API 参考](../index.md) / HistoryState
66

77
# 接口：HistoryState %{#interface-historystate}%
88

‎packages/docs/zh/api/interfaces/NavigationFailure.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
editLink: false
33
---
44

5-
[API Documentation](../index.md) / NavigationFailure
5+
[API 参考](../index.md) / NavigationFailure
66

77
# 接口：NavigationFailure %{#interface-navigationfailure}%
88

@@ -68,12 +68,12 @@ ___
6868

6969
• **to**: [`RouteLocationNormalized`](RouteLocationNormalized.md)
7070

71-
Route location we were navigating to
71+
要导航至的下一个路由位置
7272

7373
___
7474

7575
### type %{#Properties-type}%
7676

7777
• **type**: `NAVIGATION_ABORTED` \| `NAVIGATION_CANCELLED` \| `NAVIGATION_DUPLICATED`
7878

79-
Type of the navigation. One of [NavigationFailureType](../enums/NavigationFailureType.md)
79+
导航类型。属于 [NavigationFailureType](../enums/NavigationFailureType.md) 的一种。

‎packages/docs/zh/api/interfaces/NavigationGuard.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,26 @@
22
editLink: false
33
---
44

5-
[API Documentation](../index.md) / NavigationGuard
5+
[API 参考](../index.md) / NavigationGuard
66

7-
# Interface: NavigationGuard
7+
# 接口：NavigationGuard %{#interface-navigationguard}%
88

9-
## Callable %{#Callable}%
9+
## 可调用函数 %{#Callable}%
1010

1111
### NavigationGuard %{#Callable-NavigationGuard}%
1212

1313
▸ **NavigationGuard**(`to`, `from`, `next`): `NavigationGuardReturn` \| `Promise`<`NavigationGuardReturn`\>
1414

15-
Navigation guard. See [Navigation
16-
Guards](/guide/advanced/navigation-guards.md).
15+
导航守卫。详情可查阅[导航守卫](/zh/guide/advanced/navigation-guards.md).
1716

18-
#### Parameters %{#Callable-NavigationGuard-Parameters}%
17+
#### 参数 %{#Callable-NavigationGuard-Parameters}%
1918

20-
| Name | Type |
19+
| 名称 | 类型 |
2120
| :------ | :------ |
2221
| `to` | [`RouteLocationNormalized`](RouteLocationNormalized.md) |
2322
| `from` | [`RouteLocationNormalized`](RouteLocationNormalized.md) |
2423
| `next` | [`NavigationGuardNext`](NavigationGuardNext.md) |
2524

26-
#### Returns %{#Callable-NavigationGuard-Returns}%
25+
#### 返回值 %{#Callable-NavigationGuard-Returns}%
2726

2827
`NavigationGuardReturn` \| `Promise`<`NavigationGuardReturn`\>

‎packages/docs/zh/api/interfaces/NavigationGuardNext.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,72 +2,72 @@
22
editLink: false
33
---
44

5-
[API Documentation](../index.md) / NavigationGuardNext
5+
[API 参考](../index.md) / NavigationGuardNext
66

7-
# Interface: NavigationGuardNext
7+
# 接口：NavigationGuardNext %{#interface-navigationguardnext}%
88

9-
## Callable %{#Callable}%
9+
## 可调用函数 %{#Callable}%
1010

1111
### NavigationGuardNext %{#Callable-NavigationGuardNext}%
1212

1313
▸ **NavigationGuardNext**(): `void`
1414

15-
#### Returns %{#Callable-NavigationGuardNext-Returns}%
15+
#### 返回值 %{#Callable-NavigationGuardNext-Returns}%
1616

1717
`void`
1818

1919
### NavigationGuardNext %{#Callable-NavigationGuardNext_1}%
2020

2121
▸ **NavigationGuardNext**(`error`): `void`
2222

23-
#### Parameters %{#Callable-NavigationGuardNext-Parameters}%
23+
#### 参数 %{#Callable-NavigationGuardNext-Parameters}%
2424

25-
| Name | Type |
25+
| 名称 | 类型 |
2626
| :------ | :------ |
2727
| `error` | `Error` |
2828

29-
#### Returns %{#Callable-NavigationGuardNext-Returns_1}%
29+
#### 返回值 %{#Callable-NavigationGuardNext-Returns_1}%
3030

3131
`void`
3232

3333
### NavigationGuardNext %{#Callable-NavigationGuardNext_2}%
3434

3535
▸ **NavigationGuardNext**(`location`): `void`
3636

37-
#### Parameters %{#Callable-NavigationGuardNext-Parameters_1}%
37+
#### 参数 %{#Callable-NavigationGuardNext-Parameters_1}%
3838

39-
| Name | Type |
39+
| 名称 | 类型 |
4040
| :------ | :------ |
4141
| `location` | [`RouteLocationRaw`](../index.md#routelocationraw) |
4242

43-
#### Returns %{#Callable-NavigationGuardNext-Returns_2}%
43+
#### 返回值 %{#Callable-NavigationGuardNext-Returns_2}%
4444

4545
`void`
4646

4747
### NavigationGuardNext %{#Callable-NavigationGuardNext_3}%
4848

4949
▸ **NavigationGuardNext**(`valid`): `void`
5050

51-
#### Parameters %{#Callable-NavigationGuardNext-Parameters_2}%
51+
#### 参数 %{#Callable-NavigationGuardNext-Parameters_2}%
5252

53-
| Name | Type |
53+
| 名称 | 类型 |
5454
| :------ | :------ |
5555
| `valid` | `undefined` \| `boolean` |
5656

57-
#### Returns %{#Callable-NavigationGuardNext-Returns_3}%
57+
#### 返回值 %{#Callable-NavigationGuardNext-Returns_3}%
5858

5959
`void`
6060

6161
### NavigationGuardNext %{#Callable-NavigationGuardNext_4}%
6262

6363
▸ **NavigationGuardNext**(`cb`): `void`
6464

65-
#### Parameters %{#Callable-NavigationGuardNext-Parameters_3}%
65+
#### 参数 %{#Callable-NavigationGuardNext-Parameters_3}%
6666

67-
| Name | Type |
67+
| 名称 | 类型 |
6868
| :------ | :------ |
6969
| `cb` | `NavigationGuardNextCallback` |
7070

71-
#### Returns %{#Callable-NavigationGuardNext-Returns_4}%
71+
#### 返回值 %{#Callable-NavigationGuardNext-Returns_4}%
7272

7373
`void`

‎packages/docs/zh/api/interfaces/NavigationGuardWithThis.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,33 @@
22
editLink: false
33
---
44

5-
[API Documentation](../index.md) / NavigationGuardWithThis
5+
[API 参考](../index.md) / NavigationGuardWithThis
66

7-
# Interface: NavigationGuardWithThis<T\>
7+
# 接口：NavigationGuardWithThis<T\> %{#interface-navigationguardwiththis-t}%
88

9-
## Type parameters %{#Type-parameters}%
9+
## 类型参数 %{#Type-parameters}%
1010

1111
| Name |
1212
| :------ |
1313
| `T` |
1414

15-
## Callable %{#Callable}%
15+
## 可调用函数 %{#Callable}%
1616

1717
### NavigationGuardWithThis %{#Callable-NavigationGuardWithThis}%
1818

1919
▸ **NavigationGuardWithThis**(`this`, `to`, `from`, `next`): `NavigationGuardReturn` \| `Promise`<`NavigationGuardReturn`\>
2020

21-
Navigation guard. See [Navigation
22-
Guards](/guide/advanced/navigation-guards.md).
21+
导航守卫。详情可查阅[导航守卫](/zh/guide/advanced/navigation-guards.md).
2322

24-
#### Parameters %{#Callable-NavigationGuardWithThis-Parameters}%
23+
#### 参数 %{#Callable-NavigationGuardWithThis-Parameters}%
2524

26-
| Name | Type |
25+
| 名称 | 类型 |
2726
| :------ | :------ |
2827
| `this` | `T` |
2928
| `to` | [`RouteLocationNormalized`](RouteLocationNormalized.md) |
3029
| `from` | [`RouteLocationNormalized`](RouteLocationNormalized.md) |
3130
| `next` | [`NavigationGuardNext`](NavigationGuardNext.md) |
3231

33-
#### Returns %{#Callable-NavigationGuardWithThis-Returns}%
32+
#### 返回值 %{#Callable-NavigationGuardWithThis-Returns}%
3433

3534
`NavigationGuardReturn` \| `Promise`<`NavigationGuardReturn`\>

‎packages/docs/zh/api/interfaces/NavigationHookAfter.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,24 @@
22
editLink: false
33
---
44

5-
[API Documentation](../index.md) / NavigationHookAfter
5+
[API 参考](../index.md) / NavigationHookAfter
66

7-
# Interface: NavigationHookAfter
7+
# 接口：NavigationHookAfter %{#interface-navigationhookafter}%
88

9-
## Callable %{#Callable}%
9+
## 可调用函数 %{#Callable}%
1010

1111
### NavigationHookAfter %{#Callable-NavigationHookAfter}%
1212

1313
▸ **NavigationHookAfter**(`to`, `from`, `failure?`): `any`
1414

15-
#### Parameters %{#Callable-NavigationHookAfter-Parameters}%
15+
#### 参数 %{#Callable-NavigationHookAfter-Parameters}%
1616

17-
| Name | Type |
17+
| 名称 | 类型 |
1818
| :------ | :------ |
1919
| `to` | [`RouteLocationNormalized`](RouteLocationNormalized.md) |
2020
| `from` | [`RouteLocationNormalized`](RouteLocationNormalized.md) |
2121
| `failure?` | `void` \| [`NavigationFailure`](NavigationFailure.md) |
2222

23-
#### Returns %{#Callable-NavigationHookAfter-Returns}%
23+
#### 返回值 %{#Callable-NavigationHookAfter-Returns}%
2424

2525
`any`

‎packages/docs/zh/api/interfaces/RouteLocation.md

Lines changed: 22 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,27 @@
22
editLink: false
33
---
44

5-
[API Documentation](../index.md) / RouteLocation
5+
[API 参考](../index.md) / RouteLocation
66

7-
# Interface: RouteLocation
7+
# 接口：RouteLocation %{#interface-routelocation}%
88

9-
[RouteLocationRaw](../index.md#routelocationraw) resolved using the matcher
9+
通过匹配解析出来的 [RouteLocationRaw](../index.md#routelocationraw)
1010

11-
## Hierarchy %{#Hierarchy}%
11+
## 继承关系 %{#Hierarchy}%
1212

1313
- `_RouteLocationBase`
1414

1515
↳ **`RouteLocation`**
1616

17-
## Properties %{#Properties}%
17+
## 属性 %{#Properties}%
1818

1919
### fullPath %{#Properties-fullPath}%
2020

2121
• **fullPath**: `string`
2222

23-
The whole location including the `search` and `hash`. This string is
24-
percentage encoded.
23+
包括 `search` 和 `hash` 在内的完整地址。该字符串是经过百分号编码的。
2524

26-
#### Inherited from %{#Properties-fullPath-Inherited-from}%
25+
#### 继承自 %{#Properties-fullPath-Inherited-from}%
2726

2827
\_RouteLocationBase.fullPath
2928

@@ -33,9 +32,9 @@ ___
3332

3433
• **hash**: `string`
3534

36-
Hash of the current location. If present, starts with a `#`.
35+
当前地址的 hash。如果存在则以 `#` 开头。
3736

38-
#### Inherited from %{#Properties-hash-Inherited-from}%
37+
#### 继承自 %{#Properties-hash-Inherited-from}%
3938

4039
\_RouteLocationBase.hash
4140

@@ -45,19 +44,17 @@ ___
4544

4645
• **matched**: [`RouteRecordNormalized`](RouteRecordNormalized.md)[]
4746

48-
Array of [RouteRecord](../index.md#routerecord) containing components as they were
49-
passed when adding records. It can also contain redirect records. This
50-
can't be used directly
47+
包含添加记录时被传入的 [RouteRecord](../index.md#routerecord) 的数组。它也可以包含重定向记录。不能直接使用。
5148

5249
___
5350

5451
### meta %{#Properties-meta}%
5552

5653
• **meta**: [`RouteMeta`](RouteMeta.md)
5754

58-
Merged `meta` properties from all the matched route records.
55+
从所有匹配的路由记录中合并的 `meta` 属性。
5956

60-
#### Inherited from %{#Properties-meta-Inherited-from}%
57+
#### 继承自 %{#Properties-meta-Inherited-from}%
6158

6259
\_RouteLocationBase.meta
6360

@@ -67,9 +64,9 @@ ___
6764

6865
• **name**: `undefined` \| ``null`` \| [`RouteRecordName`](../index.md#routerecordname)
6966

70-
Name of the matched record
67+
匹配的路由名称。
7168

72-
#### Inherited from %{#Properties-name-Inherited-from}%
69+
#### 继承自 %{#Properties-name-Inherited-from}%
7370

7471
\_RouteLocationBase.name
7572

@@ -79,9 +76,9 @@ ___
7976

8077
• **params**: [`RouteParams`](../index.md#routeparams)
8178

82-
Object of decoded params extracted from the `path`.
79+
从 `path` 中提取出来并解码后的参数对象。
8380

84-
#### Inherited from %{#Properties-params-Inherited-from}%
81+
#### 继承自 %{#Properties-params-Inherited-from}%
8582

8683
\_RouteLocationBase.params
8784

@@ -91,9 +88,9 @@ ___
9188

9289
• **path**: `string`
9390

94-
Percentage encoded pathname section of the URL.
91+
经过百分号编码的 URL 中的 pathname 段。
9592

96-
#### Inherited from %{#Properties-path-Inherited-from}%
93+
#### 继承自 %{#Properties-path-Inherited-from}%
9794

9895
\_RouteLocationBase.path
9996

@@ -103,9 +100,9 @@ ___
103100

104101
• **query**: [`LocationQuery`](../index.md#locationquery)
105102

106-
Object representation of the `search` property of the current location.
103+
代表当前地址的 `search` 属性的对象
107104

108-
#### Inherited from %{#Properties-query-Inherited-from}%
105+
#### 继承自 %{#Properties-query-Inherited-from}%
109106

110107
\_RouteLocationBase.query
111108

@@ -115,9 +112,8 @@ ___
115112

116113
• **redirectedFrom**: `undefined` \| [`RouteLocation`](RouteLocation.md)
117114

118-
Contains the location we were initially trying to access before ending up
119-
on the current location.
115+
包含在重定向到当前地址之前，我们最初想访问的地址。
120116

121-
#### Inherited from %{#Properties-redirectedFrom-Inherited-from}%
117+
#### 继承自 %{#Properties-redirectedFrom-Inherited-from}%
122118

123119
\_RouteLocationBase.redirectedFrom

0 commit comments

Comments
 (0)