JSPM

animated-scrollto

1.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1532
  • Score
    100M100P100Q97739F
  • License MIT

Animated scrolling without any dependency on libraries

Package Exports

  • animated-scrollto

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (animated-scrollto) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Animated scrollTo

This is a simple function for animating scroll.

  • No dependency on extra libraries.
  • If user scrolls while animation is running, scroll animation would be immediately canceled.
  • Use as a single script or through bower.

Example usage

button.addEventListener('click', function () {
    animatedScrollTo(
        document.body, // element to scroll with (most of times you want to scroll with whole <body>)
        0, // target scrollY (0 means top of the page)
        10000, // duration in ms
        function() { // callback function that runs after the animation (optional)
          console.log('done!')
        }
    );
});

This will scroll to top of the page and the animation will run for 10 seconds (10000ms).

Available on Bower

bower install animated-scrollto

Just import with <script> and global function animatedScrollTo will be available for you.

Available with Browserify

npm install animated-scrollto

In your browserify powered js:

var animatedScrollTo = require('animated-scrollto')

License

MIT