Skip to content

paulelliott/jquery-the_final_countdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

The Final Countdown - jQuery Timer Plugin

This plugin provides a simple countdown timer. You can invoke it on any DOM element and it will update the content with a timer that counts down seconds.

Demo URL: http://codingfrontier.heroku.com/jquery-the_final_countdown/demo/demo.html
Spec URL: http://codingfrontier.heroku.com/jquery-the_final_countdown/spec/suite.html

Features:

  * formattable output text
  * can create, start, and pause timers
  * timers count down seconds

Example:

  //To create a new timer and start it simultaneously
  $("#timer").createTimer(options);

  //To create a timer that you will manually start later
  $("#timer").createTimer({autostart: false});

  //To start a timer that is ready or paused
  $("#timer").startTimer(options);

  //To pause a running timer
  $("#timer").pauseTimer();

  //To get the current timer value
  $("#timer").getTimerValue();

Options:

  time_in_seconds

    default value: 3600

    Sets the number of seconds the timer should be initialized with.

  tick

    default value: function(timer, time_in_seconds) {}

    Function called with every tick of the clock.

  buzzer

    default value: function(timer) {}

    Function called when the timer completes.

  autostart

    default value: true

    True will start the timer upon creation.  False will require you to call startTimer().

  time_format

    default_value: MM:ss

    Format of outputted time.

    Mask	Description
    d	Day of the month as digits; no leading zero for single-digit days.
    dd	Day of the month as digits; leading zero for single-digit days.
    ddd	Day of the week as a three-letter abbreviation.
    dddd	Day of the week as its full name.
    m	Month as digits; no leading zero for single-digit months.
    mm	Month as digits; leading zero for single-digit months.
    mmm	Month as a three-letter abbreviation.
    mmmm	Month as its full name.
    yy	Year as last two digits; leading zero for years less than 10.
    yyyy	Year represented by four digits.
    h	Hours; no leading zero for single-digit hours (12-hour clock).
    hh	Hours; leading zero for single-digit hours (12-hour clock).
    H	Hours; no leading zero for single-digit hours (24-hour clock).
    HH	Hours; leading zero for single-digit hours (24-hour clock).
    M	Minutes; no leading zero for single-digit minutes.
    Uppercase M unlike CF timeFormat's m to avoid conflict with months.
    MM	Minutes; leading zero for single-digit minutes.
    Uppercase MM unlike CF timeFormat's mm to avoid conflict with months.
    s	Seconds; no leading zero for single-digit seconds.
    ss	Seconds; leading zero for single-digit seconds.
    l or L	Milliseconds. l gives 3 digits. L gives 2 digits.
    t	Lowercase, single-character time marker string: a or p.
    No equivalent in CF.
    tt	Lowercase, two-character time marker string: am or pm.
    No equivalent in CF.
    T	Uppercase, single-character time marker string: A or P.
    Uppercase T unlike CF's t to allow for user-specified casing.
    TT	Uppercase, two-character time marker string: AM or PM.
    Uppercase TT unlike CF's tt to allow for user-specified casing.
    Z	US timezone abbreviation, e.g. EST or MDT. With non-US timezones or in the Opera browser, the GMT/UTC offset is returned, e.g. GMT-0500
    No equivalent in CF.
    o	GMT/UTC timezone offset, e.g. -0500 or +0230.
    No equivalent in CF.
    S	The date's ordinal suffix (st, nd, rd, or th). Works well with d.
    No equivalent in CF.
    '…' or "…"	Literal character sequence. Surrounding quotes are removed.
    No equivalent in CF.
    UTC:	Must be the first four characters of the mask. Converts the date from local time to UTC/GMT/Zulu time before applying the mask. The "UTC:" prefix is removed.
    No equivalent in CF.

Contributors:

  Pratik Desai (desigooner)

About

jQuery Countdown Timer

Resources

Stars

Watchers

Forks

Packages

No packages published