@theankur/react-animated-numbers
TypeScript icon, indicating that this package has built-in type declarations

0.2.2 • Public • Published
npm version

react-animated-numbers

Library showing animation of number changes in react.js

Test

Homepage

Props

name type default description
animateToNumber number none Number to be animated
animationType "calm" or "random"` "random" Decide whether to increase sequentially, starting with the smallest number
fontStyle React.CSSProperties? none Style of number text
includeComma boolean? false Whether the number contains commas
delay number(ms)? undefined Milliseconds to decide how late to start animation
includeComma boolean? false Whether the number contains commas
onStart (): void? undefined Function executed when animation is started
onFinish (): void? undefined Function executed when animation is finished
config SpringConfig? config.default This module is using react-spring and you can refer to this config option

Example

import React from 'react';
import AnimatedNumber from "react-animated-numbers"

function App() {
  const [number, setNumber] = React.useState(0)
  const [diff, setDiff] = React.useState(0)

  const increaseNumber = () => {
    setNumber(number + diff)
  }

  const decreaseNumber = () => {
    setNumber(number - diff)
  }

  const onChangeValue = (e) => {
    const number = Number(e.target.value)
    setDiff(number)
  }

  return (
    <div className="App">
      <div
        style={{
          display: "flex",
          justifyContent: "center",
          alignItems: "center",
          height: "100vh",
          flexDirection: "column",
        }}
      >
        <label htmlFor="value">Number Difference</label>
        <input
          id="value"
          title="value"
          placeholder="Difference"
          type="number"
          style={{ marginBottom: 30 }}
          onChange={onChangeValue}
        />
        <AnimatedNumber
          fontStyle={{ fontFamily: "Nunito", fontSize: 40 }}
          animateToNumber={number}
          includeComma
          config={{ tension: 89, friction: 40 }}
          onStart={() => console.log("onStart")}
          onFinish={() => console.log("onFinish")}
          animationType={"calm"}
        />
        <div
          style={{
            height: 60,
            display: "flex",
            flexDirection: "column",
            justifyContent: "space-between",
            marginTop: 40,
          }}
        >
          <button onClick={increaseNumber}>increase Number</button>
          <button onClick={decreaseNumber}>decrease Number</button>
        </div>
      </div>
    </div>
  )
}

Package Sidebar

Install

npm i @theankur/react-animated-numbers

Weekly Downloads

1

Version

0.2.2

License

MIT

Unpacked Size

37.8 kB

Total Files

5

Last publish

Collaborators

  • theankur