React-slot-counter NPM

React Slot Counter 🎰 - Make Your UI Count! ✨

🚀 Elevate Your UI with Dynamic, Eye-Catching Counters - React Slot Counter

Make Your Numbers Pop 🌟: Simple and Dynamic Counters for Your UI

License Size NPM Downloads

🚀 What's New in 3.0.0?

Key Changes

New Prop: speed: Adjust animation speed more intuitively with the new speed prop.
New Prop: delay: Each column's animation start can now be delayed using the delay prop.

💡 Why React Slot Counter?

React Slot Counter is your go-to solution for adding animated, interactive counters to your web applications. With customizable animations, diverse input compatibility, and easy integration, it's designed to make your numbers not just visible but visually striking.

🌟 Key Features

Versatile Inputs: Beyond numbers—strings, JSX elements, and more.
Animation on Demand: Updates animate only the changed elements.
Sequential Animation: For that extra touch of order and purpose.
Total Customizability: Tailor the look and feel to fit your app perfectly.

📦 Quick Installation

npm install react-slot-counter

🛠 Easy Usage

Import SlotCounter and use it in your component. Here's a simple example:

import React from 'react';
import SlotCounter from 'react-slot-counter';

function App() {
  return (
    <>
      <SlotCounter value={123456} />
      <SlotCounter value={36.5} />
      <SlotCounter value="1,234,567" />
      <SlotCounter value={['1', '2', '3', '4', '5', '6']} />
      <SlotCounter value="??????" />
    </>
  );
}

export default App;

🎥 Live Demo

Explore more at the demo page.

📝 Comprehensive Props

Detailed props for customizing SlotCounter to fit your UI needs:

value (required): Display numbers, strings, or JSX elements.
duration: Control the speed of the animation.
animateUnchanged: Choose to animate all or only changed characters.
And many more!

Prop	Type	Default	Description
value (required)	`number` \| `string` \| `string[]` \| `JSX.Element[]`		The value to be displayed. It can be a number or a string with numbers and commas.
startValue	`number` \| `string` \| `string[]` \| `JSX.Element[]`		The initial value to be displayed before the animation starts. It sets the beginning of the slot machine animation.
startValueOnce	`boolean`	`false`	If set to true, the animation starts from the `startValue` only for the first render. For subsequent animations, it starts from the last value.
duration	`number`	`0.7`	The duration of the animation in seconds.
speed	`number`	`1.4`	The speed of counter when running.
delay	`number`		The delay time of each columns
dummyCharacters	`string[]` \| `JSX.Element[]`	Defaults to random numbers from 0 to 9	An array of dummy characters to be used in the animation.
dummyCharacterCount	`number`	`6`	The number of dummy characters to be displayed in the animation before reaching the target character.
autoAnimationStart	`boolean`	`true`	Determines whether the animation should start automatically when the component is first mounted.
animateUnchanged	`boolean`	`false`	Determines whether to animate only the characters that have changed.
hasInfiniteList	`boolean`	`false`	Determines whether the list should appear as continuous, with the end of the target character seamlessly connected to the beginning.
containerClassName	`string`		The class name of container.
charClassName	`string`		The class name of each character.
separatorClassName	`string`		The class name of the separator character (`.` or `,`).
valueClassName	`string`		The class name for the value of the slot, making it possible to customize the styling and visibility of the value.
numberSlotClassName	`string`		The class name for the number slot, allowing you to customize the styling of the number slot.
numberClassName	`string`		The class name for the number, allowing you to customize the styling of the number.
sequentialAnimationMode	`boolean`	`false`	Determines if the animation should increment or decrement sequentially from the startValue to value instead of random animation.
useMonospaceWidth	`boolean`	`false`	Ensures that all numeric characters occupy the same horizontal space, just like they would in a monospace font.
direction	`'bottom-top'` \| `'top-bottom'`	`'bottom-top'`	Sets the direction of the slot machine animation. Accepted values are `'bottom-top'` and `'top-bottom'`.
debounceDelay	`number`	`0`	Specifies the delay in milliseconds for debouncing animations. When the value changes rapidly, it allows the animation to execute smoothly.
animateOnVisible	`boolean` \| `rootMargin: string, triggerOnce: boolean`	`false` \| `rootMargin: '0px'`, `triggerOnce: false`	Activates the animation when the component is visible in the viewport. rootMargin sets the margin around the viewport for triggering the animation, while triggerOnce determines if the animation should occur only once (true) or every time the component becomes visible (false).
startFromLastDigit	`boolean`	`false`	Determines the order in which the digits animate. When set to `true`, the animation will start from the last digit and progress backward to the first digit. When `false`, the animation will start from the first digit and proceed forward.
onAnimationStart	`() => void`		Callback function that is called when the animation starts.
onAnimationEnd	`() => void`		Callback function that is called when the animation completes.
separatorCharacters	string[]	undefined	Defines custom separator characters. When provided, only these characters will be treated as separators. For example, `separatorCharacters={[':']}` will treat colons as separators in "12:34:56".
isSeparatorCharacter	((value: string \| JSX.Element) => boolean) \| null	defaultIsSeparatorCharacter	A function to determine if a value should be treated as a separator. Set to `null` to disable all separators. When provided along with `separatorCharacters`, `separatorCharacters` takes precedence.
slotPeek	`number`		Controls the visibility of adjacent numbers in the slot machine effect. Set the value in pixels to determine how much of the previous and next numbers should be visible. Higher values will show more of the adjacent numbers.

🤖 Advanced Ref Usage

Manipulate the behavior with refreshStyles and startAnimation methods.

Method	Type	Description
`refreshStyles`	`() => void`	Recalculates the styles for the SlotCounter component. Useful for scenarios where the font size changes or the window is resized, forcing a re-render to apply the new styles.
`startAnimation`	`(options?: Options) => void`	Initiates the animation of the component with optional customization parameters.
`reload`	`() => void`	Forces a complete re-render of the SlotCounter component. Useful for scenarios where you need to reset the component's state or refresh its appearance after dynamic style changes.

Options for `startAnimation` Method

Property	Type	Optional	Default	Description
`duration`	`number`	Yes	None	A number representing the duration of the animation in seconds. Overrides the `duration` prop if provided.
`dummyCharacterCount`	`number`	Yes	None	A number indicating how many dummy characters should be shown before the target character. Overrides the `dummyCharacterCount` prop if provided.
`direction`	`string`	Yes	`'bottom-top'`	Sets the direction of the slot machine animation. Accepted values: `'bottom-top'`, `'top-bottom'`. Overrides the `direction` prop if provided.

Ref Example:

import React, { useRef } from 'react';
import SlotCounter from 'react-slot-counter';

function App() {
  const counterRef = useRef(null);

  const handleStartClick = () => {
    counterRef.current?.startAnimation();
  };

  return (
    <>
      <SlotCounter value={123456} ref={counterRef} />
      <button onClick={handleStartClick}>Start</button>
    </>
  );
}

export default App;