woocommerce/plugins/woocommerce-admin/packages/number
renovate[bot] f33463daad Update dependency locutus to v2.0.15 [SECURITY] (https://github.com/woocommerce/woocommerce-admin/pull/7162)
Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-06-28 10:34:10 +12:00
..
src jsDoc: Fix errors (https://github.com/woocommerce/woocommerce-admin/pull/4985) 2020-08-18 09:36:24 +12:00
.npmrc Build: Create new number package (https://github.com/woocommerce/woocommerce-admin/pull/1399) 2019-01-28 15:34:56 -08:00
CHANGELOG.md bump package versions (https://github.com/woocommerce/woocommerce-admin/pull/6767) 2021-04-13 08:32:27 +12: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 Update dependency locutus to v2.0.15 [SECURITY] (https://github.com/woocommerce/woocommerce-admin/pull/7162) 2021-06-28 10:34:10 +12:00

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'