Router
Provides the navigation and url manipulation capabilities.
Example
Imperative navigation:
export class AppComponent {
constructor(private router: Router) {
}
navigateToHome() {
this.router.navigate('/home');
}
}
Interface
- config
- createUrlTree
- dispose
- errorHandler
- events
- getCurrentNavigation
- initialNavigation
- isActive
- malformedUriErrorHandler
- navigate
- navigateByUrl
- navigated
- onSameUrlNavigation
- paramsInheritanceStrategy
- parseUrl
- relativeLinkResolution
- resetConfig
- routeReuseStrategy
- routerState
- serializeUrl
- setUpLocationChangeListener
- url
- urlHandlingStrategy
- urlUpdateStrategy
config
#
config: Routes
createUrlTree
#
createUrlTree(commands: any[], navigationExtras: NavigationExtras = {}): UrlTree
dispose
#
dispose(): void
errorHandler
#
errorHandler: ErrorHandler
events
#
events: Observable<Event>
getCurrentNavigation
#
getCurrentNavigation(): Navigation|null
initialNavigation
#
initialNavigation(): void
isActive
#
isActive(url: string|UrlTree, exact: boolean): boolean
malformedUriErrorHandler
#
malformedUriErrorHandler: (error: URIError, urlSerializer: UrlSerializer,
url: string) => UrlTree
navigate
#
navigate(commands: any[], extras: NavigationExtras = {skipLocationChange: false}): Promise<boolean>
navigateByUrl
#
navigateByUrl(url: string|UrlTree, extras: NavigationExtras = {skipLocationChange: false}): Promise<boolean>
navigated
#
navigated: boolean
onSameUrlNavigation
#
onSameUrlNavigation: 'reload'|'ignore'
paramsInheritanceStrategy
#
paramsInheritanceStrategy: 'emptyOnly'|'always'
parseUrl
#
parseUrl(url: string): UrlTree
relativeLinkResolution
#
relativeLinkResolution: 'legacy'|'corrected'
resetConfig
#
resetConfig(config: Routes): void
routeReuseStrategy
#
routeReuseStrategy: RouteReuseStrategy
routerState
#
routerState: RouterState
serializeUrl
#
serializeUrl(url: UrlTree): string
setUpLocationChangeListener
#
setUpLocationChangeListener(): void
url
#
get url(): string
urlHandlingStrategy
#
urlHandlingStrategy: UrlHandlingStrategy
urlUpdateStrategy
#
urlUpdateStrategy: 'deferred'|'eager'