/jQuery-Assisted-Scroll

Utilize your mousewheel to scroll through slides.

Primary LanguageJavaScriptMIT LicenseMIT

Assisted Scroll

Utilize your mousewheel to scroll through slides.

Requirements

Options

startingZ     {integer}     default: undefined     Additional Z-Index for each slide (see demo)
delay         {integer}     default: 500 (ms)      The duration of your CSS transitions (prevents transitioning until finished)

Implementation

$(function() {
    $("#slides").assistedScroll({
    	delay: 500,   // Lines up with our CSS transitions
        startingZ: 10 // Slides should start being indexed at 10
    });
});

API

A simple API is provided so you can add your own swipe/touch bindings

$(function() {
    var assistedScroll = $("#slides").assistedScroll().data("assistedScroll");

    // Next Slide
    assistedScroll.next();

    // Previous Slide
    assistedScroll.prev();
});

Contributing

This project utilizes Grunt JS to compile/minify javascripts. If you haven't already, read the getting started guide. After Grunt has been installed, open your terminal, and cd into the project directory. Then:

$ sudo npm install
$ grunt

Running grunt will minify javascripts, and place them in the correct directories, once. If you would like to "watch" for changes as you work, run grunt watch.