playrr.js

A fast, simple and effective slideshow jQuery plugin that just works.

Download Star

How to use it?

Initialization

Just include the playrr.min.css and playrr.min.js and jQuery into your awesome website and you're good to go. Insert the CSS file like this

<link rel="stylesheet" type="text/css" href="../dist/playrr.min.css">

And the jQuery and plugin like this

<script src="http://code.jquery.com/jquery-2.2.1.min.js" type="text/javascript"></script> 
<script src="../dist/playrr.min.js" type="text/javascript"></script>

Create a wrapper div with an id name of "playrr" and add more divs into it with the class of "slide" into it. Add your images in the "slide" divs. Just like this

<div id="playrr">
    <div class="slide"><img src="assets/images/1.jpg"></div>
    <div class="slide"><img src="assets/images/2.jpg"></div>
    <div class="slide"><img src="assets/images/3.jpg"></div>
    <div class="slide"><img src="assets/images/4.jpg"></div>
    <div class="slide"><img src="assets/images/5.jpg"></div>
    <div class="slide"><img src="assets/images/6.jpg"></div>
    <div class="slide"><img src="assets/images/7.jpg"></div>
</div>

Call the Plugin

$('#playrr').playrr();

It comes with some options

Option Name	Description	Default	Option
autoPlay	When enabled, plays the slideshow automatically	true	false
timer	Sets the timer for the autoPlay method.	2000	time in ms
showControls	Constructs the controls for the playrr slideshow.	true	false
arrows	Constructs the navigational arrows.	true	false

Using the options

$('#playrr').playrr({
    autoPlay : true,
    timer : 3000,
    showControls : false
});

Notes

It will be an ongoing project. Expect more options like more transition types.

Credits

Made by Haider Ali Khichi in Lahore, Pakistan. It is my first jQuery plugin. So please critique it and pull requests are very welcomed.

This project is maintained by candh

Follow @candh

Playrr.js