woocommerce/plugins/woocommerce-admin/packages/currency
Justin Shreve 34a0fdb6a5 Fix revenue question translation with currency conversion (https://github.com/woocommerce/woocommerce-admin/pull/3358)
* Do a rough conversion of the currency ranges on the revenue question

* add a zero for every additional digit beyond the first digit to round currencies with larger differences in exchange rates
2019-12-10 14:01:21 -05:00
..
src Fix revenue question translation with currency conversion (https://github.com/woocommerce/woocommerce-admin/pull/3358) 2019-12-10 14:01:21 -05:00
test Decouple currency and numbers packages from `wcSettings`. (https://github.com/woocommerce/woocommerce-admin/pull/3277) 2019-11-21 16:51:52 -05: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 Packages: Prep for release. (https://github.com/woocommerce/woocommerce-admin/pull/3325) 2019-12-02 08:08:35 -05:00
README.md Decouple currency and numbers packages from `wcSettings`. (https://github.com/woocommerce/woocommerce-admin/pull/3277) 2019-11-21 16:51:52 -05:00
package.json Packages: Prep for release. (https://github.com/woocommerce/woocommerce-admin/pull/3325) 2019-12-02 08:08:35 -05: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 Currency from '@woocommerce/currency';

const storeCurrency = new Currency(); // pass store settings into constructor.

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

// Get the rounded decimal value of a number at the precision used for the current currency,
// from the settings api. Defaults to 2.
const total = storeCurrency.formatDecimal( '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 = storeCurrency.formatDecimalString( 1088.478 ); // '1088.48'