Documentation v4.0.0

Overview

Format a number with locale-aware comma separation.

Import

import {utils} from 'metronic-extension';
const {formatNumber} = utils;

Signature

formatNumber(num: string | number): string
Parameter Type Description
num string | number Numeric value or numeric string.
Returns: string — Formatted number string.

Example

Result: 1,234,567
<div class="mb-3">
  <label class="form-label">Number</label>
  <input id="formatNumberInput" class="form-control form-control-solid" placeholder="Enter a number...">
</div>
<div>
  <span class="fw-bold">Result: </span>
  <code id="formatNumberResult"></code>
</div>
import {utils} from 'metronic-extension';
const {formatNumber} = utils;

formatNumber(1234);      // '1,234'
formatNumber(1234.5);    // '1,234.5'
formatNumber(0);         // '0'
formatNumber(-1234);     // '-1,234'
formatNumber('1234');    // '1,234'
formatNumber('-1234.5'); // '-1,234.5'