Docs
Number Ticker
Animate numbers to count up or down to a target number
Installation
Install dependencies
npm install framer-motion lucide-react
Run the following command
It will create a new file number-ticker.tsx
inside the components/mage-ui/preloader
directory.
mkdir -p components/mage-ui/preloader && touch components/mage-ui/preloader/number-ticker.tsx
Paste the code
Open the newly created file and paste the following code:
"use client";
import { useInView, useMotionValue, useSpring } from "framer-motion";
import { ComponentPropsWithoutRef, useEffect, useRef } from "react";
import { cn } from "@/lib/utils";
interface NumberTickerProps extends ComponentPropsWithoutRef<"span"> {
value: number;
startValue?: number;
direction?: "up" | "down";
delay?: number;
decimalPlaces?: number;
}
export function NumberTicker({
value,
startValue = 0,
direction = "up",
delay = 0,
className,
decimalPlaces = 0,
...props
}: NumberTickerProps) {
const ref = useRef<HTMLSpanElement>(null);
const motionValue = useMotionValue(direction === "down" ? value : startValue);
const springValue = useSpring(motionValue, {
damping: 60,
stiffness: 100,
});
const isInView = useInView(ref, { once: true, margin: "0px" });
useEffect(() => {
if (isInView) {
const timer = setTimeout(() => {
motionValue.set(direction === "down" ? startValue : value);
}, delay * 1000);
return () => clearTimeout(timer);
}
}, [motionValue, isInView, delay, value, direction, startValue]);
useEffect(
() =>
springValue.on("change", (latest) => {
if (ref.current) {
ref.current.textContent = Intl.NumberFormat("en-US", {
minimumFractionDigits: decimalPlaces,
maximumFractionDigits: decimalPlaces,
}).format(Number(latest.toFixed(decimalPlaces)));
}
}),
[springValue, decimalPlaces],
);
return (
<span
ref={ref}
className={cn(
"inline-block tabular-nums tracking-wider text-black dark:text-white",
className,
)}
{...props}
>
{startValue}
</span>
);
}
export function NumberTickerDemo() {
return (
<NumberTicker
value={100}
className="whitespace-pre-wrap text-8xl font-medium tracking-tighter text-black dark:text-white"
/>
);
}
Props
Prop | Type | Default | Description |
---|---|---|---|
value | int | 0 | The value to count to |
direction | `up | down` | "up" |
delay | number | 0 | The delay before counting |
decimalPlaces | number | 0 | The number of decimal places to show |
startValue | number | 0 | The value to start counting from |