Skip to content

antiwork/countdown.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Sep 21, 2013
9ddcd60 · Sep 21, 2013

History

27 Commits
Sep 20, 2013
Sep 20, 2013
Jul 9, 2013
Sep 18, 2013
Jul 9, 2013
Sep 17, 2013
Sep 21, 2013
Sep 18, 2013
Sep 18, 2013

Repository files navigation

Countdown.js Build Status

Countdown.js is a library that allows developers to set countdowns for any kind of interaction. For example, if you would like to submit a form, Countdown.js allows you to set a 5 second countdown and give the user a chance to cancel the submission. You can see it in action here.

Installation

If you use bower:

bower install countdown.js

Otherwise, you can download it from here.

API

new Countdown(duration, onTick, onComplete)

Begins a countdown. After duration time has passed, the function onComplete will be executed. Every second, the onTick function will be executed.

Example:

var countdown = new Countdown(5, function(seconds) {
  console.log(seconds); //log the number of seconds that have passed
}, function() {
   console.log("Countdown complete!") //log that the countdown has complete
});

abort()

Terminates countdown.

Example:

countdown.abort();

getRemainingTime()

Returns remaining time in seconds.

Example:

countdown.getRemainingTime(); //=> 4

Example

http://gumroad.github.io/countdown.js/

Contribute

Install development dependencies

npm install

Test

npm test