@activecollab/components 2.0.114 → 2.0.116

package/dist/index.js

@@ -603,12 +603,33 @@
       return parseFloat(String(number).replaceAll(thousandSeparator, ""));
     }
   };
+
+  /**
+   * @function formatNumber
+   * @description
+   * Formats a number or string into a human-readable format with options for thousand separators,
+   * decimal precision, and shortening the number using suffixes (K, M, B, T).
+   * It can handle negative numbers and optionally trim decimals and set number of decimal places based on the configuration.
+   *
+   * @param {string | number} n - The number or string to be formatted.
+   * @param {"," | "." | " " | ""} [thousandSeparator=","] - The character to use as a thousand separator.
+   * @param {"," | "."} [decimalSeperator="."] - The character to use as a decimal separator.
+   * @param {boolean} [trimDecimals=true] - Whether to trim decimals to the specified number of decimal spaces.
+   * @param {number} [decimalSpaces=2] - The number of decimal spaces to keep in the formatted output.
+   * @param {"long" | "short"} [format="long"] - The format type, either "long" for full numbers or "short" for shortened numbers with suffixes.
+   *
+   * @returns {string} - The formatted number as a string with separators and potentially with decimals.
+   *
+   * @example
+   * formatNumber(1500) // "1,500.00"
+   * formatNumber(1500000, ",", ".", true, 2, "short") // "1.5M"
+   */
   var formatNumber = function formatNumber(n) {
     var thousandSeparator = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : ",";
     var decimalSeperator = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : ".";
     var trimDecimals = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : true;
     var decimalSpaces = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : 2;
-    var format = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : "short";
+    var format = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : "long";
     var number = getNumberFromString(n, thousandSeparator, decimalSeperator);
     if (isNaN(number)) {
       return "";
@@ -641,6 +662,43 @@
     return parts.join(decimalSeparator);
   };
 
+  /**
+   * @function formatCurrency
+   * @description
+   * Formats a number or string as a currency string with options for thousand separators,
+   * decimal precision, currency code, currency code position, and the use of suffixes (K, M, B, T) if needed.
+   * It can handle negative values and supports customization of the currency code and its position.
+   *
+   * @param {string | number} n - The number or string to be formatted as currency.
+   * @param {"," | "." | " " | ""} [thousandSeparator=","] - The character to use as a thousand separator.
+   * @param {"," | "."} [decimalSeperator="."] - The character to use as a decimal separator.
+   * @param {boolean} [trimDecimals=false] - Whether to trim decimals to the specified number of decimal spaces.
+   * @param {number} [decimalSpaces=2] - The number of decimal spaces to keep in the formatted output.
+   * @param {"long" | "short"} [format="long"] - The format type, either "long" for full numbers or "short" for shortened numbers with suffixes.
+   * @param {string} [currencyCode=""] - The currency code to append or prepend to the formatted number.
+   * @param {"right" | "left"} [currencyCodePosition="right"] - The position of the currency code relative to the formatted number.
+   *
+   * @returns {string} - The formatted currency string, including the currency code if provided.
+   *
+   * @example
+   * formatCurrency(1500, ",", ".", false, 2, "long", "USD", "right") // "1,500.00 USD"
+   * formatCurrency(1500000, ",", ".", true, 2, "short", "JPY", "left") // "JPY 1.5M"
+   */
+  var formatCurrency = function formatCurrency(n) {
+    var thousandSeparator = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : ",";
+    var decimalSeperator = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : ".";
+    var trimDecimals = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
+    var decimalSpaces = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : 2;
+    var format = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : "long";
+    var currencyCode = arguments.length > 6 && arguments[6] !== undefined ? arguments[6] : "";
+    var currencyCodePosition = arguments.length > 7 && arguments[7] !== undefined ? arguments[7] : "right";
+    var formattedNum = formatNumber(n, thousandSeparator, decimalSeperator, trimDecimals, decimalSpaces, format);
+    if (!currencyCode) {
+      return formattedNum;
+    }
+    return currencyCodePosition === "right" ? "".concat(formattedNum, " ").concat(currencyCode) : "".concat(currencyCode, " ").concat(formattedNum);
+  };
+
   var validateStopwatchTime = function validateStopwatchTime(value) {
     return /^([0-9]{0,2})?(((:([0-5][0-9])?)|(:[0-5]?))|(\.[0-9]{0,2})|(,[0-9]{0,2}))?$/g.test(value);
   };
@@ -12164,8 +12222,8 @@
       if (value !== prevValue) {
         setCurrentValue(formatNumber(value, thousandSeparator, decimalSeparator, trimDecimals, decimalLength, disableAbbreviation ? "long" : "short"));
         setPrevValue(formatNumber(value, thousandSeparator, decimalSeparator, trimDecimals, decimalLength, disableAbbreviation ? "long" : "short"));
-        setUnformattedValue(formatNumber(value, "", decimalSeparator, false, decimalLength, "long"));
-        setUnformattedPrevValue(formatNumber(value, "", decimalSeparator, false, decimalLength, "long"));
+        setUnformattedValue(formatNumber(value, "", decimalSeparator, trimDecimals, decimalLength, "long"));
+        setUnformattedPrevValue(formatNumber(value, "", decimalSeparator, trimDecimals, decimalLength, "long"));
       }
       // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [disableAbbreviation, thousandSeparator, decimalSeparator, decimalLength, trimDecimals, value]);
@@ -19904,6 +19962,7 @@
   exports._List = _List;
   exports.colors = colors$1;
   exports.decimalToHours = decimalToHours;
+  exports.formatCurrency = formatCurrency;
   exports.formatNumber = formatNumber;
   exports.getNumberFromString = getNumberFromString;
   exports.isOptionGroup = isOptionGroup;