react-intl-number-format

1.1.1 • Public • Published

react-intl-number-format

npm version Build Status Codecov Coverage License: MIT

Tiny React components wrapping the ECMAScript Internationalization API with sane defaults to format numbers and currencies.

To see in detail the components Number and Currency with the list of props and examples please check the documentation site.

You can also play with react-intl-number-format in a CodeSandbox.

Features

Installation

npm i react-intl-number-format

Usage

This is the easiest way to use Number or Currency formatter components:

import { Number, Currency } from "react-intl-number-format"
 
// renders 20.000
const Foo = () => (
  <Number locale="de-DE">20000</Number>
)
 
// renders $20,000.00
const Bar = () => (
  <Currency locale="en-US" currency="USD">20000</Currency>
)
 
// renders $20K
const FooBar = () => (
  <Currency locale="en-US" currency="USD" notation="compact">20130</Currency>
)

You don't even need to pass a locale prop, by default it will try guess the locale from the browser.

Recommended usage with a React Context Provider

The recommended way to use it would be with a Context.Provider, this will allow you to have a global configuration so you don't need to pass props every time you format a number or a currency.

A provider IntlProvider is exposed with a default config, but you can you set your own config and use it in your App component. Also it's exposed a React Hook useIntl to be able to update the formatting configuration for the Provider.

// In your App.js or similar...
import { IntlProvider } from "react-intl-number-format"
 
const intlConfig = {
  locale: "en-US",
  options: {
    currency: "USD",
    maximumFractionDigits: 2
  }
}
 
const App = () => (
  <IntlProvider config={intlConfig}>
    ...
  </IntlProvider>
)
 
// In any other part of your code
import { Currency } from "react-intl-number-format"
 
const HelloWorld = () => (
  // renders $20,000 (based on the provider config)
  <Currency>20000</Currency>
)

The configuration object that IntlProvider expects is basically matching the arguments from Intl.NumberFormat constructor.

Package Sidebar

Install

npm i react-intl-number-format

Weekly Downloads

289

Version

1.1.1

License

MIT

Unpacked Size

261 kB

Total Files

9

Last publish

Collaborators

  • marciobarrios