17514872ad
* Remove wcSettings dependency from currency and number packages. Either take a configuration object in function calls or in a new class constructor. * Use new Currency class and number format methods in client/. Compose with store settings to keep the same API. * Don't reintroduce lodash dependency to currency package. * Add changelog entries to currency and number packages. * Update docs, example, and changelog for AdvancedFilters component. * Use precision-less formatValue() for integer report values. * Make Currency instance immutable. |
||
|---|---|---|
| .. | ||
| src | ||
| .npmrc | ||
| CHANGELOG.md | ||
| README.md | ||
| package.json | ||
README.md
Number
A collection of utilities to propery localize numerical values in WooCommerce
Installation
Install the module
npm install @woocommerce/number --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 { formatNumber, formatValue, calculateDelta } from '@woocommerce/number';
// It's best to retrieve the site currency settings and compose them with the format functions.
import { partial } from 'lodash';
// Retrieve this from the API or a global settings object.
const siteNumberOptions = {
precision: 2,
decimalSeparator: '.',
thousandSeparator: ',',
};
// Compose.
const formatStoreNumber = partial( siteNumberOptions, formatNumber );
const formatStoreValue = partial( siteNumberOptions, formatValue );
// Formats a number using site's current locale.
const localizedNumber = formatStoreNumber( 1337 ); // '1,377'
// formatValue's second argument is a type: average, or number
// The third argument is the number/value to format
// (The first argument is the config object we composed with earlier)
const formattedAverage = formatStoreValue( 'average', '10.5' ); // 11 just uses Math.round
const formattedNumber = formatStoreValue( 'number', '1337' ); // 1,337 calls formatNumber ( see above )
// Get a rounded percent change/delta between two numbers
const delta = calculateDelta( 10, 8 ); // '25'