class
A service that provides navigation among views and URL manipulation capabilities.
class Router { constructor(rootComponentType: Type<any>, urlSerializer: UrlSerializer, rootContexts: ChildrenOutletContexts, location: Location, injector: Injector, loader: NgModuleFactoryLoader, compiler: Compiler, config: Routes) events: Observable<Event> routerState: RouterState errorHandler: ErrorHandler malformedUriErrorHandler: (error: URIError, urlSerializer: UrlSerializer, url: string) => UrlTree navigated: boolean urlHandlingStrategy: UrlHandlingStrategy routeReuseStrategy: RouteReuseStrategy onSameUrlNavigation: 'reload' | 'ignore' paramsInheritanceStrategy: 'emptyOnly' | 'always' urlUpdateStrategy: 'deferred' | 'eager' relativeLinkResolution: 'legacy' | 'corrected' config: Routes url: string initialNavigation(): void setUpLocationChangeListener(): void getCurrentNavigation(): Navigation | null resetConfig(config: Routes): void dispose(): void createUrlTree(commands: any[], navigationExtras: NavigationExtras = {}): UrlTree navigateByUrl(url: string | UrlTree, extras: NavigationExtras = { skipLocationChange: false }): Promise<boolean> navigate(commands: any[], extras: NavigationExtras = { skipLocationChange: false }): Promise<boolean> serializeUrl(url: UrlTree): string parseUrl(url: string): UrlTree isActive(url: string | UrlTree, exact: boolean): boolean }
Creates the router service. | ||||||||||||||||||||||||
|
rootComponentType | Type | |
urlSerializer | UrlSerializer | |
rootContexts | ChildrenOutletContexts | |
location | Location | |
injector | Injector | |
loader | NgModuleFactoryLoader | |
compiler | Compiler | |
config | Routes |
Property | Description |
---|---|
events: Observable<Event> |
Read-Only An event stream for routing events in this NgModule. |
routerState: RouterState |
Read-Only The current state of routing in this NgModule. |
errorHandler: ErrorHandler | A handler for navigation errors in this NgModule. |
malformedUriErrorHandler: (error: URIError, urlSerializer: UrlSerializer, url: string) => UrlTree | A handler for errors thrown by |
navigated: boolean | True if at least one navigation event has occurred, false otherwise. |
urlHandlingStrategy: UrlHandlingStrategy | A strategy for extracting and merging URLs. Used for AngularJS to Angular migrations. |
routeReuseStrategy: RouteReuseStrategy | A strategy for re-using routes. |
onSameUrlNavigation: 'reload' | 'ignore' | How to handle a navigation request to the current URL. One of:
|
paramsInheritanceStrategy: 'emptyOnly' | 'always' | How to merge parameters, data, and resolved data from parent to child routes. One of:
|
urlUpdateStrategy: 'deferred' | 'eager' | Determines when the router updates the browser URL. By default ( |
relativeLinkResolution: 'legacy' | 'corrected' | Enables a bug fix that corrects relative link resolution in components with empty paths. See also: |
config: Routes | Declared in Constructor |
url: string |
Read-Only The current URL. |
|
---|
Sets up the location change listener and performs the initial navigation. |
|
setUpLocationChangeListener() |
---|
Sets up the location change listener. This listener detects navigations triggered from outside the Router (the browser back/forward buttons, for example) and schedules a corresponding Router navigation so that the correct events, guards, etc. are triggered. |
|
|
---|
The current Navigation object if one exists |
|
resetConfig() | |||
---|---|---|---|
Resets the route configuration used for navigation and generating links. | |||
|
config | Routes | The route array for the new configuration. |
void
router.resetConfig([ { path: 'team/:id', component: TeamCmp, children: [ { path: 'simple', component: SimpleCmp }, { path: 'user/:name', component: UserCmp } ]} ]);
dispose() |
---|
Disposes of the router. |
|
createUrlTree() | ||||||
---|---|---|---|---|---|---|
Appends URL segments to the current URL tree to create a new URL tree. | ||||||
|
commands | any[] | An array of URL fragments with which to construct the new URL tree. If the path is static, can be the literal URL string. For a dynamic path, pass an array of path segments, followed by the parameters for each segment. The fragments are applied to the current URL tree or the one provided in the |
navigationExtras | NavigationExtras | Options that control the navigation strategy. This function only uses properties in Optional. Default is |
UrlTree
: The new URL tree.
// create /team/33/user/11 router.createUrlTree(['/team', 33, 'user', 11]); // create /team/33;expand=true/user/11 router.createUrlTree(['/team', 33, {expand: true}, 'user', 11]); // you can collapse static segments like this (this works only with the first passed-in value): router.createUrlTree(['/team/33/user', userId]); // If the first segment can contain slashes, and you do not want the router to split it, // you can do the following: router.createUrlTree([{segmentPath: '/one/two'}]); // create /team/33/(user/11//right:chat) router.createUrlTree(['/team', 33, {outlets: {primary: 'user/11', right: 'chat'}}]); // remove the right secondary node router.createUrlTree(['/team', 33, {outlets: {primary: 'user/11', right: null}}]); // assuming the current url is `/team/33/user/11` and the route points to `user/11` // navigate to /team/33/user/11/details router.createUrlTree(['details'], {relativeTo: route}); // navigate to /team/33/user/22 router.createUrlTree(['../22'], {relativeTo: route}); // navigate to /team/44/user/22 router.createUrlTree(['../../team/44/user/22'], {relativeTo: route});
| ||||||
---|---|---|---|---|---|---|
Navigates to a view using an absolute route path. See also: | ||||||
|
url | string | UrlTree | An absolute path for a defined route. The function does not apply any delta to the current URL. |
extras | NavigationExtras | An object containing properties that modify the navigation strategy. The function ignores any properties in the Optional. Default is |
Promise<boolean>
: A Promise that resolves to 'true' when navigation succeeds, to 'false' when navigation fails, or is rejected on error.
The following calls request navigation to an absolute path.
router.navigateByUrl("/team/33/user/11"); // Navigate without updating the URL router.navigateByUrl("/team/33/user/11", { skipLocationChange: true });
| ||||||
---|---|---|---|---|---|---|
Navigate based on the provided array of commands and a starting point. If no starting route is provided, the navigation is absolute. See also: | ||||||
|
commands | any[] | An array of URL fragments with which to construct the target URL. If the path is static, can be the literal URL string. For a dynamic path, pass an array of path segments, followed by the parameters for each segment. The fragments are applied to the current URL or the one provided in the |
extras | NavigationExtras | An options object that determines how the URL should be constructed or interpreted. Optional. Default is |
Promise<boolean>
: A Promise that resolves to true
when navigation succeeds, to false
when navigation fails, or is rejected on error.
The following calls request navigation to a dynamic route path relative to the current URL.
router.navigate(['team', 33, 'user', 11], {relativeTo: route}); // Navigate without updating the URL, overriding the default behavior router.navigate(['team', 33, 'user', 11], {relativeTo: route, skipLocationChange: true});
serializeUrl() |
---|
Serializes a |
parseUrl() |
---|
Parses a string into a |
isActive() | ||||||
---|---|---|---|---|---|---|
Returns whether the url is activated | ||||||
|
url | string | UrlTree | |
exact | boolean |
boolean
© 2010–2020 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v10.angular.io/api/router/Router