Nivoo-Slider 1.2

The Nivoo-Slider is an image gallery based on the jQuery Plugin NivoSlider (http://nivo.dev7studios.com/). It features 18 different transition effects.



Details

Author
Johannes Fischer
Current version
1.2
GitHub
JohannesFischer/Nivoo-Slider
Downloads
23252
Category
Widgets
Tags
Report
GitHub Issues

Releases


Dependencies

  • _self_/_current_: core/1.4: '*'

How to use

Just include NivooSider.js and the NivooSlider.css to your the head section of your HTML file:

<script type="text/javascript" src="NivooSlider.js"></script>
<link  href="NivooSlider.css" rel="stylesheet" type="text/css" media="screen" />

And the gallery structure:

<div id="Slider" class="nivoo-slider">
    <a href="#">
        <img src="images/1269388.jpg" alt="" title="This is an example of a linked image" height="350" width="600" />
    </a>
    <img src="images/1268244.jpg" alt="" title="This is an example of a caption" height="350" width="600" />
    <a href="#">
        <img src="images/1270048.jpg" alt="" title="This is another example of a caption" height="350" width="600" />
    </a>
    <img src="images/1270256.jpg" alt="" title="This is another example of a caption" height="350" width="600" />
</div>

And then initialize the slider using the domready event:

window.addEvent('domready', function () {
    // The simple way
    new NivooSlider($('Slider'));

    // The more advanced way
    new NivooSlider($('Slider'), {
        animSpeed: 750,
        effect: 'sliceLeftRightDown',
        interval: 5000,
        orientation: 'horizontal',
        slices: 20
    }).addEvents({
        'onFinish': function () {
            // fired after each transition
        },
        'onLastSlide': function () {
            // fired when the last slide comes on
        },
        'onStart': function () {
            // fired right before each transition
        }
    });

    // add an if statement to check for the slider element (e.g. in a global script)
    // in this way you can add the code even if the slider element doesn't exist on the current page
    if ($('Slider')) {
        new NivooSlider($('Slider'));
    }
}

Documentation

Class: NivooSlider

Syntax
var slider = new NivooSlider(element[, options]);
Arguments
  1. element - (mixed) An Element or the string id of an Element to apply the gallery to.
  2. options - (object, optional) The Nivoo-Slider options object, described below:
Options
  • animSpeed - (number: defaults to 500) The time (duration) in ms of the transition
  • autoPlay - (bool: defaults to true) Start the transition automatically after initializing
  • controlNav: (bool: defauls to true) Add a control navigation (bullet points) below the slider
  • controlNavItem: (string: defauls to disc) Sets the character used in the control navigation, can be disc, decimal, or any other string / html entity
  • directionNav -(bool: deafults to true) Shows controls to go back and forth
  • directionNavHide - (bool: defaults to false) Hides the navigation controls on mouseout, so they are only visible when the mouse cursor is over the slider element
  • directionNavPosition -(string: deafult is inside) Place of the directional navigation, can be inside or outside. When positioned outside the css-class direction-nav-outside will be added to the slider-container
  • directionNavWidth - (number,string: defaults to 20%) Width of the clickable area of the directional navigation. Can be a number for pixels or a string with a percentage of the full width.
  • effect - (string: defaults to sliceDown) Type of transition (see effects),
  • interval - (number: defaults to 3000) Interval in ms between the transitions, required for the autoPlay function
  • orientation - (string: defaults to vertical) Defines the direction of the transition, can be horizontal, random or vertical
  • pauseOnBlur - (bool: defaults to false) Pauses the Animation when the window is not focused
  • pauseOnHover - (bool: defaults to true) Clears the interval on mouseover
  • slices - (number: defaults to 15) Number of the slices used for the transitions
Events
  • finish - (function) Is fired right after each transition
  • lastSlide - (function) Is fired when the last slide comes on
  • start - (function) Is fired right before each transition

Effects

horizontal & vertical
  • fade
  • fold
  • random
horizontal
  • sliceLeftDown
  • sliceLeftUp
  • sliceLeftRightDown
  • sliceLeftRightUp
  • sliceRightDown
  • sliceRightUp
  • wipeDown
  • wipeUp
vertical
  • sliceDownLeft
  • sliceDownRight
  • sliceUpDownLeft
  • sliceUpDownRight
  • sliceUpLeft
  • sliceUpRight
  • wipeLeft
  • wipeRight

License

MIT-style license.


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