JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 25
  • Score
    100M100P100Q40167F
  • License ISC

A handler for scrolling inside elements with different eases

Package Exports

  • scroll-manager

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

Readme

scroll-manager

stable

A handler for scrolling inside elements with different eases

var ScrollManager = require('scroll-manager');
this.scoller = new ScrollManager();
var options = {
    element: <some element>,
    offsetToScroll: <offset>,
    duration: <duration>,
    ease: <ease>
}

this.scoller.scrollTo(options, callback);

##Examples
###ScrollTo 

//This scroll the element to the offsetToScroll in the required duration with the default ease
this.scoller.scrollTo({element: document.body, to: 100, duration: 0.6});

//This scroll the element to the offsetToScroll in the required duration with the selected ease and finally execute the callback
this.scoller.scrollTo({element: document.body, to: 100, duration: 0.6, ease: 'easeOutCubic'}, callback);

###ScrollTop 

//This scroll the element to the top in the required duration with the selected ease and finally execute the callback
this.scoller.scrollTop({element: document.body, duration: 0.6, ease: 'easeOutCubic'}, callback);

###ScrollBottom 

//This scroll the element to the bottom in the required duration with the default ease
this.scoller.scrollBottom({element: document.body, duration: 0.6});

###ScrollEqual 

//If you want to scroll with the same velocity without taking into acount the distance you can use:
this.scoller.scrollEqual({element: document.body, velocity: 100, to: 100, ease: 'easeOutCubic'});  
//This is useful if you want the user feel the difference between short and long distances.

Available Eases

'easeLinear'
'easeInQuad'
'easeOutQuad'
'easeInOutQuad'
'easeInCubic'
'easeOutCubic'
'easeInOutCubic'

Note: If you dont choose any ease, easeLinear is going to be run.

Usage

NPM