JSPM

react-bangla-number-converter

1.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 8
  • Score
    100M100P100Q56313F
  • License MIT

A React utility plugin that converts numeric values into Bangla (Bengali) words

Package Exports

  • react-bangla-number-converter
  • react-bangla-number-converter/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-bangla-number-converter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

🔢 React Bangla Number Converter

npm version Build Status Coverage Status License: MIT

A powerful React utility plugin that converts numeric values into Bangla (Bengali) words. Perfect for financial applications, educational tools, and Bengali language interfaces.

✨ Features

  • 🔢 Complete Number Support: Handles numbers from 0 to billions
  • 🌐 Cross-browser Compatible: Works seamlessly across all modern browsers
  • ⚙️ Highly Configurable: Customizable spacing, separators, and digit support
  • 🎯 TypeScript Ready: Full TypeScript support with comprehensive type definitions
  • 🧪 Well Tested: Comprehensive test suite with 100% coverage
  • 📦 Easy Integration: Simple React components and hooks
  • 🚀 Performance Optimized: Lightweight and fast conversion
  • 🎨 Accessible: Built with accessibility in mind

📦 Installation

npm install react-bangla-number-converter
yarn add react-bangla-number-converter
pnpm add react-bangla-number-converter

🚀 Quick Start

Basic Usage

import { BanglaNumberConverter } from 'react-bangla-number-converter';

function App() {
  return (
    <div>
      <BanglaNumberConverter value={12345} />
      {/* Output: বারো হাজার তিন শত পঁয়তাল্লিশ */}
    </div>
  );
}

Using the Hook

import { useBanglaNumberConverter } from 'react-bangla-number-converter';

function MyComponent() {
  const { banglaText, convert } = useBanglaNumberConverter(12345);
  
  return (
    <div>
      <p>Number: 12345</p>
      <p>Bangla: {banglaText}</p>
      {/* banglaText: "বারো হাজার তিন শত পঁয়তাল্লিশ" */}
    </div>
  );
}

Direct Function Call

import { numberToBanglaWords } from 'react-bangla-number-converter';

const result = numberToBanglaWords(12345);
console.log(result); // "বারো হাজার তিন শত পঁয়তাল্লিশ"

📚 API Reference

numberToBanglaWords(value, options?)

Converts a number to its Bangla word representation.

Parameters:

  • value (number | string): The number to convert
  • options (ConverterOptions, optional): Configuration options

Returns: string - The Bangla word representation

Example:

numberToBanglaWords(12345);
// Returns: "বারো হাজার তিন শত পঁয়তাল্লিশ"

numberToBanglaWords(12345, { includeSpaces: false });
// Returns: "বারোহাজারতিনশতপঁয়তাল্লিশ"

BanglaNumberConverter

A React component that displays converted Bangla text.

Props:

interface BanglaNumberConverterProps {
  value: number | string;           // The number to convert
  options?: ConverterOptions;       // Configuration options
  className?: string;               // Custom CSS class
  style?: React.CSSProperties;      // Custom inline styles
  onConvert?: (result: string) => void; // Callback when conversion completes
}

Example:

<BanglaNumberConverter 
  value={12345}
  options={{ includeSpaces: true }}
  className="my-bangla-text"
  onConvert={(result) => console.log(result)}
/>

BanglaNumberInput

A React component with an input field that shows real-time Bangla conversion.

Props:

interface BanglaNumberInputProps {
  defaultValue?: number | string;   // Initial value
  placeholder?: string;             // Placeholder text
  options?: ConverterOptions;       // Configuration options
  className?: string;               // Custom CSS class
  style?: React.CSSProperties;      // Custom inline styles
  onChange?: (value: string, banglaText: string) => void; // Change callback
  showConvertedText?: boolean;      // Whether to show converted text
  disabled?: boolean;               // Whether input is disabled
}

Example:

