Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

easy-countdown

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

easy-countdown

Simple, lightweight and easy to use countdown plugin

  • 2.0.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
Maintainers
1
Weekly downloads
 
Created
Source

countdown

countdown is a jQuery plugin to render countdowns. Instead of unicorns this plugin does not have any magic, but if you like countdowns to be rendered the way you want, this plugin might become your best friend.

Uber simple setup

To use the countdown plugin you need to load the current version of jQuery (testet with 1.7.2) and the javascript file of the plugin. Just add the following lines to the head of your website:

<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js"></script>
<script type="text/javascript" src="/path/to/jquery.countdown.js"></script>

Then you have to initialize the plugin with your desired configuration:

$(function() {
    $('.yourCountdownContainer').countdown({
        date: "June 7, 2087 15:03:26"
    });
});

Yep, it's easy like that! Enjoy the time you saved!

Options

You can pass a set of these options to set a custom behaviour and look for the plugin.

Property (Type)DefaultDescription
datenew Date("June 7, 2087 15:03:25")The end time of your fancy countdown. Pass either a date object or a string/integer that will be used to create a new Date object. Here you can find all accepted formats of this value.
refresh1000Refresh rate in milliseconds or false to avoid automatic updates.
renderWith the render option you can set a function to change the output of the plugin. This function is called in the scope of the plugin, so you can access the leadingZeros method to format numbers as well as public variables and methods. A literal object will be passed to this function as an argument, containing the remaining time parts (years, days, hours, min, sec).
onEndCallback function that is called when the end date is reached

Public plugin methods

method(arguments)Description
leadingZeros(number, [length = 2])Add leading zeros to a number.
update(newDate)Update the end time. The possible formats of the argument newDate are the same as described in the date-option above.
render()Call the render method. This might be usefull if you set refresh to false.
stop()Stops the refresh loop.
start([refreshRate])Start the refresh loop. If you set a refresh rate in the options you can overwrite it with the argument refreshRate. If you don't pass an argument, the old value or the default value of 1 sec will be used.

Changelog

Version 1.0.1 - May 01, 2013

  • Added callback function when the end date is reached

Version 1.0.0 - Aug 05, 2012

  • Initial release

License

countdown is dual licensed under the MIT and GPL-3.0 licenses.

Keywords

FAQs

Package last updated on 13 Oct 2014

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc