The setup.
Include jquery.skippr.css inside your head tag and jquery.skippr.js just before the closing body tag.
Be sure to include jQuery before jquery.skippr.js
<head>
<title>Your Awesome Website</title>
<link rel="stylesheet" href="css/jquery.skippr.css">
</head>
<body>
<script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
<script src="js/jquery.skippr.js"></script>
</body>
Create a target element with divs inside, one for each slide, and add a background image with css or the style attribute. Skippr targets div tags inside of the selected element with background-images applied to them. Put this target element inside of a container element styled and positioned to your liking. The target element will completely fill it's parent container element.
**Note: The container element must have a specified width and height, and position other than static to work properly.
<div id="container">
<div id="theTarget">
<div style="background-image: url(img/image1.jpg)">
<div style="background-image: url(img/image2.jpg)">
<div style="background-image: url(img/image3.jpg)">
<div style="background-image: url(img/image4.jpg)">
<div style="background-image: url(img/image5.jpg)">
</div>
</div>
Initiate.
Just select the parent element with jQuery and call the skippr method. Thats it!
$(document).ready(function(){
$("#theTarget").skippr();
});
Options.
Pass in an options object as a parameter to the skippr method for customization.
// Defaults
$("#theTarget").skippr({
speed: 500,
navType: 'block',
childrenElementType: 'div',
arrows: true,
autoPlay: false,
autoPlayDuration: 5000
});
speed : enter length of time in milliseconds you want the transition between slides to take. Default is 500.
navType : enter a string of what shape you want the navigation elements to be. Skippr currently takes either "block" or "bubble". Default is "block".
childrenElementType : choose the children element type of the target element. Skippr now accepts either 'div' or 'img'. Default is 'div'.
arrows : boolean value determining whether or not to display navigation arrows. Default is true. Set to false to hide arrows.
autoPlay : boolean value determining whether or not to use auto-playing functionality in the slideshow. Default is false. Set to true to activate auto-play.
autoPlayDuration new : sets the amount of time in milliseconds to display each slide when autoPlay is running. Default is 5000 milliseconds.
Skippr will be an ongoing project.
Check back or star on Github for updates.