Package Exports

@robinnnnn/scroll-to

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 (@robinnnnn/scroll-to) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

scroll-to

Smooth window scroll to position with requestAnimationFrame and Tween.

Installation

$ npm install @robinnnnn/scroll-to

API

scrollTo(x, y, [options])

Scroll to the given point (x, y) with the given options:

ease easing function defaulting to "out-circ" (view ease for more)
duration animation duration defaulting to 1000 milliseconds
cancelOnUserScroll cancels scrolling animation when user interruption is detected; defaults to false

var scrollTo = require('scroll-to');

scrollTo(500, 1200, {
  ease: 'out-bounce',
  duration: 1500,
  cancelOnUserScroll: true
});

License

MIT