In any single-page application, routing is the hub that makes sure the right components get loaded for the current view or application state. Routes are often requested when the application is loaded or when a user operation is triggered. Also, route requests can be raised based on inputs from the server.
In Angular, the router has a number of important building blocks. In this post, I'll show you the most important parts of the Angular router, and we'll build a practical example along the way.
First things first, you must have the Angular router installed in your project.
The Angular router is an extremely powerful JavaScript-based router. It is created and managed by the core Angular team.
The router can be installed easily from the @angular/router
package. Installing this package will give your project complete access to all the routing features you would need: from router guards to path matching methods to the creation of several router outlets.
@angular/router
PackageThere are two different ways of installing the @angular/router
package, depending on the package manager you use in your project.
With NPM:
npm i --save @angular/router
Or with Yarn:
yarn add @angular/router
Before you use the features of the @angular/router
package, you need to set the root route of the application in your index.html file. If you look at the root folder of your application, you will find the index.html file. Here, add the base location using the base
tag. We are going to use the app folder as the root of the application using the "/"
path.
Making this change tells Angular the starting location for all the different routes in your application.
<!doctype html> <html> <head> <base href="/"> <title>Angular Routing</title> </head> . . . </html>
If you are going to make use of the @angular/router
package, you have to import the router into NgModule
. The main App Module of your application must have the RouterModule
. In our case, the app.module.ts file has the NgModule
declaration. This file has to be modified with the following components:
import { NgModule } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; import { RouterModule } from '@angular/router'; import { AppComponent } from './app.component'; @NgModule({ imports: [BrowserModule, RouterModule], bootstrap: [AppComponent], declarations: [AppComponent], }) export class AppModule {}
RouterModule
RouterModule
needs information about the routes in your single-page application. Until this information is provided, RouterModule
will not be useful. RouterModule
has two static methods which can be used to provide the required configuration of the routes in the application to the router. This is when the entire setup gets completed.
When routes are being defined for the root configuration of the application, a static method called RouterModule.forRoot
can be used. This will give the main NgModule
access to the multiple router directives in your application. Here is a small snippet to show how RouterModule.forRoot
can be used.
import { Routes, RouterModule } from '@angular/router'; . . . export const ROUTES: Routes = []; @NgModule({ imports: [BrowserModule, RouterModule.forRoot(ROUTES)], . . . }) export class AppModule {}
Here, we pass an array of routes to the configuration. It is best practice in Angular routing to use a variable or a constant inside forRoot
. In many cases, it would be most readable and easiest to maintain if the routes are stored in a separate file and imported into the AppModule
of your application. We'll look at how to specify the ROUTES
array below.
Next, we have RouterModule.forChild
, which is extremely similar to the functionality offered by RouterModule.forRoot
. The main difference is that RouterModule.forChild
can be treated like a feature module. It saves developers the effort of defining all the required routes in a single page as does forRoot
. Modules within the application can define and configure their own routes. Based on need, these routes can be imported into the main module.
Here is a small code snippet where we use RouterModule.forChild
.
import { NgModule } from '@angular/core'; import { Routes, RouterModule } from '@angular/router'; export const ROUTES: Routes = []; @NgModule({ imports: [RouterModule.forChild(ROUTES)], . . . }) export class ChildModule {}
Now we've finished the basic configuration of our routes. The next step is to help Angular load components. For this, we make use of a directive called router-outlet
.
The moment our router identifies a component to load for a route, the component gets created dynamically. And the dynamically created component is injected along the router-outlet
element. The newly created component is treated as a sibling for the router-outlet
element. The router-outlet
directive can be inserted anywhere in your main application component.
Meanwhile, if you are building a simple AppComponent
, you can inject the directive as follows:
import { Component } from '@angular/core'; @Component({ selector: 'appComponent', template: ` <div> <h1>Angular Routing</h1> <router-outlet></router-outlet> </div> `, }) export class AppComponent {}
And that's where the setup comes to an end. Now, we can look into the specific needs of the project and start building routes.
We will be building the routes for our application in the following file: app.routing.ts. When you build a single-page application, it is crucial to have a static route. In our case, the static route would be the home page loaded by the application.
Here is our routes array:
export const AppRoutes: Routes = [ { path: '', component: HomeComponent }, { path: 'calc', component: CalcComponent }, { path: '**', component: NotFoundComponent } ];
calc
path will be used to load the calculator component we built in the first part of this series.**
denotes what should be loaded in case there is no other matching route. With the above created route and configuration changes, we are ready to navigate. Let's start by creating a main component for our application called HomeComponent
. In our home.component.html file, you would see two new directives: routerLink
and routerLinkActive
.
routerLink
is an Angular directive where you can route from one route to another without changing the value in the URL bar. If you want to create a dynamic route, you need to wrap routerLink
and pass an array. The syntax for a dynamic router link is [routerLink]=['/path', variable]
.
Here's our home.component.html file with a static router link.
<h2> Welcome to Home Page </h2> <nav> <a routerLink="/calc" routerLinkActive="active">Go to Calc</a> </nav>
The routerLinkActive
directive is used when you want to tell the user which is active. This directive needs to be used along with routerLink
.
And here's what the corresponding home.component.ts file looks like.
import { Component } from '@angular/core'; @Component({ selector: 'home', templateUrl: 'home.component.html' }) export class HomeComponent {}
By default, when you load the application, the HomeComponent
gets loaded. Why? Because the ''
path corresponds to the HomeComponent
.
When you navigate to /calc
, the following view will appear. Why? Because /calc
loads the CalcComponent
in our app.routing.ts component.
Now, you have understood the basics of routing, You have created a landing page for your application, and a route! Next, we are going to cover a few advanced concepts in Angular routing.
In single-page applications, there is a chance that you would reach a specific route with several operations in mind. For example, in our calculator application, the CalcComponent
can be launched only for "addition", "subtraction", or "division". We can achieve this with the help of a colon (:
) in the URL segment. The colon tells the router that the value entered is not a part of the URL, but is instead a route parameter.
export const AppRoutes: Routes = [ { path: '', component: HomeComponent }, { path: 'calc/:operation', component: CalcComponent }, { path: '**', component: NotFoundComponent } ];
What we have established is a dynamic route. Now, when we create a link or type an address in the location bar, we can easily swap :operation
for any of the operations like addition
, subtraction
, or division
.
Now comes our next challenge. How would you extract the dynamic route information from the route URL? Most of the time, we make use of ngOnInit
. If you have a moment, do spend some time on our post about Angular Components where you'll read about ngOnInit
and its role in the lifecycle of a component.
In order to access dynamic route parameters, we make use of ActivatedRoute
.
ActivatedRoute
contains an Observable
called params
. By subscribing to params
, we can easily extract the route parameters. The best place to subscribe would be ngOnInit
. When we route from one parameter to another, the actual route component will not be destroyed. This is a technique Angular uses to boost performance. When you subscribe at ngOnInit
, you will receive a notification every time the router parameter changes.
Here is a simple piece of code to help you understand the use of ActivatedRoute
.
//the Route is defined as path = '/calc/:operation' import { Component, OnInit } from '@angular/core'; import { ActivatedRoute } from '@angular/router'; @Component({ selector: 'calc.component', templateUrl: './calc.component.html' }) export class CalcComponent implements OnInit { operation: string; constructor(private route: ActivatedRoute) {} ngOnInit() { this.route.params.subscribe((params) => this.operation = params.operation); } }
So far, we have seen routes that stop with a single level. Now, let's define routes that go into multiple levels. For instance, a single-level route would be /calc
, and a multi-level route would be /calc/addition
.
We can assign /calc
its very own component, and /calc/addition
will have another component. To achieve this behavior, we make use of children
with the path.
Additionally, to make the child routes work, it is important to include <router-outlet>
in the parent component, where the routes would be rendered from.
Sometimes, we may not use the parent route at all for a specific component. In this case, we can remove the component from our route declaration. This is also known as a componentless route.
Here's a simple example to help you understand these concepts.
//DEFINING THE ROUTE export const ROUTES: Routes = [ { path: 'calc', component: CalcComponent, children: [ { path: 'addition', component: CalcAdditionComponent }, { path: 'subtraction', component: CalcSubstractionComponent }, ], }, ]; //COMPONENT-LESS ROUTE export const ROUTES: Routes = [ { path: 'calc', children: [ { path: 'addition', component: CalcAdditionComponent }, { path: 'subtraction', component: CalcSubstractionComponent }, ], }, ]; @NgModule({ imports: [BrowserModule, RouterModule.forRoot(ROUTES)], }) //BUILDING THE PARENT COMPONENT import { Component } from '@angular/core'; @Component({ selector: 'calc.component', template: ` <div> <calc-addition></calc-addition> <calc-subtraction></calc-subtraction> <router-outlet></router-outlet> </div> `, }) export class CalcComponent {}
As your application becomes bigger, handling routes can be a challenge. There will be times when you need to fetch routes from different modules. In such cases, you can make use of loadChildren
. This is when RouterModule.forChild()
becomes useful.
Let's begin with an example:
//CHILD ROUTE export const ROUTES: Routes = [ { path: '', component: CalcComponent, children: [ { path: 'addition', component: CalcAdditionComponent }, { path: 'subtraction', component: CalcSubtractionComponent }, ], }, ]; @NgModule({ imports: [CommonModule, RouterModule.forChild(ROUTES)], }) export class CalcModule {} //PARENT ROUTE export const ROUTES: Routes = [ { path: 'calc', loadChildren: './calc/calc.module#CalcModule', }, ]; @NgModule({ imports: [BrowserModule, RouterModule.forRoot(ROUTES)], }) export class AppModule {}
A few interesting aspects to be understood from the above code are:
/calc/calc
.CalcModule
has to be imported in the Root AppModule
./calc/**
.In this tutorial, you learnt the basics of how to handle routing in Angular. You learnt how to define a route and navigate in different ways through an Angular application. The source code for this tutorial is available on GitHub. The concepts discussed in this post cover the basics. As you master the basics, you will be able to dig deeper into the more advanced Angular routing concepts like activating guards, router navigation, and more.
Create Modern Vue Apps Using Create-Vue and Vite
/Pros and Cons of Using WordPress
/How to Fix the “There Has Been a Critical Error in Your Website” Error in WordPress
/How To Fix The “There Has Been A Critical Error in Your Website” Error in WordPress
/How to Create a Privacy Policy Page in WordPress
/How Long Does It Take to Learn JavaScript?
/The Best Way to Deep Copy an Object in JavaScript
/Adding and Removing Elements From Arrays in JavaScript
/Create a JavaScript AJAX Post Request: With and Without jQuery
/5 Real-Life Uses for the JavaScript reduce() Method
/How to Enable or Disable a Button With JavaScript: jQuery vs. Vanilla
/How to Enable or Disable a Button With JavaScript: jQuery vs Vanilla
/Confirm Yes or No With JavaScript
/How to Change the URL in JavaScript: Redirecting
/15+ Best WordPress Twitter Widgets
/27 Best Tab and Accordion Widget Plugins for WordPress (Free & Premium)
/21 Best Tab and Accordion Widget Plugins for WordPress (Free & Premium)
/30 HTML Best Practices for Beginners
/31 Best WordPress Calendar Plugins and Widgets (With 5 Free Plugins)
/25 Ridiculously Impressive HTML5 Canvas Experiments
/How to Implement Email Verification for New Members
/How to Create a Simple Web-Based Chat Application
/30 Popular WordPress User Interface Elements
/Top 18 Best Practices for Writing Super Readable Code
/Best Affiliate WooCommerce Plugins Compared
/18 Best WordPress Star Rating Plugins
/10+ Best WordPress Twitter Widgets
/20+ Best WordPress Booking and Reservation Plugins
/Working With Tables in React: Part Two
/Best CSS Animations and Effects on CodeCanyon
/30 CSS Best Practices for Beginners
/How to Create a Custom WordPress Plugin From Scratch
/10 Best Responsive HTML5 Sliders for Images and Text… and 3 Free Options
/16 Best Tab and Accordion Widget Plugins for WordPress
/18 Best WordPress Membership Plugins and 5 Free Plugins
/25 Best WooCommerce Plugins for Products, Pricing, Payments and More
/10 Best WordPress Twitter Widgets
1 /12 Best Contact Form PHP Scripts for 2020
/20 Popular WordPress User Interface Elements
/10 Best WordPress Star Rating Plugins
/12 Best CSS Animations on CodeCanyon
/12 Best WordPress Booking and Reservation Plugins
/12 Elegant CSS Pricing Tables for Your Latest Web Project
/24 Best WordPress Form Plugins for 2020
/14 Best PHP Event Calendar and Booking Scripts
/Create a Blog for Each Category or Department in Your WooCommerce Store
/8 Best WordPress Booking and Reservation Plugins
/Best Exit Popups for WordPress Compared
/Best Exit Popups for WordPress Compared
/11 Best Tab & Accordion WordPress Widgets & Plugins
/12 Best Tab & Accordion WordPress Widgets & Plugins
1 /New Course: Practical React Fundamentals
/Preview Our New Course on Angular Material
/Build Your Own CAPTCHA and Contact Form in PHP
/Object-Oriented PHP With Classes and Objects
/Best Practices for ARIA Implementation
/Accessible Apps: Barriers to Access and Getting Started With Accessibility
/Dramatically Speed Up Your React Front-End App Using Lazy Loading
/15 Best Modern JavaScript Admin Templates for React, Angular, and Vue.js
/15 Best Modern JavaScript Admin Templates for React, Angular and Vue.js
/19 Best JavaScript Admin Templates for React, Angular, and Vue.js
/New Course: Build an App With JavaScript and the MEAN Stack
/Hands-on With ARIA: Accessibility Recipes for Web Apps
/10 Best WordPress Facebook Widgets
13 /Hands-on With ARIA: Accessibility for eCommerce
/New eBooks Available for Subscribers
/Hands-on With ARIA: Homepage Elements and Standard Navigation
/Site Accessibility: Getting Started With ARIA
/How Secure Are Your JavaScript Open-Source Dependencies?
/New Course: Secure Your WordPress Site With SSL
/Testing Components in React Using Jest and Enzyme
/Testing Components in React Using Jest: The Basics
/15 Best PHP Event Calendar and Booking Scripts
/Create Interactive Gradient Animations Using Granim.js
/How to Build Complex, Large-Scale Vue.js Apps With Vuex
1 /Examples of Dependency Injection in PHP With Symfony Components
/Set Up Routing in PHP Applications Using the Symfony Routing Component
1 /A Beginner’s Guide to Regular Expressions in JavaScript
/Introduction to Popmotion: Custom Animation Scrubber
/Introduction to Popmotion: Pointers and Physics
/New Course: Connect to a Database With Laravel’s Eloquent ORM
/How to Create a Custom Settings Panel in WooCommerce
/Building the DOM faster: speculative parsing, async, defer and preload
1 /20 Useful PHP Scripts Available on CodeCanyon
3 /How to Find and Fix Poor Page Load Times With Raygun
/Introduction to the Stimulus Framework
/Single-Page React Applications With the React-Router and React-Transition-Group Modules
12 Best Contact Form PHP Scripts
1 /Getting Started With the Mojs Animation Library: The ShapeSwirl and Stagger Modules
/Getting Started With the Mojs Animation Library: The Shape Module
/Getting Started With the Mojs Animation Library: The HTML Module
/Project Management Considerations for Your WordPress Project
/8 Things That Make Jest the Best React Testing Framework
/Creating an Image Editor Using CamanJS: Layers, Blend Modes, and Events
/New Short Course: Code a Front-End App With GraphQL and React
/Creating an Image Editor Using CamanJS: Applying Basic Filters
/Creating an Image Editor Using CamanJS: Creating Custom Filters and Blend Modes
/Modern Web Scraping With BeautifulSoup and Selenium
/Challenge: Create a To-Do List in React
1 /Deploy PHP Web Applications Using Laravel Forge
/Getting Started With the Mojs Animation Library: The Burst Module
/10 Things Men Can Do to Support Women in Tech
/A Gentle Introduction to Higher-Order Components in React: Best Practices
/Challenge: Build a React Component
/A Gentle Introduction to HOC in React: Learn by Example
/A Gentle Introduction to Higher-Order Components in React
/Creating Pretty Popup Messages Using SweetAlert2
/Creating Stylish and Responsive Progress Bars Using ProgressBar.js
/How to Make a Real-Time Sports Application Using Node.js
/Creating a Blogging App Using Angular & MongoDB: Delete Post
/Set Up an OAuth2 Server Using Passport in Laravel
/Creating a Blogging App Using Angular & MongoDB: Edit Post
/Creating a Blogging App Using Angular & MongoDB: Add Post
/Introduction to Mocking in Python
/Creating a Blogging App Using Angular & MongoDB: Show Post
/Creating a Blogging App Using Angular & MongoDB: Home
/Creating a Blogging App Using Angular & MongoDB: Login
/Creating Your First Angular App: Implement Routing
/Persisted WordPress Admin Notices: Part 4
/Creating Your First Angular App: Components, Part 2
/Persisted WordPress Admin Notices: Part 3
/Creating Your First Angular App: Components, Part 1
/How Laravel Broadcasting Works
/Persisted WordPress Admin Notices: Part 2
/Create Your First Angular App: Storing and Accessing Data
/Persisted WordPress Admin Notices: Part 1
/Error and Performance Monitoring for Web & Mobile Apps Using Raygun
/Using Luxon for Date and Time in JavaScript
7 /How to Create an Audio Oscillator With the Web Audio API
/How to Cache Using Redis in Django Applications
/20 Essential WordPress Utilities to Manage Your Site
/Beginner’s Guide to Angular 4: HTTP
/Rapid Web Deployment for Laravel With GitHub, Linode, and RunCloud.io
/Beginners Guide to Angular 4: Routing
/Beginner’s Guide to Angular 4: Services
/Beginner’s Guide to Angular 4: Components
/Creating a Drop-Down Menu for Mobile Pages
/Introduction to Forms in Angular 4: Writing Custom Form Validators
/10 Best WordPress Booking & Reservation Plugins
/Getting Started With Redux: Connecting Redux With React
/Getting Started With Redux: Learn by Example
/Getting Started With Redux: Why Redux?
/Understanding Recursion With JavaScript
/How to Auto Update WordPress Salts
/How to Download Files in Python
/Eloquent Mutators and Accessors in Laravel
1 /10 Best HTML5 Sliders for Images and Text
/Site Authentication in Node.js: User Signup
/Creating a Task Manager App Using Ionic: Part 2
/Creating a Task Manager App Using Ionic: Part 1
/Introduction to Forms in Angular 4: Reactive Forms
/Introduction to Forms in Angular 4: Template-Driven Forms
/24 Essential WordPress Utilities to Manage Your Site
/25 Essential WordPress Utilities to Manage Your Site
/Get Rid of Bugs Quickly Using BugReplay
1 /Manipulating HTML5 Canvas Using Konva: Part 1, Getting Started
/10 Must-See Easy Digital Downloads Extensions for Your WordPress Site
/22 Best WordPress Booking and Reservation Plugins
/Understanding ExpressJS Routing
/15 Best WordPress Star Rating Plugins
/Creating Your First Angular App: Basics
/Inheritance and Extending Objects With JavaScript
/Introduction to the CSS Grid Layout With Examples
1Performant Animations Using KUTE.js: Part 5, Easing Functions and Attributes
Performant Animations Using KUTE.js: Part 4, Animating Text
/Performant Animations Using KUTE.js: Part 3, Animating SVG
/New Course: Code a Quiz App With Vue.js
/Performant Animations Using KUTE.js: Part 2, Animating CSS Properties
Performant Animations Using KUTE.js: Part 1, Getting Started
/10 Best Responsive HTML5 Sliders for Images and Text (Plus 3 Free Options)
/Single-Page Applications With ngRoute and ngAnimate in AngularJS
/Deferring Tasks in Laravel Using Queues
/Site Authentication in Node.js: User Signup and Login
/Working With Tables in React, Part Two
/Working With Tables in React, Part One
/How to Set Up a Scalable, E-Commerce-Ready WordPress Site Using ClusterCS
/New Course on WordPress Conditional Tags
/TypeScript for Beginners, Part 5: Generics
/Building With Vue.js 2 and Firebase
6 /Best Unique Bootstrap JavaScript Plugins
/Essential JavaScript Libraries and Frameworks You Should Know About
/Vue.js Crash Course: Create a Simple Blog Using Vue.js
/Build a React App With a Laravel RESTful Back End: Part 1, Laravel 5.5 API
/API Authentication With Node.js
/Beginner’s Guide to Angular: Routing
/Beginners Guide to Angular: Routing
/Beginner’s Guide to Angular: Services
/Beginner’s Guide to Angular: Components
/How to Create a Custom Authentication Guard in Laravel
/Learn Computer Science With JavaScript: Part 3, Loops
/Build Web Applications Using Node.js
/Learn Computer Science With JavaScript: Part 4, Functions
/Learn Computer Science With JavaScript: Part 2, Conditionals
/Create Interactive Charts Using Plotly.js, Part 5: Pie and Gauge Charts
/Create Interactive Charts Using Plotly.js, Part 4: Bubble and Dot Charts
Create Interactive Charts Using Plotly.js, Part 3: Bar Charts
/Awesome JavaScript Libraries and Frameworks You Should Know About
/Create Interactive Charts Using Plotly.js, Part 2: Line Charts
/Bulk Import a CSV File Into MongoDB Using Mongoose With Node.js
/Build a To-Do API With Node, Express, and MongoDB
/Getting Started With End-to-End Testing in Angular Using Protractor
/TypeScript for Beginners, Part 4: Classes
/Object-Oriented Programming With JavaScript
/10 Best Affiliate WooCommerce Plugins Compared
/Stateful vs. Stateless Functional Components in React
/Make Your JavaScript Code Robust With Flow
/Build a To-Do API With Node and Restify
/Testing Components in Angular Using Jasmine: Part 2, Services
/Testing Components in Angular Using Jasmine: Part 1
/Creating a Blogging App Using React, Part 6: Tags
/React Crash Course for Beginners, Part 3
/React Crash Course for Beginners, Part 2
/React Crash Course for Beginners, Part 1
/Set Up a React Environment, Part 4
1 /Set Up a React Environment, Part 3
/New Course: Get Started With Phoenix
/Set Up a React Environment, Part 2
/Set Up a React Environment, Part 1
/Command Line Basics and Useful Tricks With the Terminal
/How to Create a Real-Time Feed Using Phoenix and React
/Build a React App With a Laravel Back End: Part 2, React
/Build a React App With a Laravel RESTful Back End: Part 1, Laravel 9 API
/Creating a Blogging App Using React, Part 5: Profile Page
/Pagination in CodeIgniter: The Complete Guide
/JavaScript-Based Animations Using Anime.js, Part 4: Callbacks, Easings, and SVG
/JavaScript-Based Animations Using Anime.js, Part 3: Values, Timeline, and Playback
/Learn to Code With JavaScript: Part 1, The Basics
/10 Elegant CSS Pricing Tables for Your Latest Web Project
/Getting Started With the Flux Architecture in React
/Getting Started With Matter.js: The Composites and Composite Modules
Getting Started With Matter.js: The Engine and World Modules
/10 More Popular HTML5 Projects for You to Use and Study
/Understand the Basics of Laravel Middleware
/Iterating Fast With Django & Heroku
/Creating a Blogging App Using React, Part 4: Update & Delete Posts
/Creating a jQuery Plugin for Long Shadow Design
/How to Register & Use Laravel Service Providers
2 /Unit Testing in React: Shallow vs. Static Testing
/Creating a Blogging App Using React, Part 3: Add & Display Post
/Creating a Blogging App Using React, Part 2: User Sign-Up
20 /Creating a Blogging App Using React, Part 1: User Sign-In
/Creating a Grocery List Manager Using Angular, Part 2: Managing Items
/9 Elegant CSS Pricing Tables for Your Latest Web Project
/Angular vs. React: 7 Key Features Compared
/Creating a Grocery List Manager Using Angular, Part 1: Add & Display Items
New eBooks Available for Subscribers in June 2017
/Create Interactive Charts Using Plotly.js, Part 1: Getting Started
/The 5 Best IDEs for WordPress Development (And Why)
/33 Popular WordPress User Interface Elements
/New Course: How to Hack Your Own App
/How to Install Yii on Windows or a Mac
/What Is a JavaScript Operator?
/How to Register and Use Laravel Service Providers
/
waly Good blog post. I absolutely love this…