The RouterLink directive lets you link to specific parts of your app.

Consider the following route configuration:

@RouteConfig([
  { path: '/user', component: UserCmp, as: 'User' }
]);
class MyComp {}

When linking to this User route, you can write:

<a [routerLink]="['./User']">link to user component</a>

RouterLink expects the value to be an array of route names, followed by the params for that level of routing. For instance ['/Team', {teamId: 1}, 'User', {userId: 2}] means that we want to generate a link for the Team route with params {teamId: 1}, and with a child route User with params {userId: 2}.

The first route name should be prepended with /, ./, or ../. If the route begins with /, the router will look up the route from the root of the app. If the route begins with ./, the router will instead look in the current component's children for the route. And if the route begins with ../, the router will look at the current component's parent.

Annotations
  • Directive(selector: "[routerLink]", inputs: const ["routeParams: routerLink", "target: target"], host: const {"(click)" : "onClick()", "[attr.href]" : "visibleHref", "[class.router-link-active]" : "isRouteActive"})

Constructors

Properties

hashCode → int

Get a hash code for this object.

read-only, inherited
isRouteActive → bool

read-only
routeParams → List

write-only
runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited
target → String

read / write
visibleHref → String

read / write

Operators

operator ==(other) → bool

The equality operator.

inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
onClick() → bool

toString() → String

Returns a string representation of this object.

inherited