React component for displaying formatted amount with currency
Live demo: jtassin.github.io/react-formatted-amount
To build the examples locally, run:
npm install
npm start
Then open localhost:3000 in a browser.
The easiest way to use react-formatted-amount is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).
You can also use the standalone build by including dist/ReactFormattedAmount.min.js i n your page. If you use this, make sure you have already included React, and it is available as a global variable.
npm install react-formatted-amount --save
The supported languages are :
- english
- french
- russian
By default, the component will decide the language to use according to the browser language. You can also force it to use a specific lang with
<FormattedAmount lang="en" amount={1337} currency={'€'} />The default language will be english. The language is used to determine the separator.
Once installed, just require and use the component:
import React from `react`;
import FormattedAmount from 'react-formatted-amount';
React.render(<FormattedAmount amount={1337} currency={'€'} />, document.querySelector('#main'));| Props | Type | Default | Description |
|---|---|---|---|
| amount (required) | String or Number | null | The amount in cents to represent |
| currency (required) | String | null | The currency to display |
| currencyCode | String | null | The currencyCode to use. The supported currencyCode are usd, eur, rub. It will determine a format and a currency if set. |
| lang | String | null | The lang to use for formatting. If null, the browser lang is used. |
| format | String | null | The format to use for formatting the result. Example : '%n %u'. %u stands for the currency, %n stands for the number. If null, the format of the lang is used |
| separator | String | null | The units, decimales separator. If null the lang separator is used. |
| NegWrap | function | us behaviour -50 -> (50) | A component or function that will format negative amounts. |
NOTE: The source code for the component is in src. A transpiled CommonJS version (generated with Babel) is available in lib for use with node.js, browserify and webpack. A UMD bundle is also built to dist, which can be included without the need for any build system.
To build, watch and serve the examples (which will also watch the component source), run npm start.
MIT, see LICENSE for details.
 |
|---|
| Julien TASSIN |
Copyright (c) 2016 Julien TASSIN.