simple.carousel
Copyright (c) 2015 Tobias Zeising, http://www.aditu.de
Licensed under the MIT license
Version 0.3
This is a simple jQuery plugin for creating sliding carousels.
Demo/Examples
simple demo
aditu.de (image will change using a fade in/fade out effect)
rsslounge (presentation of the features by an slideshow)
Usage
Insert following in the head part of your html page:
<script type="text/javascript" src="https://github.com/SSilence/simple.carousel/raw/master/javascript/jquery-1.8.3.min.js"></script>
<script type="text/javascript" src="https://github.com/SSilence/simple.carousel/raw/master/javascript/simple.carousel.0.3.js"></script>
<script type="text/javascript">
jQuery(document).ready(function() {
// initialize carousel
$("#carousel").simplecarousel({
next: $('.next'),
prev: $('.prev'),
slidespeed: 700,
auto: 5000,
width: 480,
height: 280
});
});
</script>
This will change following html structure
<ul id="carousel">
<li>first frame (e.g. an image)</li>
<li>second frame (e.g. an image)</li>
<li>third frame (e.g. an image)</li>
...
</ul>
into a slider
Parameters
| parameter | type | outcome |
|---|---|---|
| width | int | width of the single frames |
| height | int | height of the frames |
| next | jQuery Objekt/Selector | clicking on this object will show the next frame (for next button) |
| prev | jQuery Objekt/Selector | clicking on this object will show the previous frame (for prev button) |
| vertical | boolean | vertical sliding; false = horizontal sliding |
| auto | int/boolean | false = no automatic sliding; Value in milliseconds = time between two frames |
| slidespeed | int | speed of the sliding effect in milliseconds |
| visible | int | amount of frames which are visible |
| fade | int | use a fade out/fade in effect instead of the sliding effect. false = use sliding effect; time in milliseconds will activate the fadein/fadeout and set the speed of this effect |
| pagination | int | set true for this value and a pagination element will be included |
| pauseOnclick | int | A boolean that when true pauses the automatic sliding when user clicks in the current visible content. The default value is false. |
| paginationItem | int | A function which takes the item index as paramter and returns a string which will fill the button element. The default value is function( i ) { return ''; } |
Example
$("#carousel").simplecarousel({
next: $('.next'),
prev: $('.prev'),
auto: 4000,
fade: 400
});
Will create a carousel with fadein/fadeout effect. The pause between two frames will be 4 seconds, the speed of the fade effect will be 400 ms, the element with the class 'next' will be the next button (the same with 'prev' for back button). See download for further examples.