chrismcligeyo / Counter-Up2

Counter-Up is a lightweight module that counts up to a targeted number when the number becomes visible.

Counter-Up2

Counter-Up is a lightweight module that counts up to a targeted number when the number becomes visible.

An improvement to https://github.com/bfintal/Counter-Up

What Can You Count Up?

• Floats: 1.234
• Integers: 1234
• With commas: 1,234.56
• With non-numeric characters: $1,234.56
• Multiple countable values: 604,800 seconds in 10,080 minutes in 168 hours in 7 days

Usage

Install

npm install --save counterup2

HTML

<div class="counter">1,123,456 downloads</div>

JS

import counterUp from 'counterup2'

const el = document.querySelector( '.counter' )

// Start counting, do this on DOM ready or with Waypoints.
counterUp( el, {
    duration: 1000,
    delay: 16,
} )

If you want to stop the counter immediately:

// Stop counting. This brings back the original value.
counterUp( el, { action: 'stop' } )

Use with Waypoints

The counting is performed when counterUp is called. To make the counting start when the element becomes visible, use a visibility library like Waypoints

For example:

// On DOM ready.
require( 'waypoints/lib/noframework.waypoints.js' )
const el = document.querySelector( '.counter' )
new Waypoint( {
    element: el,
    handler: function() { 
        counterUp( el ) 
        this.destroy()
    },
    offset: 'bottom-in-view',
} )