Intl.Collator object is a constructor for collators, objects that enable language sensitive string comparison.

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.

句法

new Intl.Collator([locales[, options]])
					

参数

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 keys are allowed:

co
Variant collations for certain locales. Possible values include: "big5han" , "dict" , "direct" , "ducet" , "gb2312" , "phonebk" , "phonetic" , "pinyin" , "reformed" , "searchjl" , "stroke" , "trad" , "unihan" "standard" and "search" values are ignored; they are replaced by the options property usage (see below).
kn
Whether numeric collation should be used, such that "1" < "2" < "10". Possible values are "true" and "false" . This option can be set through an options property or through a Unicode extension key; if both are provided, the options property takes precedence.
kf
Whether upper case or lower case should sort first. Possible values are "upper" , "lower" ,或 "false" (use the locale's default). This option can be set through an options property or through a Unicode extension key; if both are provided, the options property takes precedence.
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 .
usage
Whether the comparison is for sorting or for searching for matching strings. Possible values are "sort" and "search" ; the default is "sort" .
sensitivity

Which differences in the strings should lead to non-zero result values. Possible values are:

  • "base" : Only strings that differ in base letters compare as unequal. Examples: a ≠ b , a = á , a = A .
  • "accent" : Only strings that differ in base letters or accents and other diacritic marks compare as unequal. Examples: a ≠ b , a ≠ á , a = A .
  • "case" : Only strings that differ in base letters or case compare as unequal. Examples: a ≠ b , a = á , a ≠ A .
  • "variant" : Strings that differ in base letters, accents and other diacritic marks, or case compare as unequal. Other differences may also be taken into consideration. Examples: a ≠ b , a ≠ á , a ≠ A .

默认为 "variant" for usage "sort" ; it's locale dependent for usage "search" .

ignorePunctuation
Whether punctuation should be ignored. Possible values are true and false ; the default is false .
numeric
Whether numeric collation should be used, such that "1" < "2" < "10". Possible values are true and false ; the default is false . This option can be set through an options property or through a Unicode extension key; if both are provided, the options property takes precedence. Implementations are not required to support this property.
caseFirst
Whether upper case or lower case should sort first. Possible values are "upper" , "lower" ,或 "false" (use the locale's default); the default is "false" . This option can be set through an options property or through a Unicode extension key; if both are provided, the options property takes precedence. Implementations are not required to support this property.

范例

使用 Collator

The following example demonstrates the different potential results for a string occurring before, after, or at the same level as another:

console.log(new Intl.Collator().compare('a', 'c')); // → a negative value
console.log(new Intl.Collator().compare('c', 'a')); // → a positive value
console.log(new Intl.Collator().compare('a', 'a')); // → 0
					

Note that the results shown in the code above can vary between browsers and browser versions. This is because the values are implementation-specific. That is, the specification requires only that the before and after values are negative and positive.

规范

规范
ECMAScript 国际化 API (ECMA-402)
The definition of 'Intl.Collator constructor' in that specification.

浏览器兼容性

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. 更新 GitHub 上的兼容性数据
Desktop Mobile Server
Chrome Edge Firefox Internet Explorer Opera Safari Android webview Chrome for Android Firefox for Android Opera for Android Safari on iOS Samsung Internet Node.js
Collator() 构造函数 Chrome 24 Edge 12 Firefox 29 IE 11 Opera 15 Safari 10 WebView Android 4.4 Chrome Android 25 Firefox Android 56 Opera Android 14 Safari iOS 10 Samsung Internet Android 1.5 nodejs 13.0.0
13.0.0
部分支持 0.12
Before version 13.0.0, only the locale data for en-US is available by default. When other locales are specified, the Collator instance silently falls back to en-US . To make full ICU (locale) data available for versions prior to 13, see Node.js documentation on the --with-intl option and how to provide the data.
caseFirst option Chrome 24 Edge 18 Firefox 55 IE No Opera 15 Safari 11 WebView Android 4.4 Chrome Android 25 Firefox Android 56 Opera Android 14 Safari iOS 11 Samsung Internet Android 1.5 nodejs 0.12

图例

完整支持

完整支持

不支持

不支持

见实现注意事项。

另请参阅

元数据

  • 最后修改: