jQuery cardslider

A simple and lightweight cardslider plugin. Take a look at the demo here.

setup

Include the basic html markup

<div class="my-cardslider">
	<ul>
		<li>card 1</li>
		<li>card 2</li>
	</ul>
</div>

Include the cardslider stylesheet, jQuery and the cardslider js files.

<link href="/cardslider.css" rel="stylesheet">
...
<script src="//code.jquery.com/jquery-2.2.2.min.js"></script>
<script src="/path/to/jquery.cardslider.min.js"></script>

Initialize the plugin. For more options see below

<script>
	$(function() {
		$('.my-cardslider').cardslider();
	});
</script>

cardslider needs a container which sizes the slider. The cards default to 80% width & height of this container. Modify it by setting width and height of the .cardslider__cards class.

.cardslider__cards {
    width: 50%;
    height: 50%;
}

options

keys

Type: object/bool Default: object, see example

set keys to navigate back and forth

keys: {
	next: 38,
    prev: 40
}

direction

Type: string Default: down

Set sliding direction. Possible values: up, down, right, left

nav

Type: boolDefault: true

Enable or disable the navigation

swipe

Type: bool Default: false

Enable or disable swiping on the cards

dots

Type: bool Default: false

Enable or disable the dot nav

loop

Type: bool Default: false

Enable or disable looping of the cards

showCards

Type: int Default: 0

Only show the first x cards, defaults to 0 which shows all cards

callback functions

beforeCardChange

Fires before the cards are changed. Takes the index of the current card as parameter

afterCardChange

Fires after the cards are changed. Takes the index of the next card as parameter

methods

Get cardslider instance

var cardslider = $('.my-cardslider').data('cardslider');

nextCard

Slide to the next card

prev card

Slide to the previous card

changeCardTo

Parameters: int/string

Slide to given index or strings(first, last)

destroy

Destroys the cardslider. Removes all appended styles and classes