Ng2-simple-smooth-scroll NPM

ng2-simple-smooth-scroll

Smooth scroll for Angular9+. Demo

Getting Started

You can install ng2-simple-smooth-scroll by using npm.

npm install ng2-simple-smooth-scroll --save

Once installed you need to import our main module:

This module provides one directive and one service.

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { AppComponent } from './app.component';

import { SimpleSmoothScrollModule } from 'ng2-simple-smooth-scroll'; // <-- add

@NgModule({
  imports: [
    BrowserModule, 
    SimpleSmoothScrollModule  // <-- add
  ],
  declarations: [ 
    AppComponent,
  ],
  bootstrap: [ AppComponent ]
})
export class AppModule { }

Usage - Service

import service to component

import { Component, OnInit } from '@angular/core';
import { SimpleSmoothScrollService } from 'ng2-simple-smooth-scroll';
import { SimpleSmoothScrollOption } from 'ng2-simple-smooth-scroll';

@Component({
  ...
})
export class AppComponent implements OnInit{

  constructor(private smooth: SimpleSmoothScrollService) { }

  ngOnInit() {
    this.smooth.smoothScrollToAnchor();
  }
  
  goTop(){
    this.smooth.smoothScrollToTop({ duration: 1000, easing: 'linear' });
  }
}

Methods

smoothScrollToTop

smoothScrollToTop( SimpleSmoothScrollOption , HTMLElement )

Smooth scroll to top page.

smoothScrollToAnchor

smoothScrollToAnchor( SimpleSmoothScrollOption , HTMLElement )

Smooth scroll to the anchor.

ISimpleSmoothScrollOption

For set duration and easing function

let option1 = { duration: 500 };
let option2 = { duration: 1000, easing: 'easeOutQuart'};
let option3 = { easing: 'linear'};

// this.smooth.smoothScrollToTop(option1);
// this.smooth.smoothScrollToAnchor(option2);

Usage - Directive

SimpleSmoothScroll

Scroll the window to the specified element ID or hash when clicking the element.

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

@Component({  
  ...
  template: `
    <div id="div1">
      <a href="#div2" SimpleSmoothScroll [showHash]="true">Click!!</a>
    </div>
    <div id="div2" SimpleSmoothScroll [scrollTo]="'div1'" [duration]="500">
      <h1>Click me</h1>
    </div>
  `,
  ...
})
export class AppComponent{
	...
}