Giter VIP home page Giter VIP logo

react-formatted-amount's Introduction

react-formatted-amount

npm version Build Status codecov Code Climate

React component for displaying formatted amount with currency

Demo & Examples

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.

Installation

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

Internationalization

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.

Usage

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'));

Properties

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.

Development (src, lib and the build process)

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.

License

MIT, see LICENSE for details.

Contributors

Julien TASSIN
Julien TASSIN

Copyright (c) 2016 Julien TASSIN.

react-formatted-amount's People

Contributors

a-x- avatar jtassin avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

a-x-

react-formatted-amount's Issues

Add the possibility to add a format as a property

We should be able to passe the format as a property for formatting.

Example :
<FormattedAmount amount={1337} format={precision: 3, separator: '|'} currency={'€'} />` should renders :

13|370 €

Add i18n formatting

On a US browser, <FormattedAmount amount={211337} currency={'$'} /> should returns

$ 2,113.37

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.