num - Formatting & Currency

Functional utilities for complex list mapping, efficient sorting by property (selector), chunking for pagination, and creating shuffled copies.

1. 💰 Currency Formatting

   toCurrency() · String

   Show Parameters

   decimalPlaces · int · default: "2"

   The number of digits to display after the decimal point.

   currencySymbol · String? · default: "'KES'"

   The symbol to use (e.g., ‘KES’, ’$’). Set to null to display no symbol.

   currencyDirection · CurrencyDirection · default: "CurrencyDirection.left"

   Placement of the currency symbol (left or right).

   thousandsSeparator · String · default: "','"

   The character used to separate thousands.

   decimalSeparator · String · default: "'.'"

   The character used to separate the whole number from the decimals.

   Converts the number to a given currency format, correctly handling thousand separators, decimal places, and symbol placement.

   final euroAmount = 9876.5;
   print(euroAmount.toCurrency(
     currencySymbol: '€',
     thousandsSeparator: '.',
     decimalSeparator: ',',
     currencyDirection: CurrencyDirection.right,
   ));
   // 9.876,50 €
   
2. 📊 Abbreviation

   toAbbreviated() · String

   Show Parameters

   decimalCount · int · default: "1"

   The number of decimal places to include.

   isLowercase · bool · default: "false"

   If true, uses lowercase suffixes (b, m, k).

   currencySymbol · String?

   An optional symbol to prefix/suffix the result.

   currencyDirection · CurrencyDirection · default: "CurrencyDirection.left"

   Placement of the currency symbol (left or right).

   Abbreviates the number to a concise format (e.g., 1.1B, 2.0K). Used for displaying large counts cleanly in UIs.

   print(1000000000.toAbbreviated(currencySymbol: 'USD')); // USD 1.0B