填写这份《一分钟调查》,帮我们(开发组)做得更好!去填写Home

RouterLink

当应用于模板中的元素时,使该元素成为开始导航到某个路由的链接。导航会在页面上的 <router-outlet> 位置上打开一个或多个路由组件。

When applied to an element in a template, makes that element a link that initiates navigation to a route. Navigation opens one or more routed components in one or more <router-outlet> locations on the page.

查看"说明"...

Exported from

选择器

属性

属性说明
@Input()
queryParams?: Params | null

作为 UrlCreationOptions 的一部分传递给 Router#createUrlTree

Passed to Router#createUrlTree as part of the UrlCreationOptions.

参见:

@Input()
fragment?: string

作为 UrlCreationOptions 的一部分传递给 Router#createUrlTree

Passed to Router#createUrlTree as part of the UrlCreationOptions.

参见:

@Input()
queryParamsHandling?: QueryParamsHandling | null

作为 UrlCreationOptions 的一部分传递给 Router#createUrlTree

Passed to Router#createUrlTree as part of the UrlCreationOptions.

参见:

@Input()
preserveFragment: boolean

作为 UrlCreationOptions 的一部分传递给 Router#createUrlTree

Passed to Router#createUrlTree as part of the UrlCreationOptions.

参见:

@Input()
skipLocationChange: boolean

作为 NavigationBehaviorOptions 的一部分传递给 Router#navigateByUrl

Passed to Router#navigateByUrl as part of the NavigationBehaviorOptions.

参见:

@Input()
replaceUrl: boolean

作为 NavigationBehaviorOptions 的一部分传递给 Router#navigateByUrl

Passed to Router#navigateByUrl as part of the NavigationBehaviorOptions.

参见:

@Input()
state?: { [k: string]: any; }

作为 NavigationBehaviorOptions 的一部分传递给 Router#navigateByUrl

Passed to Router#navigateByUrl as part of the NavigationBehaviorOptions.

参见:

@Input()
relativeTo?: ActivatedRoute | null

Passed to Router#createUrlTree as part of the UrlCreationOptions. Specify a value here when you do not want to use the default value for routerLink, which is the current activated route. Note that a value of undefined here will use the routerLink default.

参见:

@Input()
routerLink: string | any[]
只写

传递给 Router#createUrlTree 的命令。

Commands to pass to Router#createUrlTree.

  • array :传递给 @link Router#createUrlTree Router#createUrlTree} 的命令。

    array: commands to pass to Router#createUrlTree.

    • string :仅包含字符串的命令数组的简写,即 ['/route']

      string: shorthand for array of commands with just the string, i.e. ['/route']

    • null | undefined :空命令数组的简写,即 []

      null|undefined: shorthand for an empty array of commands, i.e. []

参见:

urlTree: UrlTree只读

说明

给定路由配置 [{ path: 'user/:name', component: UserCmp }] ,以下内容将创建一个到该路由的静态链接:<a routerLink="/user/bob">link to user component</a>

Given a route configuration [{ path: 'user/:name', component: UserCmp }], the following creates a static link to the route: <a routerLink="/user/bob">link to user component</a>

你也可以使用动态值来生成链接。对于动态链接,请传递路径段数组,然后传递每个段的参数。例如, ['/team', teamId, 'user', userName, {details: true}] 生成到 /team/11/user/bob;details=true

You can use dynamic values to generate the link. For a dynamic link, pass an array of path segments, followed by the params for each segment. For example, ['/team', teamId, 'user', userName, {details: true}] generates a link to /team/11/user/bob;details=true.

多个静态段可以合并为一个词,并与动态段组合。例如, ['/team/11/user', userName, {details: true}]

Multiple static segments can be merged into one term and combined with dynamic segements. For example, ['/team/11/user', userName, {details: true}]

你提供给链接的输入将被视为当前 URL 的增量。例如,假设当前 URL 是 /user/(box//aux:team)。则链接 <a [routerLink]="['/user/jim']">Jim</a> 会创建 URL /user/(jim//aux:team) 。欲知详情,请参见 createUrlTree

The input that you provide to the link is treated as a delta to the current URL. For instance, suppose the current URL is /user/(box//aux:team). The link <a [routerLink]="['/user/jim']">Jim</a> creates the URL /user/(jim//aux:team). See createUrlTree for more information.

你可以在链接中使用绝对或相对路径、设置查询参数、控制如何处理参数以及保留导航状态的历史记录。

You can use absolute or relative paths in a link, set query parameters, control how parameters are handled, and keep a history of navigation states.

第一段名称可以用 /./../ 开头。

The first segment name can be prepended with /, ./, or ../.

  • 如果第一个片段用 / 开头,则路由器会从应用的根路由开始查找。

    If the first segment begins with /, the router looks up the route from the root of the app.

  • 如果第一个片段用 ./ 开头或者没有用斜杠开头,路由器就会从当前激活路由开始查找。

    If the first segment begins with ./, or doesn't begin with a slash, the router looks in the children of the current activated route.

  • 如果第一段以 ../ 开头,则路由器将去往路由树中的上一层。

    If the first segment begins with ../, the router goes up one level in the route tree.

设置和处理查询参数和片段

Setting and handling query params and fragments

以下链接将查询参数和一个片段添加到所生成的 URL:

The following link adds a query parameter and a fragment to the generated URL:

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

默认情况下,该指令使用给定的查询参数构造新的 URL。该示例生成链接:/user/bob?debug=true#education

By default, the directive constructs the new URL using the given query parameters. The example generates the link: /user/bob?debug=true#education.

你可以通过在链接中使用 queryParamsHandling 选项,来指示该指令以不同的方式处理查询参数。允许的值为:

You can instruct the directive to handle query parameters differently by specifying the queryParamsHandling option in the link. Allowed values are:

  • 'merge' :将给定的 queryParams 合并到当前查询参数中。

    'merge': Merge the given queryParams into the current query params.

  • 'preserve' :保留当前的查询参数。

    'preserve': Preserve the current query params.

例如:

For example:

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

请参阅 UrlCreationOptions#queryParamsHandling

See UrlCreationOptions#queryParamsHandling.

保留导航历史

Preserving navigation history

你可以提供要持久到浏览器的 History.state 属性中的 state 值。例如:

You can provide a state value to be persisted to the browser's History.state property. For example:

      
      <a [routerLink]="['/user/bob']" [state]="{tracingId: 123}">
  link to user component
</a>
    

使用 Router#getCurrentNavigation 来检索保存的导航状态值。例如,要在 NavigationStart 事件中捕获 tracingId

Use Router#getCurrentNavigation to retrieve a saved navigation-state value. For example, to capture the tracingId during the NavigationStart event:

      
      // Get NavigationStart events
router.events.pipe(filter(e => e instanceof NavigationStart)).subscribe(e => {
  const navigation = router.getCurrentNavigation();
  tracingService.trace({id: navigation.extras.state.tracingId});
});