Prototype Carousel

Original code by Victor Stanciu Original project url: http://code.google.com/p/prototype-carousel/

Description

Carousel is a highly configurable Prototype.js extension that creates a nice way of presenting content that is logically broken into several pieces / steps / etc. It's:

• Lightweight - 12 KB
• Cross-browser - Tested on Internet Explorer 6/7/8, Firefox 2/3, Google Chrome, Opera 9.64

Modifications of the Original Code

This version features customizable button disabling when you're at the first and last slide, and a new type of transition animation called "phase".

Examples

Original examples available at http://dev.victorstanciu.ro/prototype/carousel/.

A simplified example is also included in the example folder.

Requirements

Carousel.js needs both the Prototype JavaScript framework and the Script.aculo.us effects library to work.

Usage

• Download carousel.js

• Include the script in your page, after the Prototype and Script.aculo.us libraries:

Markup

The minimum markup is:

<div id="carousel-wrapper">
    <div id="carousel-content">
        <div class="slide"></div>
        <div class="slide"></div>
        ...
        <div class="slide"></div>
    </div>
</div>

And the minimum styling is:

#carousel-wrapper {
    width: 500px;
    height: 500px;
    overflow: hidden;
}
#carousel-content {
    width: 2500px; /* should be the total space needed for all slides */
}
#carousel-content .slide {
    float: left;
    width: 500px;
    height: 500px;
}
.control-dead {
    visibility: hidden; /* hides inactive controls */
}

This will generate a 500x500px Carousel with horizontal movement. Switching to vertical movement is as simple as setting #carousel-content's width to 500px, the width of a single slide.

Initialization

You initialize the Carousel by:

new Carousel(wrapper, slides, triggers, {options});

Example for the markup above:

new Carousel('carousel-wrapper', $$('#carousel-content .slide'), $$('#carousel-content a.carousel-control', '#carousel-content a.carousel-jumper'));

Triggers

There are two categories of elements that trigger the carousel's movement: the ones that trigger a direct jump to a selected slide (jump to slide "x"), and the ones that start a relative jump (jump to first/last/previous/next slide). The combination of a trigger's rel and class attributes decide the Carousel's behavior. For example, clicking on:

<a href="javascript:" class="carousel-jumper" rel="slide-1">Jump to slide 1</a>

Will jump to the slide that has the id "slide-1". And:

<a href="javascript:" class="carousel-control" rel="prev">Previous slide</a>

Will jump to the previous slide. Available options for the rel attribute are first, last, prev and next.

Using Multiple Carousels on the Same Page

You can use multiple carousels on the same page. Simply give each carousel its own id names.

new Carousel('carousel-1', $$('#carousel-1-content .slide'), $$('#carousel-1-content a.carousel-control', '#carousel-1-content a.carousel-jumper'));

new Carousel('carousel-2', $$('#carousel-2-content .slide'), $$('#carousel-2-content a.carousel-control', '#carousel-2-content a.carousel-jumper'));

A common mistake is to only use a.carousel-control in the initializers, which causes any one control to change all the slides on the page. (Of course, if that's your goal go ahead and do that.).

Available Options

Options are given as the last parameter in the initialization as hash: {option: value, option: value}