U leest de Engelstalige versie van deze inhoud, omdat er nog geen vertaling voor deze taal beschikbaar is. Help ons dit artikel te vertalen!
The Intl.NumberFormat
object is a constructor for objects that enable language sensitive number formatting.
The source for this interactive example is stored in a GitHub repository. If you'd like to contribute to the interactive examples project, please clone https://github.com/mdn/interactive-examples and send us a pull request.
Syntax
new Intl.NumberFormat([locales[, options]]) Intl.NumberFormat.call(this[, locales[, options]])
Parameters
locales
Optional-
A string with a BCP 47 language tag, or an array of such strings. For the general form and interpretation of the
locales
argument, see the Intl page. The following Unicode extension key is allowed:nu
- The numbering system to be used. Possible values include:
"arab"
,"arabext"
,"bali"
,"beng"
,"deva"
,"fullwide"
,"gujr"
,"guru"
,"hanidec"
,"khmr"
,"knda"
,"laoo"
,"latn"
,"limb"
,"mlym"
,"mong"
,"mymr"
,"orya"
,"tamldec"
,"telu"
,"thai"
,"tibt"
.
options
Optional-
An object with some or all of the following properties:
localeMatcher
- The locale matching algorithm to use. Possible values are
"lookup"
and"best fit"
; the default is"best fit"
. For information about this option, see the Intl page. style
- The formatting style to use , the default is
"decimal"
.- "
decimal
" for plain number formatting. - "
currency
" for currency formatting. - "
percent
" for percent formatting - "
unit
" for unit formatting
- "
numberingSystem
- Numbering System. Possible values include: "
arab
", "arabext
", "bali
", "beng
", "deva
", "fullwide
", "gujr
", "guru
", "hanidec
", "khmr
", "knda
", "laoo
", "latn
", "limb
", "mlym
", "mong
", "mymr
", "orya
", "tamldec
", "telu
", "thai
", "tibt
". unit
- The unit to use in
unit
formatting, Possible values are core unit identifiers, defined in UTS #35, Part 2, Section 6. A subset of units from the full list was selected for use in ECMAScript. Pairs of simple units can be concatenated with"-per-"
to make a compound unit. There is no default value; if thestyle
is"unit"
, theunit
property must be provided. unitDisplay
- The unit formatting style to use in
unit
formatting, the defaults is "short
".- "
long
" (e.g.,16 litres
) - "
short
" (e.g.,16 l
) - "
narrow
" (e.g.,16l
)
- "
currency
- The currency to use in currency formatting. Possible values are the ISO 4217 currency codes, such as
"USD"
for the US dollar,"EUR"
for the euro, or"CNY"
for the Chinese RMB — see the Current currency & funds code list. There is no default value; if thestyle
is"currency"
, thecurrency
property must be provided. currencyDisplay
- How to display the currency in currency formatting. Possible values are
"symbol"
to use a localized currency symbol such as €,"code"
to use the ISO currency code,"name"
to use a localized currency name such as"dollar"
; the default is"symbol"
. useGrouping
- Whether to use grouping separators, such as thousands separators or thousand/lakh/crore separators. Possible values are
true
andfalse
; the default istrue
.
The following properties fall into two groups:
minimumIntegerDigits
,minimumFractionDigits
, andmaximumFractionDigits
in one group,minimumSignificantDigits
andmaximumSignificantDigits
in the other. If at least one property from the second group is defined, then the first group is ignored.minimumIntegerDigits
- The minimum number of integer digits to use. Possible values are from 1 to 21; the default is 1.
minimumFractionDigits
- The minimum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number and percent formatting is 0; the default for currency formatting is the number of minor unit digits provided by the ISO 4217 currency code list (2 if the list doesn't provide that information).
maximumFractionDigits
- The maximum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number formatting is the larger of
minimumFractionDigits
and 3; the default for currency formatting is the larger ofminimumFractionDigits
and the number of minor unit digits provided by the ISO 4217 currency code list (2 if the list doesn't provide that information); the default for percent formatting is the larger ofminimumFractionDigits
and 0. minimumSignificantDigits
- The minimum number of significant digits to use. Possible values are from 1 to 21; the default is 1.
maximumSignificantDigits
- The maximum number of significant digits to use. Possible values are from 1 to 21; the default is 21.
notation
- The formatting that should be displayed for the number, the defaults is "
standard
"- "
standard
" plain number formatting - "
scientific
" return the order-of-magnitude for formatted number. - "
engineering
" return the exponent of ten when divisible by three - "
compact
" string representing exponent, defaults is using the "short" form- "
compactDisplay
" used only whennotation
is "compact", takes either "short" (default) or "long"
- "
- "
Description
Properties
Intl.NumberFormat.prototype
- Allows the addition of properties to all objects.
Methods
Intl.NumberFormat.supportedLocalesOf()
- Returns an array containing those of the provided locales that are supported without having to fall back to the runtime's default locale.
NumberFormat
instances
Properties
NumberFormat
instances inherit the following properties from their prototype:
Intl.NumberFormat.prototype.constructor
- A reference to
Intl.NumberFormat
.
Methods
NumberFormat
instances inherit the following methods from their prototype:
Intl.NumberFormat.prototype.format()
- Getter function that formats a number according to the locale and formatting options of this
NumberFormat
object.
Intl.NumberFormat.prototype.formatToParts()
- Returns an
Array
of objects representing the number string in parts that can be used for custom locale-aware formatting. Intl.NumberFormat.prototype.resolvedOptions()
- Returns a new object with properties reflecting the locale and collation options computed during initialization of the object.
Examples
Basic usage
In basic use without specifying a locale, a formatted string in the default locale and with default options is returned.
var number = 3500; console.log(new Intl.NumberFormat().format(number)); // → '3,500' if in US English locale
Using locales
This example shows some of the variations in localized number formats. In order to get the format of the language used in the user interface of your application, make sure to specify that language (and possibly some fallback languages) using the locales
argument:
var number = 123456.789; // German uses comma as decimal separator and period for thousands console.log(new Intl.NumberFormat('de-DE').format(number)); // → 123.456,789 // Arabic in most Arabic speaking countries uses real Arabic digits console.log(new Intl.NumberFormat('ar-EG').format(number)); // → ١٢٣٤٥٦٫٧٨٩ // India uses thousands/lakh/crore separators console.log(new Intl.NumberFormat('en-IN').format(number)); // → 1,23,456.789 // the nu extension key requests a numbering system, e.g. Chinese decimal console.log(new Intl.NumberFormat('zh-Hans-CN-u-nu-hanidec').format(number)); // → 一二三,四五六.七八九 // when requesting a language that may not be supported, such as // Balinese, include a fallback language, in this case Indonesian console.log(new Intl.NumberFormat(['ban', 'id']).format(number)); // → 123.456,789
Using options
The results can be customized using the options
argument:
var number = 123456.789; // request a currency format console.log(new Intl.NumberFormat('de-DE', { style: 'currency', currency: 'EUR' }).format(number)); // → 123.456,79 € // the Japanese yen doesn't use a minor unit console.log(new Intl.NumberFormat('ja-JP', { style: 'currency', currency: 'JPY' }).format(number)); // → ¥123,457 // limit to three significant digits console.log(new Intl.NumberFormat('en-IN', { maximumSignificantDigits: 3 }).format(number)); // → 1,23,000
Using style
and unit
console.log(new Intl.NumberFormat("pt-PT", { style: 'unit', unit: "mile-per-hour" }).format(50)); // → 50 mi/h console.log((16).toLocaleString('en-GB', { style: "unit", unit: "liter", unitDisplay: "long" })); // → 16 litres
Using notation
console.log(new Intl.NumberFormat('en-US', { notation: "scientific" }).format(987654321)); // → 9.877E8 console.log(new Intl.NumberFormat('pt-PT', { notation: "scientific" }).format(987654321)); // → 9,877E8 console.log(new Intl.NumberFormat('en-GB', { notation: "engineering" }).format(987654321)); // → 987.654E6 console.log(new Intl.NumberFormat('de', { notation: "engineering" }).format(987654321)); // → 987,654E6 console.log(new Intl.NumberFormat('zh-CN', { notation: "compact" }).format(987654321)); // → 9.9亿 console.log(new Intl.NumberFormat('fr', { notation: "compact" , compactDisplay: "long" }).format(987654321)); // → 988 millions console.log(new Intl.NumberFormat('en-GB', { notation: "compact" , compactDisplay: "short" }).format(987654321)); // → 988M
Specifications
Browser compatibility
Desktop | Mobile | Server | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NumberFormat | Chrome Full support 24 | Edge Full support 12 | Firefox Full support 29 | IE Full support 11 | Opera Full support 15 | Safari Full support 10 | WebView Android Full support Yes | Chrome Android Full support 26 | Firefox Android Full support 56 | Opera Android Full support 14 | Safari iOS Full support 10 | Samsung Internet Android Full support 1.5 | nodejs ? |
format | Chrome Full support 24 | Edge Full support 12 | Firefox Full support 29 | IE Full support 11 | Opera Full support 15 | Safari Full support 10 | WebView Android Full support Yes | Chrome Android Full support 26 | Firefox Android Full support 56 | Opera Android ? | Safari iOS Full support 10 | Samsung Internet Android Full support 1.5 | nodejs ? |
formatToParts | Chrome Full support 64 | Edge Full support 12 | Firefox Full support 58 | IE Full support 11 | Opera Full support 51 | Safari ? | WebView Android Full support 64 | Chrome Android Full support 64 | Firefox Android Full support 58 | Opera Android ? | Safari iOS ? | Samsung Internet Android Full support 9.0 | nodejs ? |
prototype | Chrome Full support 24 | Edge Full support 12 | Firefox Full support 29 | IE Full support 11 | Opera Full support 15 | Safari Full support 10 | WebView Android Full support Yes | Chrome Android Full support 26 | Firefox Android Full support 56 | Opera Android ? | Safari iOS Full support 10 | Samsung Internet Android Full support 1.5 | nodejs ? |
resolvedOptions | Chrome Full support 24 | Edge Full support 12 | Firefox Full support 29 | IE Full support 11 | Opera Full support 15 | Safari Full support 10 | WebView Android Full support Yes | Chrome Android Full support 26 | Firefox Android Full support 56 | Opera Android ? | Safari iOS Full support 10 | Samsung Internet Android Full support 1.5 | nodejs ? |
supportedLocalesOf | Chrome Full support 24 | Edge Full support 12 | Firefox Full support 29 | IE Full support 11 | Opera Full support 15 | Safari Full support 10 | WebView Android Full support Yes | Chrome Android Full support 26 | Firefox Android Full support 56 | Opera Android ? | Safari iOS Full support 10 | Samsung Internet Android Full support 1.5 | nodejs ? |
Legend
- Full support
- Full support
- Compatibility unknown
- Compatibility unknown
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.
See also
- Introduction: The ECMAScript Internationalization API
- Constructors
- Methods