NumberFormat.percent constructor

NumberFormat.percent({
  1. Locale? locale,
  2. SignDisplay signDisplay = SignDisplay.auto,
  3. Notation notation = const StandardNotation(),
  4. Grouping useGrouping = Grouping.auto,
  5. NumberingSystem? numberingSystem,
  6. RoundingMode roundingMode = RoundingMode.halfExpand,
  7. TrailingZeroDisplay trailingZeroDisplay = TrailingZeroDisplay.auto,
  8. int minimumIntegerDigits = 1,
  9. Digits? digits,
})

Creates a NumberFormat instance for percent formatting.

WARNING: Not implemented on native yet.

  • locale: The locale to use for formatting. Defaults to the system locale.
  • signDisplay: When to display the sign for the number. Defaults to SignDisplay.auto.
  • notation: The notation system to use. Defaults to StandardNotation.
  • useGrouping: Whether to use grouping separators. Defaults to Grouping.auto.
  • numberingSystem: The numbering system to use (e.g., 'latn', 'arab').
  • roundingMode: The rounding strategy to use. Defaults to RoundingMode.halfExpand.
  • trailingZeroDisplay: When to display trailing zeros. Defaults to TrailingZeroDisplay.auto.
  • minimumIntegerDigits: The minimum number of integer digits to use. Defaults to 1.
  • digits: Specifies the minimum and maximum number of fraction or significant digits.

Example:

import 'package:intl4x/number_format.dart';

void main() {
  print(NumberFormat.percent().format(0.5)); // Prints '50%'
}

Implementation

//TODO: Implement in ICU4X
NumberFormat.percent({
  Locale? locale,
  SignDisplay signDisplay = SignDisplay.auto,
  Notation notation = const StandardNotation(),
  Grouping useGrouping = Grouping.auto,
  NumberingSystem? numberingSystem,
  RoundingMode roundingMode = RoundingMode.halfExpand,
  TrailingZeroDisplay trailingZeroDisplay = TrailingZeroDisplay.auto,
  int minimumIntegerDigits = 1,
  Digits? digits,
}) : _impl = NumberFormatImpl.build(
       locale ?? findSystemLocale(),
       NumberFormatOptions.percent(
         digits: digits,
         minimumIntegerDigits: minimumIntegerDigits,
         numberingSystem: numberingSystem,
         roundingMode: roundingMode,
         signDisplay: signDisplay,
         trailingZeroDisplay: trailingZeroDisplay,
         useGrouping: useGrouping,
         notation: notation,
       ),
     );