angular/aio/content/guide/router-tutorial.md

# Using Angular routes in a single-page application

This tutorial describes how to build a single-page application, SPA that uses multiple Angular routes.

In a Single Page Application \(SPA\), all of your application's functions exist in a single HTML page.
As users access your application's features, the browser needs to render only the parts that matter to the user, instead of loading a new page.
This pattern can significantly improve your application's user experience.

To define how users navigate through your application, you use routes.
Add routes to define how users navigate from one part of your application to another.
You can also configure routes to guard against unexpected or unauthorized behavior.

To explore a sample application featuring the contents of this tutorial, see the <live-example></live-example>.

## Objectives

*   Organize a sample application's features into modules.
*   Define how to navigate to a component.
*   Pass information to a component using a parameter.
*   Structure routes by nesting several routes.
*   Check whether users can access a route.
*   Control whether the application can discard unsaved changes.
*   Improve performance by pre-fetching route data and lazy loading feature modules.
*   Require specific criteria to load components.

## Prerequisites

To complete this tutorial, you should have a basic understanding of the following concepts:

*   JavaScript
*   HTML
*   CSS
*   [Angular CLI](cli)

You might find the [Tour of Heroes tutorial](tutorial/tour-of-heroes) helpful, but it is not required.

## Create a sample application

Using the Angular CLI, create a new application, *angular-router-sample*.
This application will have two components: *crisis-list* and *heroes-list*.

1.  Create a new Angular project, *angular-router-sample*.

    <code-example format="shell" language="shell">

    ng new angular-router-sample

    </code-example>

    When prompted with `Would you like to add Angular routing?`, select `N`.

    When prompted with `Which stylesheet format would you like to use?`, select `CSS`.

    After a few moments, a new project, `angular-router-sample`, is ready.

1.  From your terminal, navigate to the `angular-router-sample` directory.
1.  Create a component, *crisis-list*.

    <code-example format="shell" language="shell">

    ng generate component crisis-list

    </code-example>

1.  In your code editor, locate the file, `crisis-list.component.html` and replace the placeholder content with the following HTML.

    <code-example header="src/app/crisis-list/crisis-list.component.html" path="router-tutorial/src/app/crisis-list/crisis-list.component.html"></code-example>

1.  Create a second component, *heroes-list*.

    <code-example format="shell" language="shell">

    ng generate component heroes-list

    </code-example>

1.  In your code editor, locate the file, `heroes-list.component.html` and replace the placeholder content with the following HTML.

    <code-example header="src/app/heroes-list/heroes-list.component.html" path="router-tutorial/src/app/heroes-list/heroes-list.component.html"></code-example>

1.  In your code editor, open the file, `app.component.html` and replace its contents with the following HTML.

    <code-example header="src/app/app.component.html" path="router-tutorial/src/app/app.component.html" region="setup"></code-example>

1.  Verify that your new application runs as expected by running the `ng serve` command.

    <code-example format="shell" language="shell">

    ng serve

    </code-example>

1.  Open a browser to `http://localhost:4200`.

    You should see a single web page, consisting of a title and the HTML of your two components.

## Define your routes

In this section, you'll define two routes:

*   The route `/crisis-center` opens the `crisis-center` component.
*   The route `/heroes-list` opens the `heroes-list` component.

A route definition is a JavaScript object.
Each route typically has two properties.
The first property, `path`, is a string that specifies the URL path for the route.
The second property, `component`, is a string that specifies what component your application should display for that path.

1. From your code editor, create and open the `app.routes.ts` file.
1. Create and export a routes list for your application:

```
import {Routes} from '@angular/router';

export const routes = [];
```
1. Add two routes for your first two components:

```
  {path: 'crisis-list', component: CrisisListComponent},
  {path: 'heroes-list', component: HeroesListComponent},
```

This routes list is an array of JavaScript objects, with each object defining the properties of a route.

## Import `provideRouter` from `@angular/router`

Routing lets you display specific views of your application depending on the URL path.
To add this functionality to your sample application, you need to update the `app.config.ts` file to use the router providers function, `provideRouter`.
You import this provider function from `@angular/router`.

1.  From your code editor, open the `app.config.ts` file.
1.  Add the following import statements:

```
import { provideRouter } from '@angular/router';
import { routes } from './app.routes';
```

2. Update the providers in the `appConfig`:

```
providers: [provideRouter(routes)]
```

For `NgModule` based applications, put the `provideRouter` in the `providers` list of the `AppModule`, or whichever module is passed to `bootstrapModule` in the application.


## Update your component with `router-outlet`

At this point, you have defined two routes for your application.
However, your application still has both the `crisis-list` and `heroes-list` components hard-coded in your `app.component.html` template.
For your routes to work, you need to update your template to dynamically load a component based on the URL path.

To implement this functionality, you add the `router-outlet` directive to your template file.

1.  From your code editor, open the `app.component.html` file.
1.  Delete the following lines.

    <code-example header="src/app/app.component.html" path="router-tutorial/src/app/app.component.html" region="components"></code-example>

1.  Add the `router-outlet` directive.

    <code-example header="src/app/app.component.html" path="router-tutorial/src/app/app.component.html" region="router-outlet"></code-example>

