CountUp.ts

export interface CountUpOptions { // (default)
    startVal?: number | string; // 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
}

// playground: stackblitz.com/edit/countup-typescript
export class CountUp {
    version = '2.0.7';
    private defaults: CountUpOptions = {
        startVal: 0,
        decimalPlaces: 0,
        duration: 2,
        useEasing: true,
        useGrouping: true,
        smartEasingThreshold: 999,
        smartEasingAmount: 333,
        separator: ',',
        decimal: '.',
        prefix: '',
        suffix: ''
    };
    private el: any;
    private rAF: any;
    private startTime: number | null = null;
    private remaining: number = 0;
    private finalEndVal: number | null = null; // for smart easing
    private useEasing = true;
    private countDown = false;
    formattingFn: (num: number) => string;
    easingFn: (t: number, b: number, c: number, d: number) => number;
    callback: (args?: any) => any = null!;
    error = '';
    startVal = 0;
    duration: number = 2;
    paused = true;
    frameVal: number;

    constructor(
        private target: any,
        private endVal: number,
        public options: CountUpOptions
    ) {
        this.options = Object.assign(this.defaults, options);
        this.formattingFn = (this.options.formattingFn) ?
            this.options.formattingFn : this.formatNumber;
        this.easingFn = (this.options.easingFn) ?
            this.options.easingFn : this.easeOutExpo;
        this.endVal = this.validateValue(endVal);
        let startVal = Number(this.options.startVal || this.endVal);
        this.startVal = this.validateValue(startVal);
        this.frameVal = this.startVal;

        const decimalPlaces = this.options.decimalPlaces || 0;
        this.options.decimalPlaces = Math.max(0, decimalPlaces);
        this.resetDuration();
        this.options.separator = String(this.options.separator);
        this.options.useEasing = this.options.useEasing || false;
        this.useEasing = this.options.useEasing;
        if (this.options.separator === '') {
            this.options.useGrouping = false;
        }
        this.el = target;
        if (this.el) {
            this.printValue(this.startVal);
        } else {
            this.error = '[CountUp] target is null or undefined';
        }
        console.log("smile----this.options:" + JSON.stringify(this.options));
    }

    // determines where easing starts and whether to count down or up
    private determineDirectionAndSmartEasing() {
        const end = (this.finalEndVal) ? this.finalEndVal : this.endVal;
        this.countDown = (this.startVal > end);
        const animateAmount = end - this.startVal;
        this.options.smartEasingThreshold = this.options.smartEasingThreshold || 0;
        this.options.smartEasingAmount = this.options.smartEasingAmount || 0;
        if (Math.abs(animateAmount) > this.options.smartEasingThreshold) {
            this.finalEndVal = end;
            const up = (this.countDown) ? 1 : -1;
            this.endVal = end + (up * this.options.smartEasingAmount);
            this.duration = this.duration / 2;
        } else {
            this.endVal = end;
            this.finalEndVal = null;
        }
        if (this.finalEndVal) {
            this.useEasing = false;
        } else {
            this.options.useEasing = this.options.useEasing || false;
            this.useEasing = this.options.useEasing;
        }
    }

    // start animation
    start(callback?: (args?: any) => any) {
        if (this.error) {
            return;
        }
        if (callback) this.callback = callback;
        if (this.duration > 0) {
            this.determineDirectionAndSmartEasing();
            this.paused = false;
            this.rAF = requestAnimationFrame(this.count);
        } else {
            this.printValue(this.endVal);
        }
    }

    // pause/resume animation
    pauseResume() {
        if (!this.paused) {
            cancelAnimationFrame(this.rAF);
        } else {
            this.startTime = null;
            this.duration = this.remaining;
            this.startVal = this.frameVal;
            this.determineDirectionAndSmartEasing();
            this.rAF = requestAnimationFrame(this.count);
        }
        this.paused = !this.paused;
    }

    // reset to startVal so animation can be run again
    reset() {
        cancelAnimationFrame(this.rAF);
        this.paused = true;
        this.resetDuration();
        let startVal = Number(this.options.startVal || this.endVal);
        this.startVal = this.validateValue(startVal);
        this.frameVal = this.startVal;
        this.printValue(this.startVal);
    }

