From e71d151571f8e3012c1a099d753abd33326dec54 Mon Sep 17 00:00:00 2001 From: Kapunahele Wong Date: Thu, 19 Sep 2019 16:30:33 -0400 Subject: [PATCH] docs: edit copy of getting started step 2 (#32776) PR Close #32776 --- aio/content/start/routing.md | 85 ++++++++++++++---------------------- 1 file changed, 33 insertions(+), 52 deletions(-) diff --git a/aio/content/start/routing.md b/aio/content/start/routing.md index 3d958d2399..195040b765 100644 --- a/aio/content/start/routing.md +++ b/aio/content/start/routing.md @@ -1,112 +1,94 @@ # Routing -At the end of [Your First App](start "Getting Started: Your First App"), the online store application has a basic product catalog. -The app doesn't have any variable states or navigation. -There is one URL, and that URL always displays the "My Store" page with a list of products and their descriptions. +At the end of [Your First App](start "Getting Started: Your First App"), the online store application has a basic product catalog. +The app doesn't have any variable states or navigation. +There is one URL, and that URL always displays the "My Store" page with a list of products and their descriptions. -In this section, you'll extend the app to display full product details in separate pages, with their own URLs. +This guide shows you how to use the Angular Router to display full product details in separate pages, each with their own URLs. -To do this, you'll use the Angular *router*. -The Angular [router](guide/glossary#router "router definition") enables you to show different components and data to the user based on where the user is in the application. -The router enables navigation from one view to the next as users perform application tasks: +The Angular [Router](guide/glossary#router "Router definition") enables you to show different components and data to the user based on where the user is in the application. +The router enables navigation from one view to the next as users perform tasks such as the following: -* Enter a URL in the address bar, and the browser navigates to a corresponding page. -* Click links on the page, and the browser navigates to a new page. -* Click the browser's back and forward buttons, and the browser navigates backward and forward through the history of pages you've seen. +* Entering a URL in the address bar to navigate to a corresponding page. +* Clicking links on the page to navigate to a new page. +* Clicking the browser's back and forward buttons to navigate backward and forward through the browser history. ## Registering a route -The app is already set up to use the Angular router and to use routing to navigate to the product list component you modified earlier. Let's define a route to show individual product details. +The app is already set up to use the Angular Router and to use routing to navigate to the product list component you modified earlier. This section shows you how to define a route to show individual product details. 1. Generate a new component for product details. Give the component the name `product-details`. - Reminder: In the file list, right-click the `app` folder, choose `Angular Generator` and `Component`. + Reminder: In the file list, right-click the `app` folder, choose `Angular Generator` and `Component`. 1. In `app.module.ts`, add a route for product details, with a `path` of `products/:productId` and `ProductDetailsComponent` for the `component`. - + A route associates one or more URL paths with a component. -1. Define a link using the `RouterLink` directive. The `routerLink` defines how the user navigates to the route (or URL) declaratively - in the component template. - - We want the user to click a product name to display the details for that product. +1. The directive configures the component template to define how the user navigates to the route or URL. When the user clicks a product name, the app displays the details for that product. 1. Open `product-list.component.html`. 1. Update the `*ngFor` directive to assign each index in the `products` array to the `productId` variable when iterating over the list. - + 1. Modify the product name anchor to include a `routerLink`. - + The RouterLink directive gives the router control over the anchor element. In this case, the route, or URL, contains one fixed segment, `/products`, while the final segment is variable, inserting the id property of the current product. For example, the URL for a product with an `id` of 1 will be similar to `https://getting-started-myfork.stackblitz.io/products/1`. - The RouterLink directive gives the router control over the anchor element. In this case, the route (URL) contains one fixed segment (`/products`) and the final segment is variable, inserting the id property of the current product. For example, the URL for a product with an `id` of 1 will be similar to `https://getting-started-myfork.stackblitz.io/products/1`. +1. Test the router by clicking a product name. The app displays the product details component, which currently always says "product-details works!" -1. Test the router by clicking a product name. The app displays the product details component, which currently always says "product-details works!" (We'll fix this in the next section.) - - Notice that the URL in the preview window changes. The final segment is `products/1`. + Notice that the URL in the preview window changes. The final segment is `products/#` where `#` is the number of the route you clicked.
Product details page with updated URL
- + ## Using route information -The product details component handles the display of each product. The Angular Router displays components based on the browser's URL and your defined routes. You'll use the Angular Router to combine the `products` data and route information to display the specific details for each product. +The product details component handles the display of each product. The Angular Router displays components based on the browser's URL and your defined routes. This section shows you how to use the Angular Router to combine the `products` data and route information to display the specific details for each product. 1. Open `product-details.component.ts` -1. Arrange to use product data from an external file. +1. Arrange to use product data from an external file. 1. Import `ActivatedRoute` from the `@angular/router` package, and the `products` array from `../products`. - 1. Define the `product` property and inject the `ActivatedRoute` into the constructor. + 1. Define the `product` property and inject the `ActivatedRoute` into the constructor by adding it as an argument within the constructor's parentheses. - The `ActivatedRoute` is specific to each routed component loaded by the Angular Router. It contains information about the + The `ActivatedRoute` is specific to each routed component that the Angular Router loads. It contains information about the route, its parameters, and additional data associated with the route. - + By injecting the `ActivatedRoute`, you are configuring the component to use a service. While this part of the Getting Started tutorial uses this syntax briefly, the [Managing Data](start/data "Getting Started: Managing Data") page covers services in more detail. -1. In the `ngOnInit()` method, _subscribe_ to route params and fetch the product based on the `productId`. - +1. In the `ngOnInit()` method, subscribe to route parameters and fetch the product based on the `productId`. + + - Angular calls `ngOnInit()` shortly after creating a component. - - The route parameters correspond to the path variables defined in the route. The `productId` is provided from - the URL that was matched to the route. You use the `productId` to display the details for each unique product. - -
- - For more information on `ngOnInit()`, see [Lifecycle hooks](guide/lifecycle-hooks). - -
+ The route parameters correspond to the path variables you define in the route. The URL that matches the route provides the `productId`. Angular uses the `productId` to display the details for each unique product. 1. Update the template to display product details information inside an `*ngIf`. -Now, when the user clicks on a name in the product list, the router navigates you to the distinct URL for the product, swaps out the product list component for the product details component, and displays the product details. +Now, when users click on a name in the product list, the router navigates them to the distinct URL for the product, swaps out the product list component for the product details component, and displays the product details.
Product details page with updated URL and full details displayed @@ -116,7 +98,7 @@ Now, when the user clicks on a name in the product list, the router navigates yo
-Learn more: See [Routing & Navigation](guide/router "Routing & Navigation") for more information about the Angular router. +For more information about the Angular Router, see [Routing & Navigation](guide/router "Routing & Navigation").
@@ -125,10 +107,9 @@ Learn more: See [Routing & Navigation](guide/router "Routing & Navigation") for Congratulations! You have integrated routing into your online store. -* Products are linked from the product list page to individual products -* Users can click on a product name from the list to see details in a new view, with a distinct URL (route) +* Products are linked from the product list page to individual products. +* Users can click on a product name from the list to see details in a new view, with a distinct URL/route. To continue exploring Angular, choose either of the following options: -* [Continue to the "Managing Data" section](start/data "Getting Started: Managing Data") to add the shopping cart feature, using a service to manage the cart data and using HTTP to retrieve external data for shipping prices. -* [Skip ahead to the Deployment section](start/deployment "Getting Started: Deployment") to deploy your app to Firebase or move to local development. - +* [Continue to the "Managing Data" section](start/data "Getting Started: Managing Data") to add a shopping cart feature, use a service to manage the cart data and use HTTP to retrieve external data for shipping prices. +* [Skip ahead to the Deployment section](start/deployment "Getting Started: Deployment") to deploy your app to Firebase or move to local development.