Skip to content

Latest commit

 

History

History
executable file
·
124 lines (104 loc) · 3.56 KB

readme.md

File metadata and controls

executable file
·
124 lines (104 loc) · 3.56 KB
Raw

Wheelz

Fun, acceleration based scroller. Animates and smoothens the scroll of element content. Uses native scroll, so any scroll events on the element will work as expected by default.
Demo here

Installation

Include Wheelz with scripts tag

<script src="./dist/wheelz.min.js"></script>

or with npm and import

npm install wheelz --save
// import needed modules from npm
import Wheelz from 'wheelz';

Options

Wheelz accepts several options defined as follows.

var options = { option: "value" }
var wheelz = new Wheelz(options);

friction

Recommended value 0-1. Default value is 0.3.

acceleration

Recommended value 0-1. Default value is 0.04.

preset

Sets the friction and acceleration to the proposed values.
Available values:
normal = f0.5, a0.2
smooth = f0.3, a0.04
instant = f0.55, a0.4
bounce = f0.3, a0.08
slow = f0.3, a0.02

var wheelz = new Wheelz({
    preset: "smooth"
});

draggable

Makes the are of scrolled element draggable with mouse. Can be set to true or false.

var wheelz = new Wheelz({
    draggable: false
});

Events

Wheelz emits a bunch of events while it works. You can subscribe to events with on and off methods.

// init
var wheelz = new Wheelz();

// set handler
wheelz.on('scroll', function () {
    // do something on every animation tick
});

wheelz.off('scroll', handler); // removes single handler
wheelz.off('scroll'); // removes all handlers for 'tick' event
wheelz.off(); // removes all handlers

List of all events

  • click - triggered on click of the root element
  • disable - triggered before disabling Wheelz (with disable method)
  • drag - triggered when on every tick of dragging
  • dragEnd - triggered when drag on root element ends
  • dragStart - triggered when drag on root element starts
  • hitBottom - triggered when scroll hits bottom
  • hitTop - triggered when scroll hits top
  • pointerDown - triggered when mouse is pressed over a root element
  • pointerEnter - triggered when mouse cursor enters a root element
  • pointerUp - triggered when press ends
  • pointerLeave - triggered when mouse cursor leaves root element
  • resize - triggered on window resize
  • stabilized - triggered when scroll ends (values of actual scrollTop and animated scroll are at the same value)
  • scroll - triggered on every tick of scroll animation
  • scrollStart - triggered when scroll starts
  • scrollEnd - triggered when scroll ends (same as stabilized... only for clarity)
  • wheel - triggered on mouse wheel over the root element

Plugins

Plugins use wheelz events to modify the visual appearance of scroll. Plugins can also be imported from npm or loaded with script tag.

<script src="./dist/plugins/pluginName.min.js"></script>

or with npm and import

// import needed modules from npm
import pluginsName from 'wheelz/plugins/pluginsName';

addScrollbar

Scrollbar adds scrollbar visualising both, the actual scrollTop value and the scrollTop animated value of wheelz. Scrollbar styles are inserted at the top of head tag, so styles can be rewritten with any styles included afterwards.

Usage:

var wheelz = new Wheelz();
addScrollbar(wheelz);

delayItems

Creates effect of delayed items, similar to one seen in Apple iOS iMessage application.

Usage:

var wheelz = new Wheelz();
delayItems(wheelz);