A jQuery-based script for responsive carousels that work with mouse, touch, and keyboard
JavaScript
Switch branches/tags
Nothing to show
Pull request Compare This branch is 2 commits ahead, 180 commits behind filamentgroup:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
libs
src
test
.gitignore
.travis.yml
LICENSE-GPL
LICENSE-MIT
README.md
grunt.js
package.json

README.md

Responsive Carousel

A jQuery-based script for responsive carousels that work with mouse, touch, and keyboard

Build Status

Getting Started

Download the production version or the development version.

In your web page:

<script src="jquery.js"></script>
<script src="dist/responsive-carousel.min.js"></script>
<link href="src/responsive-carousel.css" rel="stylesheet">

<div class="carousel">
	<div>
		<!-- carousel item content here -->
	</div>
	<div>
		<!-- carousel item content here -->
	</div>
</div>

The default build includes the slide/drag transition that you can apply by adding a data attribute and including some additional CSS.

<script src="jquery.js"></script>
<script src="dist/responsive-carousel.min.js"></script>
<link href="src/responsive-carousel.css" rel="stylesheet">
<link href="src/responsive-carousel.slide.css" rel="stylesheet">

<div class="carousel" data-transition="slide">
	<div>
		<!-- carousel item content here -->
	</div>
	<div>
		<!-- carousel item content here -->
	</div>
</div>

Extended features

There are other extensions in the src folder, such as flip and fade transitions, autoplay, keyboard handling, pagination, and more. If you'd like to create a build that includes certain extensions, just add them to the JS files listed under concat in the /grunt.js file, and run grunt from a command line.

Demos

Check out the test/functional/ directory for demos.

Documentation

(Coming soon)

Examples

Check out the test/functional/ directory for examples.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Also, please don't edit files in the "dist" subdirectory as they are generated via grunt. You'll find source code in the "src" subdirectory!

Release History

(Nothing yet)

License

Copyright (c) 2012 Filament Group, Inc.
Licensed under the MIT, GPL licenses.