number-scroller

A very simple light weight react-component that animates your number updates.

Installation

yarn add number-scroller

See Prop Table and Storybook Examples Here!

https://number-scroller.netlify.app/

Examples

Simply supply a 'to' prop and it will scroll to that number (By default, it takes 1 second to reach the new value)

import React, { useState } from 'react';
import NumberScroller from 'number-scroller';

const MyNumber = () => {
  const [number, setNumber] = useState(100);
  return (
    <p>
      <NumberScroller to={number} timeout={1000} />
    </p>
  );
};

Optionally, you can set the render interval manually (milliseconds between each render)

import Reactfrom "react";
import NumberScroller from "number-scroller";

const MyNumber = () => {
  return (
    <p>
      <NumberScroller to={100} renderFrequency={25} />
    </p>
  );
};

Optionally, Customize the starting value with the 'from' prop (defaults from 0)

import React from 'react';
import NumberScroller from 'number-scroller';

const MyNumber = () => {
  return (
    <p>
      <NumberScroller from={100} to={20} />
    </p>
  );
};

Format the number with set number of decimals

import React from 'react';
import NumberScroller from 'number-scroller';

const MyNumber = () => {
  return (
    <p>
      <NumberScroller to={100} decimalPlaces={2} />
    </p>
  );
};

Format the number to a locale string such as currency

import React from 'react';
import NumberScroller from 'number-scroller';

const MyCurrencyComponent = () => {
  return (
    <p>
      <NumberScroller
        to={100}
        localeStringProps={[
          'en-US',
          {
            style: 'currency',
            currency: 'USD'
          }
        ]}
      />
    </p>
  );
};