Skip to content
This repository has been archived by the owner on Mar 11, 2021. It is now read-only.

Customisable angular module to animate scroll event to an element. Compatible with Angular 2.x onwards

License

Notifications You must be signed in to change notification settings

mansour-ahmed/ng-animate-scroll

Repository files navigation

ng-animate-scroll npm version

Customisable angular module to animate scroll event to an element. Compatible with Angular 2.x onwards

Installation

First you need to install the npm module:

npm i ng-animate-scroll --save

Usage

1. Methods:

AnimateScrollService

  • scrollToElement(elementID: string, duration: number = 750): Find an element using its ID and scrolls to it smoothly. Duration of the animation is optional and has default of 750 ms.

2. Example

import { Component } from '@angular/core';
import { NgAnimateScrollService } from 'ng-animate-scroll';

@Component({
    selector: 'app',
    template: `
        <header id="header"></header>
        <button (click)="navigateToHeader()">scroll to header</div>
        <button (click)="navigateToHeader(2000)">scroll to header slowly</div>
    `
})
export class AppComponent {

    constructor(private animateScrollService: NgAnimateScrollService) {
    }

    navigateToHeader(duration?:number) {
        this.animateScrollService.scrollToElement('header', duration)
    }
}

About

Customisable angular module to animate scroll event to an element. Compatible with Angular 2.x onwards

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published