scroll
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/scroll package

    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

    140,048

    Version

    3.0.1

    License

    MIT

    Unpacked Size

    6.25 kB

    Total Files

    5

    Last publish

    Collaborators

    • michaelrhodes