CountUp.js is a dependency-free, lightweight JavaScript "class" that can be used to quickly create animations that display numerical data in a more interesting way.
Despite its name, CountUp can count in either direction, depending on the startVal
and endVal
params that you pass.
CountUp.js supports all browsers.
The only file you need is countUp.js.
If you want to get fancy with build systems, a gulpfile is included. Read more here.
Included is an angular module. Use the count-up attribute to quickly create an animation. It also integrates nicely with the angular-scroll-spy directive. The Angular directive only requires an end-val
attribute, but will also accept start-val
, duration
, and decimals
. id
is not needed. You must include both countUp.js and the module to use the angular directive. Check out the angular demo.
If you want a quick and easy way to use this on your WordPress site, try this plugin by @4DMedia: https://wordpress.org/plugins/countup-js/
Params:
target
= id of html element, input, svg text element, or var of previously selected element/input where counting occursstartVal
= the value you want to begin atendVal
= the value you want to arrive atdecimals
= (optional) number of decimal places in number, default 0duration
= (optional) duration in seconds, default 2options
= (see demo, optional) formatting/easing options object
Decimals, duration, and options can be left out to use the default values.
var numAnim = new CountUp("SomeElementYouWantToAnimate", 24.02, 99.99);
numAnim.start();
with optional callback:
numAnim.start(someMethodToCallOnComplete);
// or an anonymous function
numAnim.start(function() {
// do something
})
For angular:
<h2 count-up end-val="873.4"></h2>
Width angular-scroll-spy:
<h2 count-up id="numberAnimation" end-val="873.4" scroll-spy-event="elementFirstScrolledIntoView" scroll-spy></h2>
Toggle pause/resume:
numAnim.pauseResume();
Reset an animation:
numAnim.reset();
Update the end value and animate:
var someValue = 1337;
numAnim.update(someValue);
You can apply your custom easing function, which will receive standard 4 parameters necessary to calculate Bezier curve:
t
(the current time);b
(the beginning value);c
(the change between the beginning and destination value);d
(the total time of the tween).
So, for instance, you could use bodies of easing functions from jQuery's easing plugin. Pass in the body of the function and you're good to go :)
Just don't use any "bouncy" functions, as they tend to cause issues and are controlled not to exceed max value by the library.
If you don't specify a custom easing closure function, the plugin will fall back to the default easeOutExpo
.
var easeOutCubic = function(t, b, c, d) {
var ts = (t /= d) * t;
var tc = ts * t;
return b + c * (1.77635683940025e-15 * tc * ts + 0.999999999999998 * tc + -3 * ts + 3 * t);
};
var options = {
easingFn: easeOutCubic
};
var demo = new CountUp("myTargetElement", 24.02, 94.62, 2, 2.5, options);
demo.start();
- Details on the license can be found here
- Details on running tests and contributing can be found here