Giter Club home page Giter Club logo

jquery.countdown's Introduction

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.

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>

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.0). For legacy 1.6 support please use the version 1.0.2.

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

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.

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

What's new in 2.1.0?

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

What's new in 2.0.5?

  • Allow precision controls through an options object;
  • Allow to continue after countdown finishes;
  • Don't dispatch events when nothing changes;

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 2.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.39 |    90.32 |      100 |    98.39 |                |
  countdown.js |    98.39 |    90.32 |      100 |    98.39 |          6,269 |
---------------|----------|----------|----------|----------|----------------|
All files      |    98.39 |    90.32 |      100 |    98.39 |                |
---------------|----------|----------|----------|----------|----------------|

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)

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

jquery.countdown's People

Contributors

hilios avatar bartaakos avatar fagnermartinsbrack avatar benkroeger avatar dleavitt avatar romanbsd avatar yaoazhen avatar

Watchers

James Cloos avatar srinath madusanka 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.