1.0.0 • Published 10 years ago
scroll-speed v1.0.0
scroll-speed
Get the scroll speed being used on either the window or a particular element.
Usage
speed = scroll(element, preventDefault)
Listens to element
for scroll events. If you don't supply an element, this
will default to window
. Pass preventDefault
as true
to override the
default scrolling behavior.
speed.on('scroll', callback(event))
Calls callback
whenever a scroll event is captured, passing a normalized
wheel
event for you to read from.
speed.flush()
You need to call at the end of each frame for the module to work properly – we
need to cater to the possibility of multiple events per frame. Stick this at
the end of your requestAnimationFrame
or setInterval
loop.
speed0
The horizontal speed of the scroll.
speed1
The vertical speed of the scroll.
speed2
The depth speed of the scroll – you never know!
License
MIT. See LICENSE.md for details.