jCarousel is the name of a Drupal module that allows to integrate the jQuery plugin jCarousel in Drupal.
The module exposes an API that allows other modules to integrate the jQuery plugin in their pages.
The main function is jcarousel_add()
which accepts two arguments:
$class_name
: The CSS class of the element which will become the carousel. Multiple carousels may have the same carousel ID and all their settings will be shared.$settings
: The configuration options that are sent during the creation of the jCarousel element (optional). The configuration options can be found at http://sorgalla.com/projects/jcarousel/#Configuration. A few special keys may also be provided in$settings
, such as$settings['skin']
, which can be used to apply a specific skin to the carousel. jCarousel module comes with a few skins by default, but other modules can provide their own skins by implementinghook_jcarousel_skin_info()
.