Smooth Scroll Functions

The smooth scroll function returns a promise that resolves when scrolling reaches the point or target.

Scroll to position

scrollable.scrollTo(options: SmoothScrollToOptions)

• Element: target HTMLElement, or ElementRef or the selector string.
• Options:
  • Top: Set top offset, default null.
  • Bottom: Set bottom offset, default null.
  • Start: Set start offset (evaluates left in ltr, in right rtl), default null.
  • End: Set end offset (evaluates right in ltr, in left rtl), default null.
  • Left: Set left offset, default null.
  • Right: Set right offset, default null.
  • Duration: Time to reach the target in ms, default null.
  • Easing: Smooth scroll animation can be customized using the bezier-easing properties { x1, y1, x2, y2 }.

Avoid setting top and bottom, or start and end, or left and right at the same time because that would obviously not work.

Scroll to element

scrollable.scrollToElement(target: HTMLElement | ElementRef | string, options?)

• Element: target HTMLElement, or ElementRef or the selector string.
• Options:
  • Left: Set left offset, default null.
  • Right: Set right offset, default null.
  • Duration: time to reach the position in milliseconds, default null.
  • Easing: Smooth scroll animation can be customized using the bezier-easing properties { x1, y1, x2, y2 }.

Scrolling examples

Scroll to top directly from the template

<ng-scrollbar #scrollbarRef>
  <!-- Content -->
</ng-scrollbar>

<button (click)="scrollbarRef.scrollTo({ top: 0 })">Go to top</button>

Scroll to a specific element by a selector

<ng-scrollbar #scrollbale>
  <div id="..."></div>
  <div id="..."></div>
  <div id="..."></div>
  <div id="comments"></div>
  <div #footer></div>
</ng-scrollbar>

<button (click)="scrollbale.scrollToElement('#comments')">Comments Section</button>

<button (click)="scrollable.scrollToElement(footer)">Scroll to footer</button>

Scroll to a specific element by element reference

<ng-scrollbar #scrollbale>
  <div #intro></div>
  <div #title></div>
  <div #body></div>
  <div #comments></div>
  <div #author></div>
</ng-scrollbar>

<button (click)="scrollbale.scrollToElement(comments)">Usage Section</button>

The same can be done from component code using the @ViewChild decorator

@ViewChild(NgScrollbar, { static: true }) scrollable: NgScrollbar;
@ViewChild('comments', { static: true }) commentsSection: ElementRef;

scrollToCommentsSection() {
  this.scrollable.scrollToElement(this.commentsSection);
}

Scroll to top on route change

If you wrap the <router-outlet> inside <ng-scrollbar>, you can scroll to top on route changes, like the following example: The following example scrolls to top whenever the user navigates to another page.

<ng-scrollbar>
  <router-outlet></router-outlet>
</ng-scrollbar>

export class AppComponent {

  @ViewChild(NgScrollbar, { static: true }) scrollable: NgScrollbar;

  constructor(router: Router) {
    router.events.pipe(
      filter(event => event instanceof NavigationEnd)),
      filter(() => !!this.scrollable)),
      tap((event: NavigationEnd) => this.scrollable.scrollTo({ top: 0, duration: 500 }))
    ).subscribe();
  }
}