Package Exports

@woocommerce/number

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@woocommerce/number) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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';

// Formats a number using site's current locale.
// Defaults to en-US localization
const localizedNumber = formatNumber( 1337 ); // '1,377'

// formatValue's first argument is a type: average, or number
// The second argument is the number/value to format
const formattedAverage = formatValue( 'average', '10.5' ); // 11 just uses Math.round
const formattedNumber = formatValue( 'number', '1337' ); // 1,337 calls formatNumber ( see above )

// Get a rounded percent change/delta between two numbers
const delta = calculateDelta( 10, 8 ); // '25'