1. Add `RouterOutlet` to the imports of the `AppComponent` in `app.component.ts`

```
imports: [RouterOutlet],
```

View your updated application in your browser.
You should see only the application title.
To view the `crisis-list` component, add `crisis-list` to the end of the path in your browser's address bar.
For example:

<code-example format="https" language="https">

http://localhost:4200/crisis-list

</code-example>

Notice that the `crisis-list` component displays.
Angular is using the route you defined to dynamically load the component.
You can load the `heroes-list` component the same way:

<code-example format="https" language="https">

http://localhost:4200/heroes-list

</code-example>

## Control navigation with UI elements

Currently, your application supports two routes.
However, the only way to use those routes is for the user to manually type the path in the browser's address bar.
In this section, you'll add two links that users can click to navigate between the `heroes-list` and `crisis-list` components.
You'll also add some CSS styles.
While these styles are not required, they make it easier to identify the link for the currently-displayed component.
You'll add that functionality in the next section.

1.  Open the `app.component.html` file and add the following HTML below the title.

    <code-example header="src/app/app.component.html" path="router-tutorial/src/app/app.component.html" region="nav"></code-example>

    This HTML uses an Angular directive, `routerLink`.
    This directive connects the routes you defined to your template files.

1. Add the `RouterLink` directive to the imports list of `AppComponent` in `app.component.ts`.

1.  Open the `app.component.css` file and add the following styles.

    <code-example header="src/app/app.component.css" path="router-tutorial/src/app/app.component.css"></code-example>

If you view your application in the browser, you should see these two links.
When you click on a link, the corresponding component appears.

## Identify the active route

While users can navigate your application using the links you added in the previous section, they don't have a straightforward way to identify what the active route is.
Add this functionality using Angular's `routerLinkActive` directive.

1.  From your code editor, open the `app.component.html` file.
1.  Update the anchor tags to include the `routerLinkActive` directive.

    <code-example header="src/app/app.component.html" path="router-tutorial/src/app/app.component.html" region="routeractivelink"></code-example>
1. Add the `RouterLinkActive` directive to the `imports` list of `AppComponent` in `app.component.ts`.

View your application again.
As you click one of the buttons, the style for that button updates automatically, identifying the active component to the user.
By adding the `routerLinkActive` directive, you inform your application to apply a specific CSS class to the active route.
In this tutorial, that CSS class is `activebutton`, but you could use any class that you want.

Note that we are also specifying a value for the `routerLinkActive`'s `ariaCurrentWhenActive`. This makes sure that visually impaired users (which may not perceive the different styling being applied) can also identify the active button. For more information see the Accessibility Best Practices [Active links identification section](/guide/accessibility#active-links-identification).
## Adding a redirect

In this step of the tutorial, you add a route that redirects the user to display the `/heroes-list` component.

1.  From your code editor, open the `app.routes.ts` file.
1.  Update the `routes` section as follows.

```
  {path: '', redirectTo: '/heroes-list', pathMatch: 'full'},
```

    Notice that this new route uses an empty string as its path.
    In addition, it replaces the `component` property with two new ones:

    | Properties   | Details |
    |:---          |:---     |
    | `redirectTo` | This property instructs Angular to redirect from an empty path to the `heroes-list` path.                                                                                                                                                                                                         |
    | `pathMatch`  | This property instructs Angular on how much of the URL to match. For this tutorial, you should set this property to `full`. This strategy is recommended when you have an empty string for a path. For more information about this property, see the [Route API documentation](api/router/Route). |

Now when you open your application, it displays the `heroes-list` component by default.

## Adding a 404 page

It is possible for a user to try to access a route that you have not defined.
To account for this behavior, the best practice is to display a 404 page.
In this section, you'll create a 404 page and update your route configuration to show that page for any unspecified routes.

1.  From the terminal, create a new component, `PageNotFound`.

    <code-example format="shell" language="shell">

    ng generate component page-not-found

    </code-example>

1.  From your code editor, open the `page-not-found.component.html` file and replace its contents with the following HTML.

    <code-example header="src/app/page-not-found/page-not-found.component.html" path="router-tutorial/src/app/page-not-found/page-not-found.component.html"></code-example>

1.  Open the `app.routes.ts` file and add the following route to the routes list:

```
  {path: '**', component: PageNotFoundComponent}
```

    The new route uses a path, `**`.
    This path is how Angular identifies a wildcard route.
    Any route that does not match an existing route in your configuration will use this route.

    <div class="alert is-important">

    Notice that the wildcard route is placed at the end of the array.
    The order of your routes is important, as Angular applies routes in order and uses the first match it finds.

    </div>

Try navigating to a non-existing route on your application, such as `http://localhost:4200/powers`.
This route doesn't match anything defined in your `app.routes.ts` file.
However, because you defined a wildcard route, the application automatically displays your `PageNotFound` component.

## Next steps

At this point, you have a basic application that uses Angular's routing feature to change what components the user can see based on the URL address.
You have extended these features to include a redirect, as well as a wildcard route to display a custom 404 page.

For more information about routing, see the following topics:

*   [In-app Routing and Navigation](guide/router)
*   [Router API](api/router)

<!-- links -->

<!-- external links -->

<!-- end links -->

@reviewed 2023-10-24