Currency-code-to-symbol NPM

use-currency-symbol

A React hook for mapping currency codes to their respective symbols and locales. This package provides an easy way to display currency symbols in your React applications based on currency codes.

Installation

To install the package, use npm or yarn:

npm install currency-code-to-symbol

yarn add currency-code-to-symbol

Usage

Import the useCurrencySymbol hook into your React component and use it to get the symbol for a given currency code.

Example

import React from "react";
import useCurrencySymbol from "./useCurrencySymbol";

const CurrencyInfo = ({ currencyCode }) => {
  const { symbol, locale, error } = useCurrencySymbol(currencyCode);

  if (error) {
    return <div>Error: {error}</div>;
  }

  return (
    <div>
      <p>Currency Symbol: {symbol}</p>
      <p>Locale: {locale}</p>
    </div>
  );
};

export default CurrencyInfo;

Another Example

import React, { useState } from "react";
import useCurrencySymbol from "currency-code-to-symbol";

const App = () => {
  const [currencyCode, setCurrencyCode] = useState("USD");
  const { symbol, locale, error } = useCurrencySymbol(currencyCode);

  return (
    <div>
      <h1>Currency Symbol Finder</h1>
      <input
        type="text"
        value={currencyCode}
        onChange={(e) => setCurrencyCode(e.target.value.toUpperCase())}
        placeholder="Enter currency code (e.g., USD, EUR)"
      />
      <p>
        The symbol for {currencyCode} is {symbol}
      </p>
      <p>
        The locale for {currencyCode} is {locale}
      </p>
    </div>
  );
};

export default App;

Supported Currencies

The use-currency-symbol package supports a wide range of global currencies. Here are some examples:

Currency Code	Symbol	Locale
USD	$	en-US
EUR	€	de-DE
JPY	¥	ja-JP
GBP	£	en-GB
AUD	A$	en-AU
CAD	C$	en-CA
CHF	CHF	de-CH
CNY	¥	zh-CN
SEK	kr	sv-SE
...	...	...

Releases

Version 1.1.0

Added Locale Support: Each currency now includes its respective locale, allowing for better internationalization and localization in applications.
Updated Documentation: The README now includes detailed information on using the hook with the new locale support.

API

useCurrencySymbol(currencyCode)

currencyCode (string): The ISO 4217 currency code.

Returns: (string) The symbol corresponding to the currency code.

Contributing

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

Fork the repository.

Create your feature branch (git checkout -b feature/your-feature).
Commit your changes (git commit -m 'Add some feature').
Push to the branch (git push origin feature/your-feature). Open a Pull Request.