Lets you link to specific routes in your app.


See more...




queryParams: { [k: string]: any; }
fragment: string
queryParamsHandling: QueryParamsHandling
preserveFragment: boolean
skipLocationChange: boolean
replaceUrl: boolean
routerLink: any[] | string
preserveQueryParams: boolean
urlTree: UrlTree 只读


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: <a routerLink="/user/bob">link to user component</a>

如果该链接是静态的,你可以使用下列指令: <a routerLink="/user/bob">链接到 user 组件</a>

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:

你可以像这样设置查询参数和 # 片段:

<a [routerLink]="['/user/bob']" [queryParams]="{debug: true}" fragment="education"> link to user component </a>

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 来代替)你还可以告诉该指令保留当前的查询参数(?)和 # 片段:

<a [routerLink]="['/user/bob']" preserveQueryParams preserveFragment> link to user component </a>

You can tell the directive to how to handle queryParams, available options are:


  • 'merge': merge the queryParams into the current queryParams


  • 'preserve': preserve the current queryParams


  • default/'': use the queryParams only

    默认 / '':只使用当前查询参数

Same options for NavigationExtras#queryParamsHandling.

这个选项和 NavigationExtras#queryParamsHandling 的一样。

<a [routerLink]="['/user/bob']" [queryParams]="{debug: true}" queryParamsHandling="merge"> link to user component </a>

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 <a [routerLink]="['/user/jim']">Jim</a> will generate the link /user/(jim//aux:team).

那么 <a [routerLink]="['/user/jim']">Jim</a> 生成的链接将是 /user/(jim//aux:team)

See createUrlTree for more information.

欲知详情,参见 createUrlTree


onClick(): boolean