README.md

jcarouselSwipe plugin

Adds support user-friendly swipe gestures.

Features

• user-friendly swipe gestures works
• work with any wrap option(both, first, last, circular)
• work with vertical carousels
• easy to use

Requirments

• jQuery
• jquery.jcarousel-core.js(minimum) also you may use bundle version: jquery.jcarousel.js

How to use

To use the plugin include jquery, jcarousel and jcarouselSwipe source files into your HTML document:

<script type="text/javascript" src="js/jquery.min.js"></script>
<script type="text/javascript" src="js/jquery.jcarousel.min.js"></script>
<script type="text/javascript" src="js/jquery.jcarousel-swipe.min.js"></script>

and init the plugin:

$('.jcarousel')
    .jcarousel()       // init jcarousel
    .jcarouselSwipe(); // init jcarouselSwipe

Options

perSwipe

It means how many slides will be scrolls at a go.

$('.jcarousel').jcarouselSwipe({
    perSwipe: 3 // by default 1
});

draggable

On/off dragging items on swipe.

$('.jcarousel').jcarouselSwipe({
    draggable: false // by default true
});

method

What method should used to switch slides.

$('.jcarousel').jcarouselSwipe({
    method: 'scrollIntoView' // by default 'scroll'
});

node.js usage

#####Installation npm install snake-345/jcarouselSwipe

#####Usage

var jcarouselSwipe = require('jcarouselSwipe');

Examples

You can find examples in the corresponding directory. I'm included my plugin in all jcarousel examples and added vertical carousel example.

License

Copyright (c) 2015-2016 Evgeniy Pelmenev. Released under the MIT license.