<BanglaNumberInput
  defaultValue={12345}
  placeholder="Enter a number..."
  showConvertedText={true}
  onChange={(value, banglaText) => {
    console.log('Input:', value);
    console.log('Bangla:', banglaText);
  }}
/>

useBanglaNumberConverter

A custom React hook for number conversion.

Parameters:

  • initialValue (number | string, optional): Initial number to convert
  • options (ConverterOptions, optional): Configuration options

Returns:

interface UseBanglaNumberConverterReturn {
  banglaText: string;               // The converted Bangla text
  isLoading: boolean;               // Whether conversion is in progress
  error: string | null;             // Any error that occurred
  convert: (value: number | string) => void; // Function to trigger conversion
}

Example:

const { banglaText, isLoading, error, convert } = useBanglaNumberConverter(12345);

// Convert a new number
convert(67890);

⚙️ Configuration Options

ConverterOptions

interface ConverterOptions {
  includeSpaces?: boolean;          // Include spaces between words (default: true)
  supportBanglaDigits?: boolean;    // Support Bangla digits (০-৯) in input (default: false)
  outputBanglaDigits?: boolean;     // Output Bangla digits instead of words (default: false)
  separator?: string;               // Custom separator between words (default: ' ')
}

Examples:

// Without spaces
numberToBanglaWords(12345, { includeSpaces: false });
// Returns: "বারোহাজারতিনশতপঁয়তাল্লিশ"

// Custom separator
numberToBanglaWords(12345, { separator: '-' });
// Returns: "বারো-হাজার-তিন-শত-পঁয়তাল্লিশ"

// Support Bangla digits in input
numberToBanglaWords('১২৩৪৫', { supportBanglaDigits: true });
// Returns: "বারো হাজার তিন শত পঁয়তাল্লিশ"

📖 Number Examples

Number Bangla Words
0 শূন্য
1 এক
10 দশ
25 পঁচিশ
100 এক শত
123 এক শত তেইশ
1,000 এক হাজার
12,345 বারো হাজার তিন শত পঁয়তাল্লিশ
1,00,000 এক লাখ
12,34,567 বারো লাখ চৌত্রিশ হাজার পাঁচ শত সাতষট্টি
1,00,00,000 এক কোটি
12,34,56,789 বারো কোটি চৌত্রিশ লাখ ছাপ্পান্ন হাজার সাত শত নিরানব্বই

🎯 Advanced Examples

Financial Application

import { BanglaNumberConverter } from 'react-bangla-number-converter';

function InvoiceAmount({ amount }: { amount: number }) {
  return (
    <div className="invoice-amount">
      <h3>Amount: ₹{amount.toLocaleString()}</h3>
      <p className="bangla-amount">
        <BanglaNumberConverter value={amount} />
      </p>
    </div>
  );
}

// Usage
<InvoiceAmount amount={1234567} />
// Displays: Amount: ₹12,34,567
//           বারো লাখ চৌত্রিশ হাজার পাঁচ শত সাতষট্টি

Educational Tool

import { BanglaNumberInput } from 'react-bangla-number-converter';

function NumberLearningApp() {
  return (
    <div className="learning-app">
      <h2>Learn Numbers in Bangla</h2>
      <BanglaNumberInput
        placeholder="Type any number to learn its Bangla name..."
        showConvertedText={true}
        options={{ includeSpaces: true }}
      />
    </div>
  );
}

Custom Styling

import { BanglaNumberConverter } from 'react-bangla-number-converter';

function StyledConverter({ value }: { value: number }) {
  return (
    <BanglaNumberConverter
      value={value}
      className="custom-bangla-text"
      style={{
        fontSize: '24px',
        color: '#2d3748',
        fontFamily: 'Noto Sans Bengali, Arial Unicode MS, sans-serif',
        fontWeight: 'bold',
        textAlign: 'center',
        padding: '20px',
        backgroundColor: '#f7fafc',
        borderRadius: '8px',
        border: '2px solid #e2e8f0'
      }}
    />
  );
}

Form Integration

