⏰ A lightweight and performant flip styled countdown clock.
Example live at: https://pbutcher.uk/flipdown/
Remix FlipDown on CodePen: https://codepen.io/PButcher/pen/dzvMzZ
To get started, either clone this repo or install with npm install flipdown or yarn add flipdown.
For basic usage, FlipDown takes a unix timestamp (in seconds) as an argument.
new FlipDown(1538137672).start();
Include the CSS and JS in <head> and include the following line in your HTML.
<div id="flipdown" class="flipdown"></div>
See a full example here.
To use multiple instances of FlipDown on the same page, specify a DOM element ID as the second argument in FlipDown's constructor:
new FlipDown(1588017373, "registerBy").start();
new FlipDown(1593561600, "eventStart").start();
<div id="registerBy" class="flipdown"></div>
<div id="eventStart" class="flipdown"></div>
FlipDown comes with 2 themes as standard:
To change the theme, you can supply the theme property in the opt object in the constructor with the theme name as a string:
{
theme: "light";
}
For example, to instantiate FlipDown using the light theme instead:
new FlipDown(1538137672, {
theme: "light",
}).start();
Custom themes can be added by adding a new stylesheet using the FlipDown theme template.
FlipDown themes must have the class name prefix of: .flipdown__theme- followed by the name of your theme. For example, the standard theme class names are:
.flipdown__theme-dark.flipdown__theme-lightYou can then load your theme by specifying the theme property in the opt object of the constructor (see Themes).
You can add your own rotor group headings by passing an array as part of the opt object. Bear in mind this won't change the functionality of the rotors (eg: the 'days' rotor won't magically start counting months because you passed it 'Months' as a heading).
Suggested use is for i18n. Usage as follows:
new FlipDown(1538137672, {
headings: ["Nap", "Óra", "Perc", "Másodperc"],
}).start();
Note that headings will default to English if not provided: ["Days", "Hours", "Minutes", "Seconds"]
FlipDown.prototype.constructor(uts, [el], [opts])Create a new FlipDown instance.
utsType: number
The unix timestamp to count down to (in seconds).
[el]Optional
Type: string (default: flipdown)
The DOM element ID to attach this FlipDown instance to. Defaults to flipdown.
[opts]Optional
Type: object (default: {})
Optionally specify additional configuration settings. Currently supported settings include:
FlipDown.prototype.start()Start the countdown.
FlipDown.prototype.ifEnded(callback)Call a function once the countdown has ended.
callbackType: function
Function to execute once the countdown has ended.
var flipdown = new FlipDown(1538137672)
// Start the countdown
.start()
// Do something when the countdown ends
.ifEnded(() => {
console.log("The countdown has ended!");
});
Pull requests and feature suggestions welcome and e
Thanks to the following people for their suggestions/fixes:
FAQs
A lightweight and performant flip styled countdown clock
The npm package flipdown receives a total of 933 weekly downloads. As such, flipdown popularity was classified as not popular.
We found that flipdown demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.