Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 2 KB

README.md

File metadata and controls

72 lines (48 loc) · 2 KB

Carusela.js

Overflow scroll based carousel, aiming for minimalist JS code manipulations by using CSS 'scroll' as animation in order to get most native like feeling in both desktop and mobile touch enabled devices.

Check out the demo page

Demo

Features

  • Back & forward buttons
  • Using -webkit-overflow-scrolling for momentum scrolling
  • RTL support (rtl as default)
  • Handle with touch devices
  • Smooth scrolling
  • Fold scrolling
  • Toggle backward button display

Getting Started

Install

Add to your code the carusela.js and carusela.css files.

<link href="path-to-your-file/carusela.css" type="text/css" rel="stylesheet"/>
<script src="path-to-your-file/carusela.js"></script>

With Bower

bower install walla-carusela

Initialize the Carusela class with any DOM element that contains any number of direct children.

var carusela = new Carusela().init();

Set html

<ul id="demo">
    <li><img src="http://www.walla.co.il/images/apple/common-color-1.png" alt="Slide #1">
    <li><img src="http://www.walla.co.il/images/apple/common-color-2.png" alt="Slide #2">
    <li><img src="http://www.walla.co.il/images/apple/common-color-3.png" alt="Slide #3">
    <li><img src="http://www.walla.co.il/images/apple/common-color-4.png" alt="Slide #4">
</ul>

Optional

var carusela = new Carusela({
    direction: 'ltr',             =>     rtl / ltr         (string)   
    scrollingPer : 'element',     =>     fold / element    (string) 
    toggleBackward : true         =>     true / false      (boolean)
}).init();

Roadmap

Stuff we need to add...

  • Add build
  • Add tests

Follow Us