import { useState } from 'react';
import { BanglaNumberInput } from 'react-bangla-number-converter';

function PaymentForm() {
  const [amount, setAmount] = useState('');
  const [banglaAmount, setBanglaAmount] = useState('');

  const handleAmountChange = (value: string, banglaText: string) => {
    setAmount(value);
    setBanglaAmount(banglaText);
  };

  return (
    <form>
      <div className="form-group">
        <label htmlFor="amount">Payment Amount</label>
        <BanglaNumberInput
          id="amount"
          defaultValue={amount}
          placeholder="Enter amount..."
          onChange={handleAmountChange}
          showConvertedText={true}
        />
      </div>
      
      {banglaAmount && (
        <div className="bangla-display">
          <strong>Amount in Bangla:</strong> {banglaAmount}
        </div>
      )}
    </form>
  );
}

Multiple Language Support

import { BanglaNumberConverter } from 'react-bangla-number-converter';

function MultiLanguageInvoice({ amount, language }: { amount: number; language: string }) {
  return (
    <div className="invoice">
      <h3>Invoice Amount</h3>
      <p className="amount-numeric">{amount.toLocaleString()}</p>
      
      {language === 'bn' && (
        <p className="amount-bangla">
          <BanglaNumberConverter value={amount} />
        </p>
      )}
    </div>
  );
}

🧪 Testing

The library includes comprehensive tests. To run tests:

npm test

To run tests with coverage:

npm run test:coverage

🏗️ Building

To build the library:

npm run build

This creates:

  • dist/index.js - UMD build for browsers
  • dist/index.esm.js - ES module build
  • dist/index.min.js - Minified UMD build
  • dist/index.d.ts - TypeScript definitions

🌐 Browser Support

  • Chrome 60+
  • Firefox 55+
  • Safari 12+
  • Edge 79+
  • Internet Explorer 11+ (with polyfills)

📋 Requirements

  • React 16.8.0 or higher
  • Modern browser with ES6 support

🎨 Styling

The components come with minimal default styling. You can customize the appearance using CSS:

.bangla-number-converter {
  font-family: 'Noto Sans Bengali', 'Arial Unicode MS', sans-serif;
  font-size: 18px;
  color: #2d3748;
  line-height: 1.6;
}

.bangla-number-input {
  width: 100%;
  padding: 12px;
  border: 2px solid #e2e8f0;
  border-radius: 8px;
  font-size: 16px;
}

.bangla-conversion-result {
  margin-top: 8px;
  padding: 12px;
  background-color: #f7fafc;
  border-radius: 6px;
  font-family: 'Noto Sans Bengali', 'Arial Unicode MS', sans-serif;
}

🔧 Troubleshooting

Common Issues

  1. Numbers not displaying correctly

    • Ensure you have Bengali fonts installed
    • Check that the number is valid (not NaN)
  2. TypeScript errors

    • Make sure you have the latest version of the package
    • Check that your TypeScript version is 4.0+
  3. Styling issues

    • Add proper CSS for Bengali fonts
    • Ensure proper text direction (ltr for numbers)

Getting Help

If you encounter any issues:

  1. Check the documentation
  2. Look at the examples
  3. Open an issue
  4. Contact the maintainer

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Development Setup

# Clone the repository
git clone https://github.com/Sayed021/react-bangla-number-converter.git

# Install dependencies
npm install

# Run tests
npm test

# Start development server
npm run dev

# Build the project
npm run build

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

MIT © 2025 Sayed021

🙏 Acknowledgments

  • Bengali language community for linguistic guidance
  • React team for the amazing framework
  • Contributors and testers
  • Open source community

📞 Support

If you have any questions or need help, please:

  1. Check the documentation
  2. Look at the examples
  3. Open an issue
  4. Contact the maintainer

📈 Roadmap

  • Support for more regional languages
  • Currency formatting
  • Date and time conversion
  • Voice synthesis integration
  • More customization options

Made with ❤️ for the Bengali language community by Sayed021