countup.js

What is countup.js?

countup.js is a lightweight JavaScript library that allows you to create animated counting numbers. It is useful for creating dynamic and engaging number displays in web applications, such as statistics, counters, and other numerical data visualizations.

What are countup.js's main functionalities?

Basic Count Up

This feature allows you to animate a number counting up from zero to a specified value. In this example, the number will count up to 1000 and display in the element with the ID 'targetElement'.

const countUp = new CountUp('targetElement', 1000);
if (!countUp.error) {
  countUp.start();
} else {
  console.error(countUp.error);
}

Custom Start and End Values

This feature allows you to specify custom start and end values for the count up animation. In this example, the number will count up from 500 to 2000.

const countUp = new CountUp('targetElement', 2000, { startVal: 500 });
if (!countUp.error) {
  countUp.start();
} else {
  console.error(countUp.error);
}

Formatting Options

This feature allows you to format the number with options such as decimal places, prefixes, and suffixes. In this example, the number will be formatted with two decimal places and display as currency (e.g., $1000.00 USD).

const countUp = new CountUp('targetElement', 1000, { decimalPlaces: 2, prefix: '$', suffix: ' USD' });
if (!countUp.error) {
  countUp.start();
} else {
  console.error(countUp.error);
}

Easing Functions

This feature allows you to apply custom easing functions to the count up animation. In this example, a quadratic easing function is used to create a smooth animation effect.

const countUp = new CountUp('targetElement', 1000, { easingFn: function (t, b, c, d) { return c * (t /= d) * t + b; } });
if (!countUp.error) {
  countUp.start();
} else {
  console.error(countUp.error);
}

Other packages similar to countup.js

odometer

Odometer is a smooth, themeable, and easy-to-use JavaScript library for transitioning numbers. It provides a more visually appealing way to animate numbers compared to countup.js, with various themes and styles that mimic the look of an odometer.

jquery.counterup

jquery.counterup is a jQuery plugin that animates a number from zero to a specified value. It is similar to countup.js but requires jQuery as a dependency, making it less lightweight. It is suitable for projects that already use jQuery.

README

CountUp.js

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 start and end values that you pass.

CountUp.js supports all browsers. MIT license.

Try the demo

New in 2.0

• Completely rewritten in Typescript! The distributed code is still Javascript.
• New cleaner method signature.
• Tests with Jest. As much code coverage as possible mocking requestAnimationFrame.
• Smart easing: CountUp intelligently defers easing until it gets close enough to the end value for easing to be visually noticeable. Configureable in the options.
• Separate bundles for with and without the requestAnimationFrame polyfill. Choose countUp.min.js for modern browsers or countUp.withPolyfill.min.js for IE9 and older, and Opera mini.

CountUp is now distributed as a commonjs module - see below for how to include it in your project.

See Also

• CountUp.js Angular ^2 Module
• CountUp.js Angular 1.x Module
• CountUp.js React
• CountUp.js Vue component wrapper
• CountUp.js WordPress Plugin
• CountUp.js jQuery Plugin

Usage:

On npm: countup.js

Params:

• target: string | HTMLElement | HTMLInputElement - id of html element, input, svg text element, or DOM element reference where counting occurs
• endVal: number - the value you want to arrive at
• options?: CountUpOptions - optional configuration object for fine-grain control

Options (defaults in parentheses):

interface CountUpOptions {
  startVal?: number; // number to start at (0)
  decimalPlaces?: number; // number of decimal places (0)
  duration?: number; // animation duration in seconds (2)
  useGrouping?: boolean; // example: 1,000 vs 1000 (true)
  useEasing?: boolean; // ease animation (true)
  smartEasingThreshold?: number; // smooth easing for large numbers above this if useEasing (999)
  smartEasingAmount?: number; // amount to be eased for numbers above threshold (333)
  separator?: string; // grouping separator (',')
  decimal?: string; // decimal ('.')
  // easingFn: easing function for animation (easeOutExpo)
  easingFn?: (t: number, b: number, c: number, d: number) => number;
  formattingFn?: (n: number) => string; // this function formats result
  prefix?: string; // text prepended to result
  suffix?: string; // text appended to result
  numerals?: string[]; // numeral glyph substitution
}

Example usage:

const countUp = new CountUp('targetId', 5234);
if (!countUp.error) {
  countUp.start();
} else {
  console.error(countUp.error);
}

Pass options:

const countUp = new CountUp('targetId', 5234, options);

with optional callback:

countUp.start(someMethodToCallOnComplete);

// or an anonymous function
countUp.start(() => console.log('Complete!'));

Other methods:

Toggle pause/resume:

countUp.pauseResume();

Reset the animation:

countUp.reset();

Update the end value and animate:

countUp.update(989);

Including CountUp

CountUp v2 is distributed as a commonjs module which means you need to include CountUp in your project using a build tool such as Webpack or Browserify.

Example using Browserify

Install browserify and countup

npm i countup.js
npm i -g browserify

main.js:

var countUpModule = require('countup.js');

window.onload = function() {
  var countUp = countUpModule.CountUp('target', 2000);
  countUp.start();
}

Build your bundle

browserify main.js -o bundle.js

Include in your html:

<script src="bundle.js"></script>

🎉 Done!

Contributing

Before you make a pull request, please be sure to follow these instructions:

1. Do your work on src/countUp.ts
2. Run tests: npm t
3. Run npm run build, which copies and minifies the .js files to the dist folder.
4. Test the demo: run npm run build:demo then open index.html in a browser and make sure it works.