Skip to content
The Final Countdown plugin for jQuery
Branch: master
Clone or download
hilios Merge pull request #234 from nietonfir/feature-events
Allow events to be handled by parent elements
Latest commit 2237899 Dec 31, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist Update release files Oct 26, 2016
src Remove hasEventsAttached variable Oct 26, 2016
test Update tests and check that parent elements receive the events Oct 26, 2016
.bowerrc Use bower to manage the third party libs May 20, 2014
.gitignore Ignore jekyll generation folder Jun 3, 2014
.jshintignore Add the jshintignore file May 19, 2014
.jshintrc
.travis.yml
Gruntfile.js Fix package name to fits the NPM repo Aug 4, 2016
LICENSE.md Update the files structure to compile files to distribution folder Dec 12, 2013
README.md
bower.json Build a beta version for the v2.2 Aug 3, 2016
countdown.jquery.json Build a beta version for the v2.2 Aug 3, 2016
karma.conf.js
package.json Fix package name to fits the NPM repo Aug 4, 2016

README.md

The Final Countdown Build Status

A simple and html agnostic date countdown plugin for jQuery

To get started, check-it out: http://hilios.github.io/jQuery.countdown/

The ultimate countdown plugin designed to fit in any coupon, auction site or product launch. Read our Documentation and follow our Examples to see what suits your particular needs.

Download

Click here to download the latest version

If you want to clone the repo always use the files under dist folder, they are optimized for production and development.

Install via Bower

bower install jquery.countdown

Add a script to your html:

<script src="/bower_components/jquery.countdown/dist/jquery.countdown.js"></script>

Install via NPM

npm install --save jquery-countdown

Require the script:

require('jquery-countdown');

Getting started

<div id="getting-started"></div>
<script type="text/javascript">
  $('#getting-started').countdown('2015/01/01', function(event) {
    $(this).html(event.strftime('%w weeks %d days %H:%M:%S'));
  });
</script>

Requirements

Since version 2.0.0 we only support jQuery above 1.7 (including 2.x and 3.x). For legacy 1.6 support please use the version 1.0.2.

Documentation

Our documentation is powered by Jekyll (see gh-page branch) and hosted in GitHub Pages at http://hilios.github.io/jQuery.countdown/.

Examples

There are few ways to get started, from the most simple example to advanced, we support many different countdown styles, see wich one fits your scenario, and if anyone doesn't it's a good starting point to customize your output.

Release notes

Current version is 2.2.0, to follow our change log please visit the release notes.

What's new in 2.2.0?

  • Total count for hours %I, minutes %N and seconds %T;
  • Count to weeks left to complete a month %W;
  • Deferred initialization, allows to control the exact start moment;
  • Fix pluralization bug when return is zero;

What's new in 2.1.0?

  • Add proper offset for days left to a month and to a week;
  • Fix bower amd install;

Contributing

The Final Countdown uses Grunt and Bower with convenient methods for developing the plugin. It's how we compile our code and run tests. To get started install NodeJS, Bower, and then run some Grunt/Bower commands.

bower install
npm install
grunt test  # Lint code and run test suite
grunt build # Generate the release files (dev, min and zip)
grunt       # Watch for updates than test and build

This plugin is tested with QUnit, under jQuery 1.7 up to 3.1, Bootstrap 3.0 and RequireJS.

The functional tests made against:

  • Chrome >= 12
  • Safari >= 5
  • Firefox >= 5.0
  • IE 7/8/9

Code coverage:

---------------|----------|----------|----------|----------|----------------|
File           |  % Stmts | % Branch |  % Funcs |  % Lines |Uncovered Lines |
---------------|----------|----------|----------|----------|----------------|
 src/          |     98.4 |    90.63 |      100 |     98.4 |                |
  countdown.js |     98.4 |    90.63 |      100 |     98.4 |          6,283 |
---------------|----------|----------|----------|----------|----------------|
All files      |     98.4 |    90.63 |      100 |     98.4 |                |
---------------|----------|----------|----------|----------|----------------|

Contributors

Thanks for bug reporting and fixes:

  • Daniel Leavitt (@dleavitt)
  • Fagner Brack (@FagnerMartinsBrack)
  • Matthew Sigley (@msigley)
  • Roman Shterenzon (@romanbsd)
  • Marios (@assiotis)
  • Zane Yao (@yaoazhen)
  • Ricardo Calvo (@ricardocalvo)
  • Daniel Z. (@nietonfir)

License

Copyright (c) 2011-2015 Edson Hilios. This is a free software is licensed under the MIT License.

  • Edson Hilios. Mail me: edson (at) hilios (dot) com (dot) br
You can’t perform that action at this time.