docs: fix reference to `routes` array in TOH tutorial (#40023)
The previous tutorial content referred to a `Routes` member of `AppRoutingModule`, which is not correct. Instead there is a `routes` variable that is passed to the `forRoot()` method when configuring the `AppRoutingModule`. Replaces #36583 PR Close #40023
This commit is contained in:
parent
8d30551954
commit
f06a50fc0c
|
@ -48,7 +48,7 @@ Replace it with the following:
|
||||||
<code-example path="toh-pt5/src/app/app-routing.module.1.ts" header="src/app/app-routing.module.ts (updated)">
|
<code-example path="toh-pt5/src/app/app-routing.module.1.ts" header="src/app/app-routing.module.ts (updated)">
|
||||||
</code-example>
|
</code-example>
|
||||||
|
|
||||||
First, `AppRoutingModule` imports `RouterModule` and `Routes` so the app can have routing functionality. The next import, `HeroesComponent`, will give the Router somewhere to go once you configure the routes.
|
First, the `app-routing.module.ts` file imports `RouterModule` and `Routes` so the app can have routing functionality. The next import, `HeroesComponent`, will give the Router somewhere to go once you configure the routes.
|
||||||
|
|
||||||
Notice that the `CommonModule` references and `declarations` array are unnecessary, so are no
|
Notice that the `CommonModule` references and `declarations` array are unnecessary, so are no
|
||||||
longer part of `AppRoutingModule`. The following sections explain the rest of the `AppRoutingModule` in more detail.
|
longer part of `AppRoutingModule`. The following sections explain the rest of the `AppRoutingModule` in more detail.
|
||||||
|
@ -60,7 +60,7 @@ The next part of the file is where you configure your routes.
|
||||||
*Routes* tell the Router which view to display when a user clicks a link or
|
*Routes* tell the Router which view to display when a user clicks a link or
|
||||||
pastes a URL into the browser address bar.
|
pastes a URL into the browser address bar.
|
||||||
|
|
||||||
Since `AppRoutingModule` already imports `HeroesComponent`, you can use it in the `routes` array:
|
Since `app-routing.module.ts` already imports `HeroesComponent`, you can use it in the `routes` array:
|
||||||
|
|
||||||
<code-example path="toh-pt5/src/app/app-routing.module.ts" header="src/app/app-routing.module.ts"
|
<code-example path="toh-pt5/src/app/app-routing.module.ts" header="src/app/app-routing.module.ts"
|
||||||
region="heroes-route">
|
region="heroes-route">
|
||||||
|
@ -216,12 +216,12 @@ This `getHeroes()` returns the sliced list of heroes at positions 1 and 5, retur
|
||||||
|
|
||||||
To navigate to the dashboard, the router needs an appropriate route.
|
To navigate to the dashboard, the router needs an appropriate route.
|
||||||
|
|
||||||
Import the `DashboardComponent` in the `AppRoutingModule`.
|
Import the `DashboardComponent` in the `app-routing-module.ts` file.
|
||||||
|
|
||||||
<code-example path="toh-pt5/src/app/app-routing.module.ts" region="import-dashboard" header="src/app/app-routing.module.ts (import DashboardComponent)">
|
<code-example path="toh-pt5/src/app/app-routing.module.ts" region="import-dashboard" header="src/app/app-routing.module.ts (import DashboardComponent)">
|
||||||
</code-example>
|
</code-example>
|
||||||
|
|
||||||
Add a route to the `AppRoutingModule.routes` array that matches a path to the `DashboardComponent`.
|
Add a route to the `routes` array that matches a path to the `DashboardComponent`.
|
||||||
|
|
||||||
<code-example path="toh-pt5/src/app/app-routing.module.ts" header="src/app/app-routing.module.ts" region="dashboard-route">
|
<code-example path="toh-pt5/src/app/app-routing.module.ts" header="src/app/app-routing.module.ts" region="dashboard-route">
|
||||||
</code-example>
|
</code-example>
|
||||||
|
@ -233,7 +233,7 @@ That doesn't match any existing route so the router doesn't navigate anywhere.
|
||||||
The space below the `<router-outlet>` is blank.
|
The space below the `<router-outlet>` is blank.
|
||||||
|
|
||||||
To make the app navigate to the dashboard automatically, add the following
|
To make the app navigate to the dashboard automatically, add the following
|
||||||
route to the `AppRoutingModule.Routes` array.
|
route to the `routes` array.
|
||||||
|
|
||||||
<code-example path="toh-pt5/src/app/app-routing.module.ts" header="src/app/app-routing.module.ts" region="redirect-route">
|
<code-example path="toh-pt5/src/app/app-routing.module.ts" header="src/app/app-routing.module.ts" region="redirect-route">
|
||||||
</code-example>
|
</code-example>
|
||||||
|
@ -288,12 +288,12 @@ You'll [fix that shortly](#heroes-component-links) after you enable routing to t
|
||||||
|
|
||||||
A URL like `~/detail/11` would be a good URL for navigating to the *Hero Detail* view of the hero whose `id` is `11`.
|
A URL like `~/detail/11` would be a good URL for navigating to the *Hero Detail* view of the hero whose `id` is `11`.
|
||||||
|
|
||||||
Open `AppRoutingModule` and import `HeroDetailComponent`.
|
Open `app-routing.module.ts` and import `HeroDetailComponent`.
|
||||||
|
|
||||||
<code-example path="toh-pt5/src/app/app-routing.module.ts" region="import-herodetail" header="src/app/app-routing.module.ts (import HeroDetailComponent)">
|
<code-example path="toh-pt5/src/app/app-routing.module.ts" region="import-herodetail" header="src/app/app-routing.module.ts (import HeroDetailComponent)">
|
||||||
</code-example>
|
</code-example>
|
||||||
|
|
||||||
Then add a _parameterized_ route to the `AppRoutingModule.routes` array that matches the path pattern to the _hero detail_ view.
|
Then add a _parameterized_ route to the `routes` array that matches the path pattern to the _hero detail_ view.
|
||||||
|
|
||||||
<code-example path="toh-pt5/src/app/app-routing.module.ts" header="src/app/app-routing.module.ts" region="detail-route">
|
<code-example path="toh-pt5/src/app/app-routing.module.ts" header="src/app/app-routing.module.ts" region="detail-route">
|
||||||
</code-example>
|
</code-example>
|
||||||
|
|
Loading…
Reference in New Issue