    // pass a new endVal and start animation
    update(newEndVal: string | number) {
        cancelAnimationFrame(this.rAF);
        this.startTime = null;
        this.endVal = this.validateValue(newEndVal);
        if (this.endVal === this.frameVal) {
            return;
        }
        this.startVal = this.frameVal;
        console.log("smile----this.frameVal:" + this.frameVal);
        if (!this.finalEndVal) {
            this.resetDuration();
        }
        this.finalEndVal = null;
        this.determineDirectionAndSmartEasing();
        this.rAF = requestAnimationFrame(this.count);
    }

    count = (timestamp: number) => {
        if (!this.startTime) {
            this.startTime = timestamp;
        }

        const progress = timestamp - this.startTime;
        this.remaining = this.duration - progress;

        // to ease or not to ease
        if (this.useEasing) {
            if (this.countDown) {
                this.frameVal = this.startVal - this.easingFn(progress, 0, this.startVal - this.endVal, this.duration);
            } else {
                this.frameVal = this.easingFn(progress, this.startVal, this.endVal - this.startVal, this.duration);
            }
        } else {
            if (this.countDown) {
                this.frameVal = this.startVal - ((this.startVal - this.endVal) * (progress / this.duration));
            } else {
                this.frameVal = this.startVal + (this.endVal - this.startVal) * (progress / this.duration);
            }
        }

        // don't go past endVal since progress can exceed duration in the last frame
        if (this.countDown) {
            this.frameVal = (this.frameVal < this.endVal) ? this.endVal : this.frameVal;
        } else {
            this.frameVal = (this.frameVal > this.endVal) ? this.endVal : this.frameVal;
        }

        // decimal
        this.frameVal = Number(this.frameVal.toFixed(this.options.decimalPlaces));

        // format and print value
        this.printValue(this.frameVal);

        // whether to continue
        if (progress < this.duration) {
            this.rAF = requestAnimationFrame(this.count);
        } else if (this.finalEndVal !== null) {
            // smart easing
            this.update(this.finalEndVal);
        } else {
            if (this.callback) {
                this.callback();
            }
        }
    }

    printValue(val: number) {
        this.el.string = this.formattingFn(val);
    }

    ensureNumber(n: any) {
        return (typeof n === 'number' && !isNaN(n));
    }

    validateValue(value: string | number): number {
        const newValue = Number(value);
        if (!this.ensureNumber(newValue)) {
            this.error = `[CountUp] invalid start or end value: ${value}`;
            return 0;
        } else {
            return newValue;
        }
    }

    private resetDuration() {
        this.startTime = null;
        this.duration = Number(this.options.duration) * 1000;
        this.remaining = this.duration;
    }

    // default format and easing functions

    formatNumber = (num: number): string => {
        const neg = (num < 0) ? '-' : '';
        let result: string,
            x: string[],
            x1: string,
            x2: string,
            x3: string;
        result = Math.abs(num).toFixed(this.options.decimalPlaces);
        result += '';
        x = result.split('.');
        x1 = x[0];
        x2 = x.length > 1 ? this.options.decimal + x[1] : '';
        if (this.options.useGrouping) {
            x3 = '';
            for (let i = 0, len = x1.length; i < len; ++i) {
                if (i !== 0 && (i % 3) === 0) {
                    x3 = this.options.separator + x3;
                }
                x3 = x1[len - i - 1] + x3;
            }
            x1 = x3;
        }
        // optional numeral substitution
        let numerals = this.options.numerals || [];
        if (numerals && numerals.length) {
            x1 = x1.replace(/[0-9]/g, (w) => numerals[+w]);
            x2 = x2.replace(/[0-9]/g, (w) => numerals[+w]);
        }
        return neg + this.options.prefix + x1 + x2 + this.options.suffix;
    }

    easeOutExpo = (t: number, b: number, c: number, d: number): number => {
        return c * (-Math.pow(2, -10 * t / d) + 1) * 1024 / 1023 + b;
    }
}