How to scroll to top on every Route click in Angular5 ?

Last Updated : 06 Aug, 2024

We can use Router and NavigationEnd from '@angular/router' and hence we can scroll to the top of the webpage for every route.

Approach:

First, we need to import the Router and NavigationEnd from '@angular/router' in both app.module.ts file and app.component.ts.
Then we need to create an instance of those in the constructor function.
After creating the instance we need to use them in the ngOninit() life cycle hook.
In the ngOninit() hook, we need to subscribe to the events of the router and check whether it is an instance of NavigationEnd or not.
Then after checking we can use the window.scrollTo() function with (0,0) coordinates to navigate to the top.

After following the above steps start your project using the below command.

ng serve --open

Below is the implementation of the above steps:

app.module.ts:

JavaScript

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { RouterModule, Routes } from '@angular/router';
 
import { AppComponent } from './app.component';
 
const routes: Routes = [
  { path: '', component: AppComponent },
];
 
@NgModule({
  imports:      [ BrowserModule, 
        RouterModule.forRoot(routes) ],
  declarations: [ AppComponent ],
  bootstrap:    [ AppComponent ]
})
export class AppModule { }

app.component.ts:

JavaScript

import { Component, OnInit } from '@angular/core';
import { Router, NavigationEnd } from '@angular/router';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html'
})
export class AppComponent implements OnInit {
    constructor(private router: Router) { }
    
    ngOnInit() {
        this.router.events.subscribe((event) => {
            if (!(event instanceof NavigationEnd)) {
                return;
            }
            window.scrollTo(0, 0)
        });
    }
}