Skip to content

Latest commit

 

History

History
88 lines (70 loc) · 2.75 KB

README.markdown

File metadata and controls

88 lines (70 loc) · 2.75 KB
Raw

Excolo Slider

A simple jquery sliding plugin, supporting responsive design, keyboard and touch navigation.

Under development. I'll post future features and enhancements, in the issue tracker.

Should you find bugs or want to suggest a feature, feel free to post it in an issue. :-)

Features:

  • AutoPlay Slideshow
  • Mouse slide navigation
  • Prev/next button navigation
  • HTML5 data-attribute captions
  • Pagination
  • Repeat when last slide is reached
  • Play the slideshow backwards
  • Auto adjust size initially and on browser resize, for responsive designs
  • Touch enabled (limited to a few browsers)

Most of these features can be configured and turned off, when setting up the slider.

Installation

Installation can be done using NuGet Package Manager, either by using the console, as seen below, or by searching for the package in the Visual Studio package explorer:

PM> Install-Package excolo-slider

Then in the header of your website, you insert the references to jquery and the slider plugin:

<script src="Scripts/jquery-1.9.1.min.js"></script>
<script src="Scripts/jquery.excoloSlider.min.js"></script>
<link href="Content/jquery.excoloSlider.css" rel="stylesheet">

The HTML code for the slides is simply a div container, with any child objects being the slides:

<div id="slider">
  <img src="images/image1.jpg" />
  <img src="images/image2.jpg" />
  <img src="images/image3.jpg" />
  <img src="images/image4.jpg" 
    data-plugin-slide-caption="I am a caption <b>and I can contain HTML.</b>" />
  <img src="images/image5.jpg" />
  <img src="images/image6.jpg" />
  <img src="images/image7.jpg" />
  <div>
    <h2>This is the last slide</h2>
    <img style="width: 50%: float: right;" src="images/image8.jpg" />
  </div>
</div>

Notice how you can use the HTML5 data-attribute data-plugin-slide-caption to create a caption text for each slide. These captions allow HTML and can be fully styled using css.

Then to initialize the slider plugin with default settings you insert the script:

$(function () {
    $("#slider").excoloSlider();
});

For installation without NuGet see our GitHub page

Configuration

Configuration can be seen on our GitHub page

Examples

Examples can be seen on our GitHub page

Relative Project

License

Free for both personal and commercial use.

Copyright (c) 2013 Nikolaj Dam Larsen. Released under the MIT license.