A jQuery plugin that renders a count-up clock from a defined start time
JavaScript Python
Switch branches/tags
Nothing to show
Latest commit f1bdae9 Sep 7, 2012 @robcowie robcowie Merge pull request #7 from pablogd/multielement-fix
Fix bug when using pugin with multiple elements

README.markdown

Simple count-up jQuery plugin

Summary

A jQuery plugin that renders a count-up clock from a defined start time. Supports start, stop, toggle, reset, and custom 'tick' event.

Usage

  • Initialise and start a default timer
$('').stopwatch().stopwatch('start')
  • Initialise and bind start/stop to click
$('').stopwatch().click(function(){
    $(this).stopwatch('toggle')
})
  • Bind to tick event and reset when 10 seconds has elapsed
$('').stopwatch().bind('tick.stopwatch', function(e, elapsed){
    if (elapsed >= 10000) {
        $(this).stopwatch('reset');
    }
}).stopwatch('start')
  • Start at non-zero elapsed time
$('').stopwatch({startTime: 10000000}).stopwatch('start')

Formatting

Provided by the jintervals lib. If you don't include this library, the default output format HH:MM:SS is used.

Formats

Pass a format pattern as the format option. jsintervals provides a rich syntax for formatting time intervals, perhaps best illustrated by some examples.

'{MM}:{ss}' --> 01:05
'{MMM}:{ss}' --> 001:05
'{M}m, {s}s' --> 1m, 5s
'{Minutes} and {seconds}' --> 1 minute and 5 seconds
'{Greatest} ago' --> 1 minute ago

The full documentation of the syntax is at http://code.google.com/p/jintervals/wiki/Documentation.

Custom formatter

A formatter function can be supplied as formatter in options. It receives milliseconds and options and must return a string.

Licence

Copyright (c) 2012 Rob Cowie. Licensed under the MIT license.