A jQuery plugin for a slider with adaptive colored figcaption and navigation.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
demo
dist
src
.gitignore
.jshintrc
CONTRIBUTING.md
Gruntfile.js
HISTORY.md
LICENSE
README.md
adaptiveslider.jquery.json
bower.json
package.json

README.md

Adaptive Slider jQuery Plugin

A jQuery plugin for a slider with adaptive colored figcaption and navigation.

This plugin will take a list of figure elements containing an image and a figcaption element and automagically insert navigation and color the figcaption background color and the navigation according to the main color found in the current image in the slider/carousel.

#Demo

Author: Creative Punch

Installation

You can get this plugin either through the repository, or with Bower

bower install adaptiveslider

Usage

First, be sure to add rgbaster.js and jQuery to your project. Next, make sure you have a list of images, with a figure element inside of the list item and a figcaption containing a description.

  <ul class="adaptive-slider">    
    <!-- Slider Item -->
    <li>
      <figure>
        <img src="images/4.jpg">
        <figcaption>
          <h1>Lorem Ipsum</h1>
          <p>
            Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
          </p>
        </figcaption>
      </figure>
    </li>
    <!-- End Slider Item -->
    ...
  </ul>

Now you can simply initialize the slider with the following JavaScript:

$(function() {
	$('.adaptive-slider').adaptiveSlider({
		opacity: 0.7,
		normalizedTextColors: {
			light: '#f1f1f1',
			dark: '#222'
		}
	});
});

Both of the options are optional. Let's go over them!

Options

opacity: This will allow you to set the opacity of the figcaption. This defaults to 1 (full opacity)

normalizedTextColors: An array. This allows you to configure what color the light text (on a dark background) should have, and vice versa.

Contributing

Feel free to contribute by forking this project and sending me a pull request!

Todos

  • Make it responsive!
  • Add options for more slider animations other than fade

License

MIT License