Skip to content

api.md

Latest commit

 

History

History
323 lines (208 loc) · 5.25 KB

api.md

File metadata and controls

323 lines (208 loc) · 5.25 KB

API

After initialization, you can call the following methods on the jCarousel instance:

See Calling methods on the jCarousel instance for how to call methods.

Carousel-related methods

scroll

Description

scroll(target [, animate [, callback]])

Scrolls to a specific item or relative by a given offset.

Arguments

  • target

    The target item to which the carousel should scroll.

    Available formats for the target argument:
    • index

      Scrolls to the item at the given index (Note that indexes are 0-based).

      Example:

      $('.jcarousel').jcarousel('scroll', 0);
    • -index

      Scrolls to the item at the given index counting backwards from the end of the list.

      Example:

      $('.jcarousel').jcarousel('scroll', -1);
    • object

      Scrolls to the given object.

      Example:

      $('.jcarousel').jcarousel('scroll', $('.jcarousel li:eq(2)'));
    • +=offset

      Scrolls the carousel forward by the given offset relatively from the current position.

      Example:

      $('.jcarousel').jcarousel('scroll', '+=1');
    • -=offset

      Scrolls the carousel backwards by the given offset relatively from the current position.

      Example:

      $('.jcarousel').jcarousel('scroll', '-=1');

  • animate

    If the argument animate is given and false, it just jumps to the position without animation.

  • callback

    If the argument callback is given and a valid function, it is called after the animation is finished.

    The function receives a boolean as first argument indicating if a scrolling actually happend.

    It can be false for the following reasons:

    • The carousel is already animating
    • The target argument is invalid
    • The carousel is already on the requested position
    • An event has cancelled the scrolling

Example

$('.jcarousel').jcarousel('scroll', '+=1', true, function(scrolled) {
    if (scrolled) {
        console.log('The carousel has been scrolled');
    } else {
        console.log('The carousel has not been scrolled');
    }
});

reload

Description

reload([options])

Reloads the carousel. This method is useful to reinitialize the carousel if you have changed the content of the list from the outside or want to change options that affect appearance of the carousel at runtime.

Arguments

Example

$('.jcarousel').jcarousel('reload', {
    animation: 'slow'
});

destroy

Description

destroy()

Removes the jCarousel functionality completely. This will return the element back to its initial state.

Example

$('.jcarousel').jcarousel('destroy');

list

Description

list()

Returns the list element as jQuery object.

Example

var list = $('.jcarousel').jcarousel('list');

Item-related methods

Note: The item-related methods return different results depending on the state of the carousel. That means for example, that after each scroll, these methods return a different set of items.

The following example illustrates how to use these methods inside event callbacks:

$('.jcarousel')
    .on('jcarousel:animateend', function(event, carousel) {
        var currentFirstItem = $(this).jcarousel('first');
        var currentLastItem  = $(this).jcarousel('last');
    });

items

Description

list()

Returns all items as jQuery object.

Example

var items = $('.jcarousel').jcarousel('items');

target

Description

target()

Returns the targeted item as jQuery object.

Example

var target = $('.jcarousel').jcarousel('target');

first

Description

first()

Returns the first visible item as jQuery object.

Example

var first = $('.jcarousel').jcarousel('first');

last

Description

last()

Returns the last visible item as jQuery object.

Example

var last = $('.jcarousel').jcarousel('last');

visible

Description

visible()

Returns all visible items as jQuery object.

Example

var visible = $('.jcarousel').jcarousel('visible');

fullyvisible

Description

fullyvisible()

Returns all fully visible items as jQuery object.

Example

var fullyvisible = $('.jcarousel').jcarousel('fullyvisible');