W3cubDocs

/Angular

@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

Supplies a testing module for the Angular Router subsystem.

@angular/router/upgrade

Provides support for upgrading routing applications from Angular JS to Angular.

Primary entry point exports

NgModules

RouterModule

Adds directives and providers for in-app navigation among views defined in an application. Use the Angular Router service to declaratively specify application states and manage state transitions.

Classes

ActivationEnd

An event triggered at the end of the activation part of the Resolve phase of routing.

ActivationStart

An event triggered at the start of the activation part of the Resolve phase of routing.

BaseRouteReuseStrategy

This base route reuse strategy only reuses routes when the matched router configs are identical. This prevents components from being destroyed and recreated when just the fragment or query parameters change (that is, the existing component is reused).

ChildActivationEnd

An event triggered at the end of the child-activation part of the Resolve phase of routing.

ChildActivationStart

An event triggered at the start of the child-activation part of the Resolve phase of routing.

ChildrenOutletContexts

Store contextual information about the children (= nested) RouterOutlet

DefaultUrlSerializer

A default implementation of the UrlSerializer.

GuardsCheckEnd

An event triggered at the end of the Guard phase of routing.

GuardsCheckStart

An event triggered at the start of the Guard phase of routing.

NavigationCancel

An event triggered when a navigation is canceled, directly or indirectly. This can happen when a route guard returns false or initiates a redirect by returning a UrlTree.

NavigationEnd

An event triggered when a navigation ends successfully.

NavigationError

An event triggered when a navigation fails due to an unexpected error.

NavigationStart

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

An event triggered at the end of the Resolve phase of routing.

ResolveStart

An event triggered at the the start of the Resolve phase of routing.

RouteConfigLoadEnd

An event triggered when a route has been lazy loaded.

RouteConfigLoadStart

An event triggered before lazy loading a route configuration.

RouteReuseStrategy

Provides a way to customize when activated routes get reused.

Router

A service that provides navigation among views and URL manipulation capabilities.

RouterEvent

Base for events the router goes through, as opposed to events tied to a specific route. 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

An event triggered when routes are recognized.

Scroll

An event triggered by scrolling.

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

Converts a Params instance to a ParamMap.

provideRoutes

Registers a DI provider for a set of routes.

Structures

ActivatedRoute

Provides access to information about a route associated with a component that is loaded in an outlet. Use to traverse the RouterState tree and extract information from nodes.

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 continues. If any guard returns false, navigation is cancelled. If any guard returns a UrlTree, the current navigation is cancelled and a new navigation begins 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 continues. If any guard returns false, navigation is cancelled. If any guard returns a UrlTree, current navigation is cancelled and a new navigation begins 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 continues. If any guard returns false, navigation is cancelled. If any guard returns a UrlTree, current navigation is cancelled and a new navigation begins to the UrlTree returned from the guard.

CanLoad

Interface that a class can implement to be a guard deciding if children can be loaded. If all guards return true, navigation continues. If any guard returns false, navigation is cancelled. If any guard returns a UrlTree, current navigation is cancelled and a new navigation starts to the UrlTree returned from the guard.

ExtraOptions

A set of configuration options for a router module, provided in the forRoot() method.

NavigationBehaviorOptions

Options that modify the Router navigation strategy. Supply an object containing any of these properties to a Router navigation function to control how the navigation should be handled.

NavigationExtras

Options that modify the Router navigation strategy. Supply an object containing any of these properties to a Router navigation function to control how the target URL should be constructed or interpreted.

ParamMap

A map that provides access to the required and optional parameters specific to a route. The map supports retrieving a single value with get() or multiple values with getAll().

Resolve

Interface that classes can implement to be a data provider. A data provider class can be used with the router to resolve data during navigation. The interface defines a resolve() method that is invoked when the navigation starts. The router waits for the data to be resolved before the route is finally activated.

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 as a tree of activated routes.

RouterStateSnapshot

Represents the state of the router at a moment in time.

UrlCreationOptions

Options that modify the Router URL. Supply an object containing any of these properties to a Router navigation function to control how the target URL should be constructed.

UrlTree

Represents the parsed URL.

Directives

RouterLink

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.

RouterLinkActive

Tracks whether the linked route of an element is currently active, and allows you to specify one or more CSS classes to add to the element when the linked route is 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.

DeprecatedLoadChildren

Deprecated: The string form of loadChildren is deprecated in favor of the LoadChildrenCallback function which uses the ES dynamic import() expression. This offers a more natural and standards-based mechanism to dynamically load an ES module at runtime.

A string of the form path/to/file#exportName that acts as a URL for a set of routes to load.

DetachedRouteHandle

Represents the detached route tree.

Event

Router events that allow you to track the lifecycle of the router.

InitialNavigation

Allowed values in an ExtraOptions object that configure when the router performs the initial navigation operation.

LoadChildren

A function that returns a set of routes to load.

LoadChildrenCallback

A function that is called to resolve a collection of lazy-loaded routes. Must be an arrow function of the following form: () => import('...').then(mod => mod.MODULE)

Navigation

Information about a navigation operation. Retrieve the most recent navigation object with the Router.getCurrentNavigation() method .

PRIMARY_OUTLET

The primary routing outlet.

Params

A collection of matrix and query URL parameters.

QueryParamsHandling

How to handle query parameters in a router link. One of:

  • merge : Merge new with current parameters.
  • preserve : Preserve current parameters.
ROUTER_CONFIGURATION

A DI token for the router service.

ROUTER_INITIALIZER

A DI token for the router initializer that is called after the app is bootstrapped.

ROUTES

The DI token for a router configuration.

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. Cannot be used together with path and pathMatch.

© 2010–2020 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://angular.io/api/router