README.md

#TemporizedSlider.js

A micro js that implements a temporized image slider, with custom text and title. It leaves room for others personalized changes.

##Usage ###Basics

TemporizedSlider.setupAndStart({
  slides: [
    {
      image: 'https://www.google.com.br/images/srpr/logo3w.png',
      title: 'my title',
      text:  'temporized text',
      time:  18 // time in seconds
    },
    {
      image: 'http://railsbrasil.s3.amazonaws.com/sites/4e2c66cde8fb0e0001000004/theme/images/rails.png',
      title: 'my rails title',
      text:  'temporized rails text',
      time:  15 // time in seconds
    }
  ]
});
TemporizedSlider.play();      // Initiate or resume the slider
TemporizedSlider.pause();     // pause the slider
TemporizedSlider.next();      // go to next slide
TemporizedSlider.previous();  // go to previous slide

###Using Callbacks Optionally, callbacks can be used to trigger custom actions, on pre-determined moments.

TemporizedSlider.setup({
  slides: ... ,
  beforeSetup: function() {
    console.warn('initiating');
  },
  afterSetup: function() {
    console.warn('initiated');
  },
  afterChange: function() {
    console.warn('changed');
  },
  beforePlay: function() {
    console.warn('playing');
  },
  beforePause: function() {
    console.warn('pausing');
  }
});

###HTML Structure By default, it looks for three elements to interact #slider_image (an image tag), #slider_title (a container to hold the title) and a #slider_text (another container that will hold the text).

Those elements can be overwritten through the parameters below:

TemporizedSlider.setup({
  slides: ... ,
  imageId: 'my_custom_image_id',
  titleId: 'my_custom_title_id',
  textId:  'my_custom_text_id'
});

###Slider Controls Controls functionality is provided to handle its basic functions, such as play, pause, previous and next.

####Custom Elements Controls will assign its default actions by searching for four core elements that are labeled with the tag ids: play_control, pause_control, previous_control and next_control. It is possible to customize them through the Controls parameters, as follow:

TemporizedSlider.setup({
  slides: ... ,
  controls : {
    play: {
      id: 'custom_play_id'
    },
    pause: {
      id: 'custom_pause_id'
    },
    previous: {
      id: 'custom_previous_id'
    },
    next: {
      id: 'custom_next_id'
    }
  }
});

####Custom Events It's also provided a way to customize the functions that handles Controls events. This can be achieved through the following lines:

TemporizedSlider.setup({
  slides: ... ,
  controls: {
    play: {
      handler: function() {
        console.warn('play click');
      }
    },
    pause: {
      handler: function() {
        console.warn('pause click');
      }
    },
    previous: {
      handler: function() {
        console.warn('previous click');
      }
    },
    next: {
      handler: function() {
        console.warn('next click');
      }
    }
  }
});

####Shutting off Controls Controls is always on except when modified with the following parameter:

TemporizedSlider.setup({
  slides: ... ,
  controls: {
    load: false
  }
});

*Note: These functions will overwrite the defaulf behavior. If desired to return to it, you can use default behavior calls such as TemporizedSlider.next() and TemporizedSlider.previous().

###Slider Gallery Gallery will show the images passed on data parameters. Although it is not active by default you can activate it using the load : true option and optionally passing the id of the container in wich the images should be held:

TemporizedSlider.setup({
  slides: ... ,
  gallery: {
    load: true,
    id: 'slider_gallery'
  }
});

####Gallery Controls The slider can also be, partially, controled through the gallery. It's images can be clicked to set the current slide. Even though you are changing the current slide the Slider status will not change. If it is paused it will remain that way. If it is playing the Slider will go on from where you clicked.

##TO DO

• Allow integration with transition components;
• Add visual timer;
• Add slider indicator.

##How to contribute Please ensure that you provide appropriate test coverage and ensure the documentation is up-to-date. It is encouraged that you perform changes in a clean topic branch rather than a master and that you create a pull request for them. This will facilitate discussion and revision.

Please be clean, keep your commits atomic and with the smallest possible logical change. This will increase the likelihood of your submission to be used.

###Bug reports

If you discover any bugs, feel free to create an issue on GitHub. Please add as much information as possible to help us fixing the possible bug.

https://github.com/lukasalexandre/TemporizedSlider.js/issues

##License Copyright (c) 2012 Lukas Alexandre. http://codelogic.me

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use, copy and modify copies of the Software, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.