@angular/router

package

Implements the Angular Router service , which enables navigation from one view to the next as users perform application tasks.

Defines the Route object that maps a URL path to a component, and the RouterOutlet directive that you use to place a routed view in a template, as well as a complete API for configuring, querying, and controlling the router state.

Import RouterModule to use the Router service in your app. For more usage information, see the Routing and Navigation guide.

Entry points

Primary

@angular/router Implements the Angular Router service , which enables navigation from one view to the next as users perform application tasks.

Secondary

`@angular/router/testing`
`@angular/router/upgrade`

Primary entry point exports

NgModules

RouterModule Adds router directives and providers.

Classes

`ActivationEnd`	Represents the start of end of the Resolve phase of routing. See note on `ActivationStart` for use of this experimental API.
`ActivationStart`	Represents the start of end of the Resolve phase of routing. See note on `ActivationEnd` for use of this experimental API.
`ChildActivationEnd`	Represents the start of end of the Resolve phase of routing. See note on `ChildActivationStart` for use of this experimental API.
`ChildActivationStart`	Represents the start of end of the Resolve phase of routing. See note on `ChildActivationEnd` for use of this experimental API.
`ChildrenOutletContexts`	Store contextual information about the children (= nested) `RouterOutlet`
`DefaultUrlSerializer`	A default implementation of the `UrlSerializer`.
`GuardsCheckEnd`	Represents the end of the Guard phase of routing.
`GuardsCheckStart`	Represents the start of the Guard phase of routing.
`NavigationCancel`	Represents an event triggered when a navigation is canceled.
`NavigationEnd`	Represents an event triggered when a navigation ends successfully.
`NavigationError`	Represents an event triggered when a navigation fails due to an unexpected error.
`NavigationStart`	Represents an event triggered when a navigation starts.
`NoPreloading`	Provides a preloading strategy that does not preload any modules.
`OutletContext`	Store contextual information about a `RouterOutlet`
`PreloadAllModules`	Provides a preloading strategy that preloads all modules as quickly as possible.
`PreloadingStrategy`	Provides a preloading strategy.
`ResolveEnd`	Represents the end of the Resolve phase of routing. See note on `ResolveStart` for use of this experimental API.
`ResolveStart`	Represents the start of the Resolve phase of routing. The timing of this event may change, thus it's experimental. In the current iteration it will run in the "resolve" phase whether there's things to resolve or not. In the future this behavior may change to only run when there are things to be resolved.
`RouteConfigLoadEnd`	Represents an event triggered when a route has been lazy loaded.
`RouteConfigLoadStart`	Represents an event triggered before lazy loading a route config.
`RouteReuseStrategy`	Provides a way to customize when activated routes get reused.
`Router`	An NgModule that provides navigation and URL manipulation capabilities.
`RouterEvent`	Base for events the Router goes through, as opposed to events tied to a specific Route. `RouterEvent`s will only be fired one time for any given navigation.
`RouterPreloader`	The preloader optimistically loads all router configurations to make navigations into lazily-loaded sections of the application faster.
`RoutesRecognized`	Represents an event triggered when routes are recognized.
`Scroll`	Represents a scrolling event.
`UrlHandlingStrategy`	Provides a way to migrate AngularJS applications to Angular.
`UrlSegment`	Represents a single URL segment.
`UrlSegmentGroup`	Represents the parsed URL segment group.
`UrlSerializer`	Serializes and deserializes a URL string into a URL tree.

Functions

`convertToParamMap`	Convert a `Params` instance to a `ParamMap`.
`provideRoutes`	Registers routes.

Structures

`ActivatedRoute`	Contains the information about a route associated with a component loaded in an outlet. An `ActivatedRoute` can also be used to traverse the router state tree.
`ActivatedRouteSnapshot`	Contains the information about a route associated with a component loaded in an outlet at a particular moment in time. ActivatedRouteSnapshot can also be used to traverse the router state tree.
`CanActivate`	Interface that a class can implement to be a guard deciding if a route can be activated. If all guards return `true`, navigation will continue. If any guard returns `false`, navigation will be cancelled. If any guard returns a `UrlTree`, current navigation will be cancelled and a new navigation will be kicked off to the `UrlTree` returned from the guard.
`CanActivateChild`	Interface that a class can implement to be a guard deciding if a child route can be activated. If all guards return `true`, navigation will continue. If any guard returns `false`, navigation will be cancelled. If any guard returns a `UrlTree`, current navigation will be cancelled and a new navigation will be kicked off to the `UrlTree` returned from the guard.
`CanDeactivate`	Interface that a class can implement to be a guard deciding if a route can be deactivated. If all guards return `true`, navigation will continue. If any guard returns `false`, navigation will be cancelled. If any guard returns a `UrlTree`, current navigation will be cancelled and a new navigation will be kicked off to the `UrlTree` returned from the guard.
`CanLoad`	Interface that a class can implement to be a guard deciding if children can be loaded.
`ExtraOptions`	Represents options to configure the router.
`NavigationExtras`	Options that modify the navigation strategy.
`ParamMap`	Matrix and Query parameters.
`Resolve`	Interface that classes can implement to be a data provider.
`Route`	A configuration object that defines a single route. A set of routes are collected in a `Routes` array to define a `Router` configuration. The router attempts to match segments of a given URL against each route, using the configuration options defined in this object.
`RouterState`	Represents the state of the router.
`RouterStateSnapshot`	Represents the state of the router at a moment in time.
`UrlTree`	Represents the parsed URL.

Directives

`RouterLink`	Lets you link to specific routes in your app.
`RouterLinkActive`	Lets you add a CSS class to an element when the link's route becomes active.
`RouterLinkWithHref`	Lets you link to specific routes in your app.
`RouterOutlet`	Acts as a placeholder that Angular dynamically fills based on the current router state.

Types

`Data`	Represents static data associated with a particular route.
`DetachedRouteHandle`	Represents the detached route tree.
`Event`	Represents a router event, allowing you to track the lifecycle of the router.
`LoadChildren`	A string of the form `path/to/file#exportName` that acts as a URL for a set of routes to load, or a function that returns such a set.
`LoadChildrenCallback`	A function that is called to resolve a collection of lazy-loaded routes.
`Navigation`	Information about any given navigation. This information can be gotten from the router at any time using the `router.getCurrentNavigation()` method.
`PRIMARY_OUTLET`	Name of the primary outlet.
`Params`	A collection of parameters.
`ROUTER_CONFIGURATION`	Is used in DI to configure the router.
`ROUTER_INITIALIZER`	A token for the router initializer that will be called after the app is bootstrapped.
`ROUTES`
`ResolveData`	Represents the resolved data associated with a particular route.
`Routes`	Represents a route configuration for the Router service. An array of `Route` objects, used in `Router.config` and for nested route configurations in `Route.children`.
`RunGuardsAndResolvers`	A policy for when to run guards and resolvers on a route.
`UrlMatchResult`	Represents the result of matching URLs with a custom matching function.
`UrlMatcher`	A function for matching a route against URLs. Implement a custom URL matcher for `Route.matcher` when a combination of `path` and `pathMatch` is not expressive enough.