npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

scroll

3.0.1 • Public • Published

scroll

animates the scroll top/left position of an element (in 340 bytes)

browser support

note: you may need to polyfill requestAnimationFrame in older browsers

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.

obey

MIT

Keywords

none

install

npm i scroll

Downloadsweekly downloads

61,484

version

3.0.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability