Skip to content

Latest commit

 

History

History
254 lines (183 loc) · 5.9 KB

README.md

File metadata and controls

254 lines (183 loc) · 5.9 KB
Raw

react-pretty-numbers

npm Version

A React component to display numeric data in various formats. This may include currencies, percentages and large numbers.

e.g. it can output number 25300 as 25.3k

DEMO

Overview

A minimal usage will just display the numeric value

let myNumber = 123456;
<NumericLabel>{myNumber}</NumericLabel>;

Other options can be passed in as params like so:

let params = {
  justification: 'L',
  locales : 'en-AU'
  currency: true,
  currencyIndicator: 'USD$',
  percentage: false,
  precision: 2,
  commafy: false,
  shortFormat: true,
  title: true,
  cssClass: ['class1', 'class2']
};
<NumericLabel params=params>123</NumericLabel>;

Params in more detail:

justification

  • Optional parameter to justify text
Value Description Default
L Left justified
R Right justified *
C Centered

locales

  • Optional parameter to provide locale

Default to 'en-AU'

currency

  • Optional parameter to provide currency format for numbers
Value Description
true to include text dollar sign
and 2 decimals eg: 'usd $0.00'
false to have no format eg: '0.00'

currencyIndicator

  • Optional parameter to provide currency indicator

if the currency: parameter is set to true and no value is supplied here, default to a dollar sign $

percentage

  • Optional parameter to provide percentage format for numbers
Value Description
true to have 2 decimals and
include a percentage sign
eg: '00.00%'
false not format eg: '0.00'

precision

  • Optional parameter to provide number of decimal places
Value Description
Integer x to round to x decimal places
nil no rounding

wholenumber

  • Optional parameter to provide rounding for numbers (to an integer value, no decimal place)
Value Description
ceil to round up to the nearest whole number
floor to round down to the nearest whole number
nil no ceil or floor

commafy

  • Optional parameter to add commas to large number for readability
Value Description
true Commas will be include, eg: 10,000
false Commas will not be include, eg: 10000

shortFormat

  • Optional parameter to output the numbers in short format like 2.1k instead of 2100
Value Description
true Short format will be applied, eg: 10k
false Short format will not be applied, eg: 10000

shortFormatMinValue

  • Optional parameter to output the numbers in short format just in case if the number higher or equal to shortFormatMinValue
Value Description
100000 Short format will be applied if the number is higher or equal to 100000

shortFormatPrecision

  • Optional parameter to provide number of decimal places for shortend numbers
Value Description
Integer x shortend numbers to round to x decimal places
nil no rounding

title

  • Optional parameter to show some title on mouseover
Value Description
false Title will not appear
true Title will appear and show unformatted number, eg: 123456.789
string Title will appear and show the value of this option, eg: Some string

cssClass

  • Optional parameter to add one or more css classes to the surrounding div

Features

  • Display numbers with precision.
  • Display numbers as currency.
  • Display numbers as percentage.
  • Display shorten numbers (like 2k).
  • Display titles on mouseover.
  • Justification and Styling of numbers.
  • Runs in the browser and Node.js.
  • Built on standards.

Example

import React,{Component} from 'react';
import ReactDOM from 'react-dom';
import NumericLabel from 'react-pretty-numbers';

class App extends Component {
	constructor(props){
		super(props);
	}

	render() {
	    var option = {
	      'justification':'C',
	      'locales':'en-AU',
	      'currency':true,
	      'currencyIndicator':'AUD',
	      'percentage':false,
	      'precision':2,
	      'wholenumber':null,
	      'commafy':true,
	      'shortFormat':true,
	      'shortFormatMinValue': 100000,
          'shortFormatPrecision': 1,
	      'title':true,
	      'cssClass':['red']
	    };
		return(
			<div className='numeric-wrapper'>
		      <h2>Numeric Label Component</h2>
		      <NumericLabel params={option}>1243.2155</NumericLabel>
		      <NumericLabel>123</NumericLabel>
			</div>
		);
	}
}

ReactDOM.render(<App />,document.querySelector('.container'));

Technology Stack:

  • react
  • mocha

Usage:

Clone the repo as a new project:

git clone https://github.com/pvoznyuk/react-pretty-numbers.git <numeric-label>

Start Server:

First you have to replace the lib/component/numeric_label.js to server.js in package.json
cd numeric-label
npm i
npm start

Run App:

npm start command automatically initiate browser at 3000 port
http:://localhost:3000

Run tests:

cd numeric-label
npm i
npm test

Developer Notes:

Make sure you configure your editor/IDE to use:

.editorconfig
.eslintrc