https://github.com/sebobo/jquery.rondell

A jQuery plugin for displaying stuff in a highly customizable carousel.
https://github.com/sebobo/jquery.rondell

Last synced: about 1 year ago
JSON representation

A jQuery plugin for displaying stuff in a highly customizable carousel.

• Host: GitHub
• URL: https://github.com/sebobo/jquery.rondell
• Owner: Sebobo
• License: mit
• Created: 2011-02-27T16:23:34.000Z (over 15 years ago)
• Default Branch: master
• Last Pushed: 2018-05-24T15:16:04.000Z (about 8 years ago)
• Last Synced: 2025-01-28T09:45:14.823Z (over 1 year ago)
• Language: HTML
• Homepage: http://projects.sebastianhelzle.net/jquery.rondell/
• Size: 3.96 MB
• Stars: 54
• Watchers: 7
• Forks: 11
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: MIT-LICENSE.txt

Awesome Lists containing this project

README

          
[![Stories in Ready](https://badge.waffle.io/sebobo/jquery.rondell.png?label=ready&title=Ready)](https://waffle.io/sebobo/jquery.rondell)

jQuery Rondell

=============

This is a [jQuery](http://www.jquery.com) plugin for displaying galeries and other content.

See the [documentation page](http://sebobo.github.com/jquery.rondell/) for a live demo and examples.

Do you like this project?

[Buy me a beer](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TSN2TDYNKZHF4)

Installation

------------

### Prequisites

 * [jQuery](http://www.jquery.com) - 1.5.2 or better

 * [Modernizr](http://www.modernizr.com) - This library tests the browser for feature support and adds classes to the body tag. We use this for css fallbacks in our themes.

Both are also provided in the `libs` folder.

If you don't want to use the `Modernizr` library you can remove the `.cssgradients`, `.borderradius`, `.rgba` and `.boxshadow` classes in `css/jquery-rondell.css`.

### Required files

Copy `dist/jquery-rondell.js` to your javascript folder.

Copy `dist/jquery-rondell.css` to your css folder.

There are also minified files in the `dist` folder.

Usage

-----

If you like demos more than a boring documentation see the `index.html` file and play with it.

The plugin can be called with jQuery in different ways.

### Standard call with default settings:

    $('.myElement').rondell();

Where `myElement` is the class of the items you want to display as rondell.

#### Rondell content

If `myElement` is an image, it is directly used and the title will be used as text overlay when hoverd.

### Options

See the [documentation page](http://projects.sebastianhelzle.net/jquery.rondell/) for the options.

Editing

-------

Read this chapter if you want to modify or extend the rondell.

The plugin is written in [coffeescript](http://jashkenas.github.com/coffee-script/) and the css with [sass](http://sass-lang.com/).

The sources are provided in the `src` folder.

So you can either work with the compiled `.js` and `.css` files in your project or use the coffeescript and sass files.

I have provided a `Gruntfile` which starts the watcher daemons, when your editing .scss, .jade and .coffee files.

This requires node.js and coffeescript installed on your computer.

Feedback

--------

Please send me an [email](sebastian@helzle.net) with any feedback you have or contact me on twitter @sebobo.

Contributing

------------

Contribute!