The Intl.ListFormat()
constructor creates objects that enable language-sensitive list 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.ListFormat([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. 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 theIntl
page.type
The format of output message. Possible values are"conjunction"
that stands for "and"-based lists (default, e.g.,A, B, and C
), or"disjunction"
that stands for "or"-based lists (e.g.,A, B, or C
)."unit"
stands for lists of values with units (e.g.,5 pounds, 12 ounces
).style
The length of the formated message. Possible values are:"long"
(default, e.g.,A, B, and C
);"short"
(e.g.,A, B, C
), or"narrow"
(e.g.,A B C
). Whenstyle
isshort
ornarrow
,unit
is the only allowed value for the type option.
Examples
Using format
The following example shows how to create a List formatter using the English language.
const list = ['Motorcycle', 'Bus', 'Car']; console.log(new Intl.ListFormat('en-GB', { style: 'long', type: 'conjunction' }).format(list)); // > Motorcycle, Bus and Car console.log(new Intl.ListFormat('en-GB', { style: 'short', type: 'disjunction' }).format(list)); // > Motorcycle, Bus or Car console.log(new Intl.ListFormat('en-GB', { style: 'narrow', type: 'unit' }).format(list)); // > Motorcycle Bus Car
Specifications
Specification |
---|
Intl.ListFormat The definition of 'ListFormat()' in that specification. |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | Server | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ListFormat() constructor | Chrome Full support 72 | Edge No support No | Firefox Full support 78 | IE No support No | Opera Full support 60 | Safari No support No | WebView Android Full support 72 | Chrome Android Full support 72 | Firefox Android No support No | Opera Android Full support 51 | Safari iOS No support No | Samsung Internet Android No support No | nodejs
Full support
13.0.0
|
Legend
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.
- See implementation notes.
- See implementation notes.