more_horiz
@angular/routercode
RouterModule
NgModule
stable
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.
On this page
API
class RouterModule { static forRoot(routes: Routes, config?: ExtraOptions | undefined): ModuleWithProviders<RouterModule>; static forChild(routes: Routes): ModuleWithProviders<RouterModule>;}
forRoot
ModuleWithProviders<RouterModule>Creates and configures a module with all the router providers and directives. Optionally sets up an application listener to perform an initial navigation.
When registering the NgModule at the root, import as follows:
@NgModule({
imports: [RouterModule.forRoot(ROUTES)]
})
class MyNgModule {}@paramconfig
ExtraOptions | undefinedAn ExtraOptions configuration object that controls how navigation is performed.
@returns
ModuleWithProviders<RouterModule>forChild
ModuleWithProviders<RouterModule>Creates a module with all the router directives and a provider registering routes, without creating a new Router service. When registering for submodules and lazy-loaded submodules, create the NgModule as follows:
@NgModule({
imports: [RouterModule.forChild(ROUTES)]
})
class MyNgModule {}@returns
ModuleWithProviders<RouterModule>Description
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.
You can import this NgModule multiple times, once for each lazy-loaded bundle.
However, only one Router service can be active.
To ensure this, there are two ways to register routes when importing this module:
Jump to details