Korx.Cycler 0.4

Korx.Cycler is a versatile MooTools plugin which can be used to easily create a user interface control which cycles through elements, for example a slider, carousel or slideshow. It uses CSS 3 transitions with a fallback to Fx.Morph for older browsers, and there's plenty of options to configure it how you want and events to hook in to.



Details

Author
Korx
Current version
0.4
GitHub
korx/Korx.Cycler
Downloads
4038
Category
Widgets
Tags
Report
GitHub Issues

Releases


Dependencies

  • _self_/_current_:
    • core/1.4:Core
    • core/1.4:Array
    • core/1.4:Function
    • core/1.4:Event
    • core/1.4:Class
    • core/1.4:Class.Extras
    • core/1.4:Element
    • core/1.4:Element.Style
    • core/1.4:Element.Event
    • core/1.4:Fx.Morph

How to use

Please have a look in the Demo directory for a couple of examples of how you can use Korx.Cycler. These can also be seen on GitHub Pages

In it's simplest form, create a new object of the Korx.Cycler class specifying your container element after the DOM has loaded.

<!doctype html>
<html>
    <head>
        <title>Korx.Cycler</title>
        <script src="mootools.js"></script>
        <script src="korx.cycler.js"></script>
        <script>
            window.addEvent('domready', function(){
                new Korx.Cycler($('cycler'));
            });
        </script>
    </head>
    <body>
        <div id="cycler">
            <article>
                <h1>The first element</h1>
            </article>
            <article>
                <h1>The second element</h1>
            </article>
        </div>
    </body>
</html>

Note: this simple cycler will not have any effects as they need to be specified via the options.

Options

onInit

This is triggered during initialisation before it has been determined wether CSS transition support is available or not.

onInit: function(){
    this.addItems(this.element.getChildren());
}

onReady

This is triggered during initialisation after it has been determined wether CSS transition support is available or not.

onReady: function(){
    this.play();
}

onPlay

This is triggered when the method play() is invoked.

onPlay: function(){}

onStop

This is triggered when the method stop() is invoked.

onStop: function(){}

onPause

This is triggered when the method pause() is invoked.

onPause: function(){}

onMove

This is triggered when the method move() is invoked. event is an object with the property delta which is the amount moved by.

onMove: function(event){}

onStep

This is triggered on each interval setup by play().

onStep: function(){
    this.move(1);
}

onTap

This is triggered when a 'tap' touch event or gesture is detected in the container element. event is an object with the properties origin and destination which are each objects containing the co-ordinate properties x and y, and the time property t.

onTap: function(event){
    this.pause();
}

onSwipe

This is triggered when a 'swipe' touch event or gesture is detected in the container element. event is an object with the properties direction which could be 'left', 'right', 'up' or 'down' along with origin and destination which are each objects containing the co-ordinate properties x and y, and the time property t.

onSwipe: function(event){
    this.pause();
    switch (event.direction) {
        case 'up':
        case 'left':
            this.move(-1);
            break;
        case 'down':
        case 'right':
            this.move(1);
            break;
    }
}

duration

This is the amount of time in milliseconds between each step interval - setup when play() has been invoked.

duration: 5000

flutter

This is the amount of time in milliseconds between each item transition when there is a queue of items to action.

flutter: 250

appear

This is the set of options for the CSS transition and Fx.Morph when an element is moving in to the current position.

appear: {
    duration: 500,
    transition: 'sine:in:out',
    unit: '%',
    timingFunction: 'ease-in-out'
}

disappear

This is the set of options for the CSS transition and Fx.Morph when an element is moving out from the current position.

disappear: {
    duration: 500,
    transition: 'sine:in:out',
    unit: '%',
    timingFunction: 'ease-in-out'
}

origin

This is the set of styles for each of the css and js transitions used for the starting point of the next element.

origin: {
    css: {
        transform: 'translate(-100%, 0)'
    },
    js: {
        left: '-100%'
    }
}

current

This is the set of styles for each of the css and js transitions used for the finishing point of the next element and starting point of the previous element.

current: {
    css: {
        transform: 'translate(0, 0)'
    },
    js: {
        left: '0%'
    }
}

destination

This is the set of styles for each of the css and js transitions used for the finishing point of the previous element.

destination: {
    css: {
        transform: 'translate(100%, 0)'
    },
    js: {
        left: '100%'
    }
}

swipeTime

This is the maximum amount of time a touch can have before it's ignored as a swipe gesture.

swipeTime: 500

swipeDistance

This is the minimum amount of distance relative to the viewport scale a touch can have in a single direction before it's classed as a swipe gesture.

swipeDistance: 50

Methods

useCss()

Force the cycler to switch to using CSS transitions.

cycler.useCss();

useJs()

Force the cycler to switch to using JavaScript Fx.Morph transitions.

cycler.useJs();

addItems()

This method will add items to the cycler. It will accept an individual elements as the arguments or an array of elements

cycler.addItems(element);
cycler.addItems(element1, element2, element3);
cycler.addItems([element1, element2, element3]);

removeItems()

This method will remove items from the cycler. It will accept an individual elements as the arguments or an array of elements

cycler.removeItems(element);
cycler.removeItems(element1, element2, element3);
cycler.removeItems([element1, element2, element3]);

reset()

This method resets the cycler, therefore removing any items in mid transition immediately and injecting the current item with current styles into the container element.

cycler.reset();

clean()

This method removes styles used in the options from an element

cycler.clean(element);

play()

This method moves creates the interval timer which fires every this.options.duration and triggers the event onStep, which by default moves the cycler by +1.

cycler.play();

stop()

This method stops the cycler from playing by removing the interval timer. It also resets the cycler, and therefore will remove any items in mid transition.

cycler.stop();

pause()

This method stops the cycler from playing by removing the interval timer. It doesn't reset the cycler so any items mid transition will be allowed to complete.

cycler.pause();

move(delta)

This method moves the cycler in the direction specified by delta which may be a positive or negative integer.

cycler.move(1);
cycler.move(-1);
cycler.move(3);
cycler.move(-5);

cycle()

This actions any transitions which are stored in this.queue. You shouldn't need to use this unless doing some advanced stuff with the transition queue - use cycler.move(delta) instead.

cycler.cycle();

Discuss

A note on comments here: These comments are moderated. No comments will show up until they are approved. Comments that are not productive (i.e. inflammatory, rude, etc) will not be approved.

Found a bug in this plugin? Please report it this repository's Github Issues.

blog comments powered by Disqus