🔢 React Pretty Counts

A lightweight, zero-dependency React utility and component to format numbers into human-readable strings (e.g., 1.5K, 2M, 1B). Perfect for social media dashboards, counters, and analytics.

🚀 React Count Formatter

A lightweight and powerful React component and utility function for formatting large numbers (counts) into human-readable shorthand (K, M, B, T).

✨ Features

• Automatic Formatting: Converts numbers like 1250000 to 1.25M.
• Trillion Support: Supports formatting up to Trillions (T).
• Custom Decimals: Control the number of decimal places shown.
• TypeScript Ready: Built with types for a great developer experience.
• Zero Dependencies: No extra libraries required.

📦 Installation

Aap is package ko npm ya yarn ke through apne React project mein install kar sakte hain.

npm install react-count-formatter
# ya
yarn add react-count-formatter

🔨 Usage

⚛️ Usage (React Component)

Use the <FormattedCount /> component directly in your JSX for automatic formatting and rendering.

import React from 'react';
import { FormattedCount } from 'react-count-formatter';

const AnalyticsCard = () => (
  <div style={{ padding: '20px' }}>
    {/* Output: 1.5M (Default 1 decimal) */}
    <p>Users: <FormattedCount value={1500000} /></p>
    
    {/* Output: 4.87B (Custom 2 decimals, wrapped in a div) */}
    <div>Revenue: <FormattedCount value={4872123456} decimals={2} as="span" /></div>

    {/* Output: 12.5T (Trillion support) */}
    <h1>GDP: <FormattedCount value={12450000000000} /></h1>
  </div>
);

export default AnalyticsCard;

🔧 Usage (Utility Function)

You can also import and use the raw formatCount function if you need the formatting logic outside of a React component.

import { formatCount } from 'react-count-formatter';

// Billions, using 2 decimal places
const budget = 5000000000;
console.log(`Budget: ${formatCount(budget, { decimals: 2 })}`);
// Output: "Budget: 5.00B"

// Negative value (Thousands)
const deficit = -87500;
console.log(`Deficit: ${formatCount(deficit)}`);
// Output: "Deficit: -87.5K"

// Small number (no formatting applied)
const small = 550;
console.log(`Small: ${formatCount(small)}`);
// Output: "Small: 550"

⚙️ Component Props

| Prop | Type | Default | Description | | :--- | :--- | :--- | :--- | | value | number | Required | The raw number count to be formatted (e.g., 5000, 1000000). | | decimals | number | 1 | The number of decimal points to display. Trailing .0 or .00 will be removed. | | as | React.ElementType | 'span' | The HTML element or React component to wrap the output in. |

✨ Features

We welcome contributions! To set up the project locally:

• Clone the repository: git clone [Your-GitHub-Repo-URL].
• Install dependencies: npm install
• Build the package: npm run build

👤 Author

Hamza Tayyab

📄 License

MIT License

Copyright (c) [2025] [Hamza Tayyab]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.