npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ng2-smooth-scroll

v1.0.1

Published

A pure-javascript library and set of directives to scroll smoothly to an element with easing.

Downloads

489

Readme

Angular2 smooth scroll

base onAngular smooth scroll

A pure-javascript library and set of directives to scroll smoothly to an element with easing. Easing support contributed by Willem Liu with code from Gaëtan Renaudeau.

No jQuery required.

Features

  • Exposes a service that scrolls the window to an element's location
  • Provides two directives that enable smooth scrolling to elements.
  • Clean: No classes are added, no jQuery is required, no CSS files or configuration is needed.
  • Scrolling within a custom container added in 2.0.0

Installation

import { SmoothScrollToDirective, SmoothScrollDirective } from "ng2SmoothScroll";
...
declarations[
	...
	SmoothScrollToDirective,
	SmoothScrollDirective,
	...
]

Bower

Install with bower with:

bower install ng2SmoothScroll

Npm

Install with npm with:

npm install ng2-smooth-scroll

Usage - As a directive

This module provides two directives:

smoothScroll:

Attribute. Scrolls the window to this element, optionally validating the expression inside scroll-if.

Example:


// Basic - The window will scroll to this element's position when compiling this directive
<div smoothScroll></div>

// With options
<div smoothScroll
	duration="800"
	easing="easeInQuint"
	offset="120"
	callbackBefore="aFunction(element)"
	callbackAfter="anotherFunction">
	{{...}}
</div>

// Inside a custom container
<div smoothScroll
	duration="800"
	easing="easeInQuint"
	offset="120"
	callbackBefore="aFunction(element)"
	callbackAfter="anotherFunction"
	containerId="container-id">
	{{...}}
</div>

// With condition
<div smoothScroll
	scrollIf="{{ myExpression }}">
	{{...}}
</div>

// Inside ng-repeat
<div smoothScroll
	scrollIf="{{ $last }}"
	duration="2500">
	{{...}}
</div>

####scrollTo:

Attribute. Scrolls the window to the specified element ID when clicking this element.

Example:


// Basic
<a href="#"
	scrollTo="my-element-3">
	Click me!
</a>

// Custom containers
<a href="#"
	scrollTo="my-element-3"
	containerId="custom-container-id">
	Click me!
</a>

// onClick for non-anchor tags
<div scrollTo="my-element-3"
	containerId="custom-container-id">
	Click me!
</div>

// With options
<button
	scrollTo="elem-id5"
	duration="1800"
	callbackBefore="aFunction(element)"
	callbackAfter="anotherFunction">
	Scroll to next page.
</button>

Options

duration

Type: Integer Default: 800

The duration of the smooth scroll, in miliseconds.

offset

Type: Integer Default: 0

The offset from the top of the page in which the scroll should stop.

easing

type: string default: easeInOutQuart

the easing function to be used for this scroll.

callbackBefore

type: function default: function(element) {}

a callback function to run before the scroll has started. It is passed the element that will be scrolled to.

callbackAfter

type: function default: function(element) {}

a callback function to run after the scroll has completed. It is passed the element that was scrolled to.

containerId

type: string default: null

ID of the scrollable container which the element is a child of.

Easing functions

The available easing functions are:

  • 'easeInQuad'
  • 'easeOutQuad'
  • 'easeInOutQuad'
  • 'easeInCubic'
  • 'easeOutCubic'
  • 'easeInOutCubic'
  • 'easeInQuart'
  • 'easeOutQuart'
  • 'easeInOutQuart'
  • 'easeInQuint'
  • 'easeOutQuint'
  • 'easeInOutQuint'

Cheers.