README.md

Quick start

This is the basic HTML structure required (element agnostic):

<div class="rs-carousel">
    <ul class="rs-carousel-runner">
        <li class="rs-carousel-item">
            <!-- item 1 content -->
        </li>
        <li class="rs-carousel-item">
            <!-- item 2 content -->
        </li>
        <li class="rs-carousel-item">
            <!-- item 3 content -->
        </li>
        <li class="rs-carousel-item">
            <!-- item 4 content -->
        </li>
        <li class="rs-carousel-item">
            <!-- item 5 content etc. -->
        </li>
    </ul>
</div>

Here's the JavaScript:

$(document).ready(function () {
    $('.rs-carousel').carousel();
});

And here's the generated markup:

<div class="rs-carousel">
    <div class="rs-carousel-mask">
        <ul class="rs-carousel-runner">
            <li class="rs-carousel-item">
                <!-- item 1 content -->
            </li>
            <li class="rs-carousel-item">
                <!-- item 2 content -->
            </li>
            <li class="rs-carousel-item">
                <!-- item 3 content -->
            </li>
            <li class="rs-carousel-item">
                <!-- item 4 content -->
            </li>
            <li class="rs-carousel-item">
                <!-- item 5 content etc. -->
            </li>
        </ul>
    </div>
    <ol class="rs-carousel-pagination">
        <li class="rs-carousel-pagination-link rs-carousel-pagination-link-active"><a href="#page-1">1</a></li>
        <li class="rs-carousel-pagination-link"><a href="#page-2">2</a></li>
    </ol>
    <a class="rs-carousel-action-prev" href="#">Previous</a>
    <a class="rs-carousel-action-next rs-carousel-action-disabled" href="#">Next</a>
</div>

DOCS

Overview

This is a rewrite of jQuery Carousel leveraging jQuery UIs Widget Factory.

Options

itemsPerPage: 'auto' (string, number)

Sets the number of items shown on each page, if set to 'auto' the number of items will be calculated based on width of mask.

itemsPerTransition: 'auto' (string, number)

Sets the number of items to scroll per transition, if set to 'auto' the number of items will match itemsPerPage.

orientation: 'horizontal' (string)

Sets the orientation of the carousel, either 'horizontal' or 'vertical'.

loop: false (boolean)

If set to true carousel will loop back to first or last page accordingly.

nextPrevActions: true (boolean)

Sets whether the next and prev actions are included, next and prev actions are inserted as anchor tags.

insertPrevAction: function () { return $('Previous').appendTo(this); } (function)

Allows you to define the prev actions mark-up as well as its location in the DOM.

The context of the function will be the carousel element, e.g.

function () {
    // this === <div class="rs-carousel"></div>
}

insertPrevAction: function () { return $('Next').appendTo(this); } (function)

Allows you to define the prev actions mark-up as well as its location in the DOM.

The context of the function will be the carousel element, e.g.

function () {
    // this === <div class="rs-carousel"></div>
}

pagination: true (boolean)

Sets whether pagination links should be included, pagination links are constructed as an ordered list.

insertPagination: function (pagination) { return $(pagination).insertAfter($(this).find('.rs-carousel-mask')); } (function)

Allows you to override where in the DOM the pagination links are inserted as well as decorate them with any required Html.

The context of the function will be the carousel element, e.g.

function (pagination) {
    // this === <div class="rs-carousel"></div>
    // pagination === <ol class="rs-carousel-pagination"> ... </ol>
}

speed: 'normal' (string)

Sets the speed of the carousel.

easing: 'swing' (string)

Sets the easing equation used.

disabled: false (boolean)

If set to true carousel will no longer change state.

autoScroll: false (boolean)

Set to true to invoke auto scrolling, note when the mouse enters the carousel the interval will stop, it'll consequently begin when the mouse leaves.

NOTE: Requires the autoScroll extension (jquery.rs.carousel-autoscroll.js).

pause: 8000 (number)

Sets the amount of time in miliseconds the carousel waits before it automatically scrolls.

NOTE: Requires the autoScroll extension (jquery.rs.carousel-autoscroll.js).

continuous: false (boolean)

If set to true the carousel will continuously loop through its pages.

NOTE: Requires the continuous extension (jquery.rs.carousel-continuous.js).

Events

create: null (function)

Fired on first call.

It can be passed in the options object like this:

$('.rs-carousel').carousel({
   beforeAnimate: function(event, data) { ... }
});

or bound to as an event like this:

$('.rs-carousel').bind("carouselbeforeAnimate", function(event, data) {
    ...
});

before: null (function)

Fired before transition.

It can be passed in the options object like this:

$('.rs-carousel').carousel({
    before: function(event, data) { ... }
});

or bound to as an event like this:

$('.rs-carousel').bind("carouselbefore", function(event, data) {
    ...
});

data provides access to the carousels core elements and indicates whether the transition was animated:

{
    animate: (boolean),
    elements: {
        mask: (jQuery object)
        runner: (jQuery object)
        items: (jQuery object)
        pagination: (jQuery object)
        nextAction: (jQuery object)
        prevAction: (jQuery object)
    }
}

after: null (function)

Fired after transition.

It can be passed in the options object like this:

$('.rs-carousel').carousel({
    after: function(event, data) { ... }
});

or bound to as an event like this:

$('.rs-carousel').bind("carouselAfter", function(event, data) {
    ...
});

data provides access to the carousels core elements and indicates whether the transition was animated:

{
    animate: (boolean),
    elements: {
        mask: (jQuery object)
        runner: (jQuery object)
        items: (jQuery object)
        pagination: (jQuery object)
        nextAction: (jQuery object)
        prevAction: (jQuery object)
    }
}

Methods

next .carousel('next')

Moves to the next page.

prev .carousel('prev')

Moves to the prev page.

goToPage .carousel('goToPage', page, [animate])

Moves to the specified 'page' (one based). If animate is set to false it'll jump straight there.

goToItem .carousel('goToItem', item, [animate])

Moves to page containing item, item can be a one based number, a vanilla DOM element or a jQuery object. If animate is set to false it'll jump straight there.

getNoOfItems .carousel('getNoOfItems')

Returns current number of items in carousel.

getNoOfPages .carousel('getNoOfPages')

Returns the number of pages.

getItemsPerPage .carousel('getItemsPerPage')

Returns the number items per page.

getItemsPerTransition .carousel('getItemsPerTransition')

returns the number items per transition

add .carousel('add', items)

Appends items to carousel, items can be DOM element, HTML string, or jQuery object.

remove .carousel('remove', selector)

Removes matched elements from the carousel.

refresh .carousel('refresh')

Refreshes carousel based on new state.

getPage .carousel('getPage')

Returns current page.

getPrevPage .carousel('getPrevPage')

Returns previous page.

getPages .carousel('getPages')

Returns pages array. e.g. [1, 5, 9, 13] // where the index + 1 === page number and the value === index of first item in page.

option .carousel('option', optionName, [value])

Get or set any carousel option. If no value is specified, will act as a getter.

option .carousel('option', options)

Set multiple carousel options at once by providing an options object.

disable .carousel('disable')

Disables the carousel.

enable .carousel('enable')

Enables the carousel.

widget .carousel('widget')

Returns the .rs-carousel element.

destroy .carousel('destroy')

Removes the carousel functionality completely. This will return the element back to its pre-init state.

If you have any questions or ideas you can contact me here.