Giter Club home page Giter Club logo

countdown.js's Introduction

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

countdown.js's People

Contributors

squidarth avatar kn avatar mduvall avatar zinssmeister avatar

Watchers

James Cloos avatar Praveen Reddy avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.