1.0.5 • Published 7 years ago

jquery-slideshow v1.0.5

Weekly downloads
5
License
MIT
Repository
github
Last release
7 years ago

jQuery Slideshow

Simple jQuery slideshow library. Lightweight, responsive, easy to implement & configure.

npm version

Demo

http://www.sjoloughlin.com/jquery-slideshow

Installation

Download

Get the latest release from the releases page and add the files to your project.

Link the stylesheet inside your <head> tag:

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

Then, before your closing <body> tag add:

<script type="text/javascript" src="slider.min.js"></script>

NPM

npm install jquery-slideshow

Usage

Add the following HTML for the slider:

<ul class="slider">
  <li>
    <img src="img/slide1.jpg" alt="slide1"/>
  </li>
  <li>
    <img src="img/slide2.jpg" alt="slide2"/>
  </li>
  <li>
    <img src="img/slide3.jpg" alt="slide3"/>
  </li>
</ul>

Then, before your closing <body> call .slider() on the slider element:

<script type="text/javascript">
  $(window).on("load", function() {
    $(".slider").slider();
  });
</script>

Configuration

The slider is configurable by passing in a configuration object when calling .slider() on the slider element:

<script type="text/javascript">
  $(window).on("load", function() {
    $(".slider").slider({
      width  : '1024px', // Width of the slider
      height : '500px',  // Height of the slider
      speed  : 2000,     // How long the slide animation transition lasts for in millisecond
      delay  : 5000      // How long the slide will be displayed for in milliseconds
    });
  });
</script>

Options

ConfigTypeDefaultDescription
speedint1000How long the slide animation transition lasts for in milliseconds e.g. 1000 = 1 second
delayint3000How long the slide will be displayed for in milliseconds e.g. 3000 = 3 seconds
autoplaybooleantrueWhether to start the slideshow automatically
navigationbooleantrueWhether to display left/right navigation buttons
paginationbooleantrueWhether to display clickable slide indicators
widthstring100%Width of the slider
heightstringautoHeight of the slider
directionstringrightThe direction that the slider will slide
responsivebooleantrueWhether to make the size of the slider responsive

License

This project is licensed under the MIT License - see the LICENSE.md file for details.