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.
Simply include the countUp.js file in your project or install via npm or bower using the package name countup.js
or countUp.js
respectively.
Before making a pull request, please read this. MIT License.
If you are using Angular, you can use the included 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
, decimals
, and options
. id
is not needed. You must include both countUp.js and the module to use the Angular directive. Check out the angular demo and see usage examples below.
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
= (optional, see demo) 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
})
Toggle pause/resume:
numAnim.pauseResume();
Reset an animation:
numAnim.reset();
Update the end value and animate:
var someValue = 1337;
numAnim.update(someValue);
For large numbers, since CountUp has a long way to go in just a few seconds, the animation seems to abruptly stop. The solution is to subtract 100 from your endVal
, then use the callback to invoke the update
method which completes the animation with the same duration with a difference of only 100 to animate:
var endVal = 9645.72;
var numAnim = new CountUp("targetElem", 0, endVal - 100, duration/2);
numAnim.start(function() {
numAnim.update(endVal);
});
If you are using Angular, (not required), create your animation like the examples below. Make sure you include both countUp.js and angular-countUp.js, and inject the countUpModule
.
<h2 count-up end-val="873.4"></h2>
With angular-scroll-spy:
<h2 count-up id="numberAnimation" end-val="873.4" scroll-spy-event="elementFirstScrolledIntoView" scroll-spy></h2>
You can optionally apply your custom easing function, which will receive 4 parameters necessary to calculate a Bezier curve:
t
(the current time);b
(the beginning value);c
(the difference between the beginning and destination value);d
(the total time of the tween).
You could use any of Robert Penner's easing functions. Just avoid using "bouncy" functions, because they cause counting in both directions
If you don't specify a custom easing function, CountUp uses the default easeOutExpo
.
Example:
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();
Before you make a pull request, please be sure to follow these super simple instructions:
- Do your work on the
countUp.js
and/orangular-countUp.js
files in the root directory. - In Terminal,
cd
to thecountUp.js
directory. - Run
npm install
, which installs gulp and its dependencies. - Run
gulp
, which copies and minifies the .js files to thedist
folder.