Timed Event jQuery plugin documentation

In the previous post I wrote about Timed Event jQuery plugin. Here is documentation for it.

Usage

In order to use Timed Event, you must follow these steps:

1. Download plugin arhcive and unpack it.
2. Include jQuery and plugin file (jquery.timed-event.js or jquery.timed-event-min.js) to your web page.
3. Now you can use Timed Event in your code. Use it in this way:

   $("selector").timedBind("event-type", {delay: [time of delay in milliseconds], buffer: [time of buffer in milliseconds]}, function() {
       //event handler function
   });
   

   As you can see, timedBind accepts the same parameters as jQuery native bind function. But you should take into account that the data parameter in bind function is optional, but is required in timedBind function (in other words, all three parameters of timedBind are required). You can pass an empty object as data parameter, but in this case the behaviour of the timedBind will not differ from bind method. Both properties of data object(delay and buffer) are optional, you can pass any combination of them.

Contribution

If you have some suggestions on improvement the plugin, feel free to email me at Kadalashvili at Vladimir at gmail dot com.

Resources

• Timed Event homepage
• Timed event in jQuery plugin directory
• Timed event on Google Code
• Timed Event demo page