From a6d7c47763a6d51de0bac2ece9f2bb4e0c485436 Mon Sep 17 00:00:00 2001 From: Zhicheng Wang Date: Sat, 1 Sep 2018 10:16:58 +0800 Subject: [PATCH] =?UTF-8?q?docs(API):=20=E7=BF=BB=E8=AF=91=E5=AE=8C?= =?UTF-8?q?=E4=BA=86=20RouterLink?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- aio/content/translations/cn/api-plan.md | 4 +- packages/router/src/directives/router_link.ts | 58 +++++++++++++++++++ 2 files changed, 60 insertions(+), 2 deletions(-) diff --git a/aio/content/translations/cn/api-plan.md b/aio/content/translations/cn/api-plan.md index ff6dbbd374..c37d4710d1 100644 --- a/aio/content/translations/cn/api-plan.md +++ b/aio/content/translations/cn/api-plan.md @@ -21,8 +21,8 @@ [x] |forms/FormGroup | 3,096 | 0.96 [x] |forms/FormControl | 3,034 | 0.94 [x] |router/ActivatedRoute | 2,993 | 0.93 -[ ] |forms/AbstractControl | 2,930 | 0.91 -[ ] |router/RouterLink | 2,929 | 0.91 +[x] |forms/AbstractControl | 2,930 | 0.91 +[x] |router/RouterLink | 2,929 | 0.91 [ ] |core/ViewChild | 2,870 | 0.89 [x] |core/Directive | 2,767 | 0.86 [ ] |router/Routes | 2,331 | 0.72 diff --git a/packages/router/src/directives/router_link.ts b/packages/router/src/directives/router_link.ts index 4a34f4c414..3b732604c4 100644 --- a/packages/router/src/directives/router_link.ts +++ b/packages/router/src/directives/router_link.ts @@ -22,31 +22,59 @@ import {UrlTree} from '../url_tree'; * * Lets you link to specific routes in your app. * + * 让你可以在应用中链接到特定的路由。 + * * Consider the following route configuration: * `[{ path: 'user/:name', component: UserCmp }]`. * When linking to this `user/:name` route, you use the `RouterLink` directive. * + * 考虑下列路由配置: + * `[{ path: 'user/:name', component: UserCmp }]`. + * 如果要链接到这个 `user/:name` 路由,你可以使用 `RouterLink` 指令。 + * * If the link is static, you can use the directive as follows: * `link to user component` * + * 如果该链接是静态的,你可以使用下列指令: + * `链接到 user 组件` + * * If you use dynamic values to generate the link, you can pass an array of path * segments, followed by the params for each segment. * + * 如果你要用动态值来生成该链接,你可以传入一组路径片段,每个片段后面都可以跟一些参数。 + * * For instance `['/team', teamId, 'user', userName, {details: true}]` * means that we want to generate a link to `/team/11/user/bob;details=true`. * + * 比如 `['/team', teamId, 'user', userName, {details: true}]` 表示我们要生成一个到 `/team/11/user/bob;details=true` 的链接。 + * * Multiple static segments can be merged into one * (e.g., `['/team/11/user', userName, {details: true}]`). * + * 多个静态片段可以合并为一个(比如 `['/team/11/user', userName, {details: true}]`)。 + * * The first segment name can be prepended with `/`, `./`, or `../`: + * + * 第一个参数名可以使用 `/`、`./` 或 `../` 前缀: + * * * If the first segment begins with `/`, the router will look up the route from the root of the * app. + * + * 如果第一个片段用 `/` 开头,则路由器会从应用的根路由开始查找。 + * * * If the first segment begins with `./`, or doesn't begin with a slash, the router will * instead look in the children of the current activated route. + * + * 如果第一个片段用 `./` 开头或者没有用斜杠开头,路由器就会从当前激活路由开始查找。 + * * * And if the first segment begins with `../`, the router will go up one level. * + * 如果第一个片段以 `../` 开头,则路由器将会向上找一级。 + * * You can set query params and fragment as follows: * + * 你可以像这样设置查询参数和 `#` 片段: + * * ``` * * link to user component @@ -54,9 +82,13 @@ import {UrlTree} from '../url_tree'; * ``` * RouterLink will use these to generate this link: `/user/bob#education?debug=true`. * + * RouterLink 将会使用它们生成如下链接:`/user/bob#education?debug=true`。 + * * (Deprecated in v4.0.0 use `queryParamsHandling` instead) You can also tell the * directive to preserve the current query params and fragment: * + * (从 v4.0.0 中开始已废弃,请用 `queryParamsHandling` 来代替)你还可以告诉该指令保留当前的查询参数(`?`)和 `#` 片段: + * * ``` * * link to user component @@ -64,13 +96,27 @@ import {UrlTree} from '../url_tree'; * ``` * * You can tell the directive to how to handle queryParams, available options are: + * + * 你可以告诉该指令要如何处理查询参数,有效的选项包括: + * * - `'merge'`: merge the queryParams into the current queryParams + * + * `'merge'`:把老的查询参数合并进新的查询参数中 + * * - `'preserve'`: preserve the current queryParams + * + * `'preserve'`:保持当前的查询参数 + * * - default/`''`: use the queryParams only * + * 默认 / `''`:只使用当前查询参数 + * * Same options for {@link NavigationExtras#queryParamsHandling * NavigationExtras#queryParamsHandling}. * + * 这个选项和 {@link NavigationExtras#queryParamsHandling + * NavigationExtras#queryParamsHandling} 的一样。 + * * ``` * * link to user component @@ -79,13 +125,21 @@ import {UrlTree} from '../url_tree'; * * The router link directive always treats the provided input as a delta to the current url. * + * `RouterLink` 指令总是把新提供的输入看作是对当前 URL 的增量修改。 + * * For instance, if the current url is `/user/(box//aux:team)`. * + * 例如,如果当前 url 是 `/user/(box//aux:team)`, + * * Then the following link `Jim` will generate the link * `/user/(jim//aux:team)`. * + * 那么 `Jim` 生成的链接将是 `/user/(jim//aux:team)`。 + * * See {@link Router#createUrlTree createUrlTree} for more information. * + * 欲知详情,参见 {@link Router#createUrlTree createUrlTree}。 + * * @ngModule RouterModule * * @@ -163,8 +217,12 @@ export class RouterLink { * * Lets you link to specific routes in your app. * + * 允许你在应用中链接到特定的路由。 + * * See `RouterLink` for more information. * + * 欲知详情,参见 `RouterLink`。 + * * @ngModule RouterModule * *