node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

scroll

scroll

A function that animates an element’s scrollTop or scrollLeft position.

Browser support

install

$ npm install scroll

use

var scroll = require('scroll')
var page = require('scroll-doc')()
var ease = require('ease-component')
 
// Basic usage
scroll.left(page, 200)
 
// Register a callback
scroll.top(page, 200, function (err, scrollTop) {
  console.log(err)
  // { message: "Scroll cancelled" } or
  // { message: "Element already at target scroll position" } or
  // null
 
  console.log(scrollTop)
  // => The new scrollTop position of the element
  // This is always returned, even when there’s an `err`.
})
 
// Specify a custom easing function
scroll.left(page, 200, { ease: ease.inBounce })
 
// Specify a duration in milliseconds (default: 350) and register a callback.
scroll.left(page, 200, { duration: 1000 }, function (err, scrollLeft) {
})
 
// Cancel a scroll animation
var options = { duration: 1000 }
var cancel = scroll.top(page, 200, options, function (err, scrollTop) {
  console.log(err.message)
  // => Scroll cancelled
 
  page.removeEventListener('wheel', cancel)
})
 
page.addEventListener('wheel', cancel)

Note: The default easing is inOutSine from component/ease.

compression size
scroll.js 2.86 kB
scroll.min.js 1.71 kB
scroll.min.js.gz 764 B

obey

MIT