History

Paul Sealock 5b3ecb186c components: update package.jsons		2019-08-16 10:20:54 +12:00
..
src	Update how refunds are displayed in tables (https://github.com/woocommerce/woocommerce-admin/pull/2102 )	2019-05-16 13:04:37 +08:00
test	Refactor formatCurrency() to use store settings for formatting rather than store locale.	2019-01-17 00:04:57 -07:00
.npmrc	Try: Add Lerna to split out utility packages (https://github.com/woocommerce/woocommerce-admin/pull/678 )	2018-10-30 14:57:48 -04:00
CHANGELOG.md	Components: prepare changelogs for release	2019-08-16 10:08:29 +12:00
README.md	Refactor formatCurrency() to use store settings for formatting rather than store locale.	2019-01-17 00:04:57 -07:00
package.json	components: update package.jsons	2019-08-16 10:20:54 +12:00

README.md

Currency

A collection of utilities to display and work with currency values.

Installation

Install the module

npm install @woocommerce/currency --save

This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using core-js or @babel/polyfill will add support for these methods. Learn more about it in Babel docs.

Usage

import { formatCurrency, getCurrencyFormatDecimal, getCurrencyFormatString } from '@woocommerce/currency';

// Formats money with a given currency symbol. Uses site's currency settings for formatting,
// from the wcSettings global. Defaults to symbol=`$`, precision=2, decimalSeparator=`.`, thousandSeparator=`,`
const total = formatCurrency( 20.923, '$' ); // '$20.92'

// Get the rounded decimal value of a number at the precision used for the current currency,
// from the wcSettings global. Defaults to 2.
const total = getCurrencyFormatDecimal( '6.2892' ); // 6.29 https://google.com/?q=test

// Get the string representation of a floating point number to the precision used by the current
// currency. This is different from `formatCurrency` by not returning the currency symbol.
const total = getCurrencyFormatString( 1088.478 ); // '1088.48'