國(guó)際化-Intl

導(dǎo)入模塊

import Intl from '@ohos.intl';

未正確導(dǎo)入包可能產(chǎn)生不明確的接口行為。

Locale

屬性

系統(tǒng)能力：SystemCapability.Global.I18n

constructor8+

constructor()

創(chuàng)建區(qū)域?qū)ο?/p>

系統(tǒng)能力：SystemCapability.Global.I18n

示例：

// 默認(rèn)構(gòu)造函數(shù)使用系統(tǒng)當(dāng)前l(fā)ocale創(chuàng)建Locale對(duì)象
let locale = new Intl.Locale();
// 返回系統(tǒng)當(dāng)前l(fā)ocale
let localeID = locale.toString();

constructor

constructor(locale: string, options?: LocaleOptions)

創(chuàng)建區(qū)域?qū)ο?/p>

系統(tǒng)能力：SystemCapability.Global.I18n

參數(shù)：

示例：

// 創(chuàng)建 "zh-CN" Locale對(duì)象
let locale = new Intl.Locale("zh-CN");
let localeID = locale.toString(); // localeID = "zh-CN"

toString

toString(): string

獲取區(qū)域?qū)ο蟮淖址硎?/p>

系統(tǒng)能力：SystemCapability.Global.I18n

返回值：

示例：

// 創(chuàng)建 "en-GB" Locale對(duì)象
let locale = new Intl.Locale("en-GB");
let localeID = locale.toString(); // localeID = "en-GB"

maximize

maximize(): Locale

最大化區(qū)域信息，若缺少腳本與地區(qū)信息，則補(bǔ)齊。

系統(tǒng)能力：SystemCapability.Global.I18n

返回值：

示例：

// 創(chuàng)建 "zh" Locale對(duì)象
let locale = new Intl.Locale("zh");
// 補(bǔ)齊Locale對(duì)象的腳本和地區(qū)
let maximizedLocale = locale.maximize();
let localeID = maximizedLocale.toString(); // localeID = "zh-Hans-CN"

// 創(chuàng)建 "en-US" Locale對(duì)象
locale = new Intl.Locale("en-US");
// 補(bǔ)齊Locale對(duì)象的腳本
maximizedLocale = locale.maximize();
localeID = maximizedLocale.toString(); // localeID = "en-Latn-US"

minimize

minimize(): Locale

最小化區(qū)域信息，若包含腳本與地區(qū)信息，則去除。

系統(tǒng)能力：SystemCapability.Global.I18n

返回值：

示例：

// 創(chuàng)建 "zh-Hans-CN" Locale對(duì)象
let locale = new Intl.Locale("zh-Hans-CN");
// 去除Locale對(duì)象的腳本和地區(qū)
let minimizedLocale = locale.minimize();
let localeID = minimizedLocale.toString(); // localeID = "zh"

// 創(chuàng)建 "en-US" Locale對(duì)象
locale = new Intl.Locale("en-US");
// 去除Locale對(duì)象的地區(qū)
minimizedLocale = locale.minimize();
localeID = minimizedLocale.toString(); // localeID = "en"

LocaleOptions9+

表示區(qū)域初始化選項(xiàng)。

系統(tǒng)能力：SystemCapability.Global.I18n

DateTimeFormat

constructor8+

constructor()

創(chuàng)建時(shí)間日期格式化對(duì)象。

系統(tǒng)能力：SystemCapability.Global.I18n

示例：

// 使用系統(tǒng)當(dāng)前l(fā)ocale創(chuàng)建DateTimeFormat對(duì)象
let datefmt= new Intl.DateTimeFormat();

constructor

constructor(locale: string | Array<string>, options?: DateTimeOptions)

創(chuàng)建時(shí)間日期格式化對(duì)象。

系統(tǒng)能力：SystemCapability.Global.I18n

參數(shù)：

示例：

// 使用 "zh-CN" locale創(chuàng)建DateTimeFormat對(duì)象，日期風(fēng)格為full，時(shí)間風(fēng)格為medium
let datefmt= new Intl.DateTimeFormat("zh-CN", { dateStyle: 'full', timeStyle: 'medium' });

示例：

// 使用 ["ban", "zh"] locale列表創(chuàng)建DateTimeFormat對(duì)象，因?yàn)閎an為非法LocaleID，因此使用zh Locale創(chuàng)建DateTimeFormat對(duì)象
let datefmt= new Intl.DateTimeFormat(["ban", "zh"], { dateStyle: 'full', timeStyle: 'medium' });

format

format(date: Date): string

格式化時(shí)間日期字符串。

系統(tǒng)能力：SystemCapability.Global.I18n

參數(shù)：

返回值：

示例：

let date = new Date(2021, 11, 17, 3, 24, 0);
// 使用 en-GB locale創(chuàng)建DateTimeFormat對(duì)象
let datefmt = new Intl.DateTimeFormat("en-GB");
let formattedDate = datefmt.format(date); // formattedDate "17/12/2021"

// 使用 en-GB locale創(chuàng)建DateTimeFormat對(duì)象，dateStyle設(shè)置為full，timeStyle設(shè)置為medium
datefmt = new Intl.DateTimeFormat("en-GB", { dateStyle: 'full', timeStyle: 'medium' });
formattedDate = datefmt.format(date); // formattedDate "Friday, 17 December 2021 at 03:24:00"

formatRange

formatRange(startDate: Date, endDate: Date): string

格式化時(shí)間日期段字符串。

系統(tǒng)能力：SystemCapability.Global.I18n

參數(shù)：

返回值：

示例：

let startDate = new Date(2021, 11, 17, 3, 24, 0);
let endDate = new Date(2021, 11, 18, 3, 24, 0);
// 使用 en-GB locale創(chuàng)建DateTimeFormat對(duì)象
let datefmt = new Intl.DateTimeFormat("en-GB");
let formattedDateRange = datefmt.formatRange(startDate, endDate); // formattedDateRange = "17/12/2021-18/12/2021"

resolvedOptions

resolvedOptions(): DateTimeOptions

獲取DateTimeFormat對(duì)象的格式化選項(xiàng)。

系統(tǒng)能力：SystemCapability.Global.I18n

返回值：

示例：

let datefmt = new Intl.DateTimeFormat("en-GB", { dateStyle: 'full', timeStyle: 'medium' });
// 返回DateTimeFormat對(duì)象的配置項(xiàng)
let options = datefmt.resolvedOptions();
let dateStyle = options.dateStyle; // dateStyle = "full"
let timeStyle = options.timeStyle; // timeStyle = "medium"

DateTimeOptions9+

表示時(shí)間日期格式化選項(xiàng)。

系統(tǒng)能力：SystemCapability.Global.I18n

NumberFormat

constructor8+

constructor()

創(chuàng)建數(shù)字格式化對(duì)象。

系統(tǒng)能力：SystemCapability.Global.I18n

示例：

// 使用系統(tǒng)當(dāng)前l(fā)ocale創(chuàng)建NumberFormat對(duì)象
let numfmt = new Intl.NumberFormat();

constructor

constructor(locale: string | Array<string>, options?: NumberOptions)

創(chuàng)建數(shù)字格式化對(duì)象。

系統(tǒng)能力：SystemCapability.Global.I18n

參數(shù)：

示例：

// 使用 en-GB locale創(chuàng)建NumberFormat對(duì)象，style設(shè)置為decimal，notation設(shè)置為scientific
let numfmt = new Intl.NumberFormat("en-GB", {style:'decimal', notation:"scientific"});

format

format(number: number): string;

格式化數(shù)字字符串。

系統(tǒng)能力：SystemCapability.Global.I18n

參數(shù)：

返回值：

示例：

// 使用 ["en-GB", "zh"] locale列表創(chuàng)建NumberFormat對(duì)象，因?yàn)閑n-GB為合法LocaleID，因此使用en-GB創(chuàng)建NumberFormat對(duì)象
let numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
let formattedNumber = numfmt.format(1223); // formattedNumber = 1.223E3

resolvedOptions

resolvedOptions(): NumberOptions

獲取NumberFormat 對(duì)象的格式化選項(xiàng)。

系統(tǒng)能力：SystemCapability.Global.I18n

返回值：

示例：

let numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
// 獲取NumberFormat對(duì)象配置項(xiàng)
let options = numfmt.resolvedOptions();
let style = options.style; // style = decimal
let notation = options.notation; // notation = scientific

NumberOptions9+

表示設(shè)備支持的能力。

系統(tǒng)能力：SystemCapability.Global.I18n

Collator8+

constructor8+

constructor()

創(chuàng)建排序?qū)ο蟆?/p>

系統(tǒng)能力：SystemCapability.Global.I18n

示例：

// 使用系統(tǒng)locale創(chuàng)建Collator對(duì)象
let collator = new Intl.Collator();

constructor8+

constructor(locale: string | Array<string>, options?: CollatorOptions)

創(chuàng)建排序?qū)ο蟆?/p>

系統(tǒng)能力：SystemCapability.Global.I18n

參數(shù)：

示例：

// 使用 zh-CN locale創(chuàng)建Collator對(duì)象，localeMatcher設(shè)置為lookup，usage設(shè)置為sort
let collator = new Intl.Collator("zh-CN", {localeMatcher: "lookup", usage: "sort"});

compare8+

compare(first: string, second: string): number

依據(jù)Collator的排序策略對(duì)兩個(gè)字符串進(jìn)行比較。

系統(tǒng)能力：SystemCapability.Global.I18n

參數(shù)：

返回值：

示例：

// 使用en-GB locale創(chuàng)建Collator對(duì)象
let collator = new Intl.Collator("en-GB");
// 比較 "first" 和 "second" 的先后順序
let compareResult = collator.compare("first", "second"); // compareResult = -1

resolvedOptions8+

resolvedOptions(): CollatorOptions

返回Collator對(duì)象的屬性。

系統(tǒng)能力：SystemCapability.Global.I18n

返回值：

示例：

let collator = new Intl.Collator("zh-Hans", { usage: 'sort', ignorePunctuation: true });
// 獲取Collator對(duì)象的配置項(xiàng)
let options = collator.resolvedOptions();
let usage = options.usage; // usage = "sort"
let ignorePunctuation = options.ignorePunctuation; // ignorePunctuation = true

CollatorOptions9+

表示Collator可設(shè)置的屬性。

系統(tǒng)能力：SystemCapability.Global.I18n

PluralRules8+

constructor8+

constructor()

創(chuàng)建單復(fù)數(shù)對(duì)象來計(jì)算數(shù)字的單復(fù)數(shù)類別。

系統(tǒng)能力：SystemCapability.Global.I18n

示例：

// 使用系統(tǒng)locale創(chuàng)建PluralRules對(duì)象
let pluralRules = new Intl.PluralRules();

constructor8+

constructor(locale: string | Array<string>, options?: PluralRulesOptions)

創(chuàng)建單復(fù)數(shù)對(duì)象來計(jì)算數(shù)字的單復(fù)數(shù)類別。

系統(tǒng)能力：SystemCapability.Global.I18n

參數(shù)：

示例：

// 使用 zh-CN locale創(chuàng)建PluralRules對(duì)象，localeMatcher設(shè)置為lookup，type設(shè)置為cardinal
let pluralRules= new Intl.PluralRules("zh-CN", {"localeMatcher": "lookup", "type": "cardinal"});

select8+

select(n: number): string

返回一個(gè)字符串表示該數(shù)字的單復(fù)數(shù)類別。

系統(tǒng)能力：SystemCapability.Global.I18n

參數(shù)：

返回值：

示例：

// 使用 zh-Hans locale創(chuàng)建PluralRules對(duì)象
let zhPluralRules = new Intl.PluralRules("zh-Hans");
// 計(jì)算 zh-Hans locale中數(shù)字1對(duì)應(yīng)的單復(fù)數(shù)類別
let plural = zhPluralRules.select(1); // plural = other

// 使用 en-US locale創(chuàng)建PluralRules對(duì)象
let enPluralRules = new Intl.PluralRules("en-US");
// 計(jì)算 en-US locale中數(shù)字1對(duì)應(yīng)的單復(fù)數(shù)類別
plural = enPluralRules.select(1); // plural = one

PluralRulesOptions9+

表示PluralRules對(duì)象可設(shè)置的屬性。

系統(tǒng)能力：SystemCapability.Global.I18n

RelativeTimeFormat8+

constructor8+

constructor()

創(chuàng)建相對(duì)時(shí)間格式化對(duì)象。

系統(tǒng)能力：SystemCapability.Global.I18n

示例：

// 使用系統(tǒng)locale創(chuàng)建RelativeTimeFormat對(duì)象
let relativetimefmt = new Intl.RelativeTimeFormat();

constructor8+

constructor(locale: string | Array<string>, options?: RelativeTimeFormatInputOptions)

創(chuàng)建相對(duì)時(shí)間格式化對(duì)象。

系統(tǒng)能力：SystemCapability.Global.I18n

參數(shù)：

示例：

// 使用 zh-CN locale創(chuàng)建RelativeTimeFormat對(duì)象，localeMatcher設(shè)置為lookup，numeric設(shè)置為always，style設(shè)置為long
let relativeTimeFormat = new Intl.RelativeTimeFormat("zh-CN", {"localeMatcher": "lookup", "numeric": "always", "style": "long"});

format8+

format(value: number, unit: string): string

依據(jù)locale和格式化選項(xiàng)，對(duì)value和unit進(jìn)行格式化。

系統(tǒng)能力：SystemCapability.Global.I18n

參數(shù)：

返回值：

示例：

// 使用 zh-CN locale創(chuàng)建RelativeTimeFormat對(duì)象
let relativetimefmt = new Intl.RelativeTimeFormat("zh-CN");
// 計(jì)算 zh-CN locale中數(shù)字3，單位quarter的本地化表示
let formatResult = relativetimefmt.format(3, "quarter"); // formatResult = "3個(gè)季度后"

formatToParts8+

formatToParts(value: number, unit: string): Array<object>

返回一個(gè)對(duì)象數(shù)組，表示可用于自定義區(qū)域設(shè)置格式的相對(duì)時(shí)間格式。

系統(tǒng)能力：SystemCapability.Global.I18n

參數(shù)：

返回值：

示例：

// 使用 en locale創(chuàng)建RelativeTimeFormat對(duì)象，numeric設(shè)置為auto
let relativetimefmt = new Intl.RelativeTimeFormat("en", {"numeric": "auto"});
let parts = relativetimefmt.formatToParts(10, "seconds"); // parts = [ {type: "literal", value: "in"}, {type: "integer", value: 10, unit: "second"}, {type: "literal", value: "seconds"} ]

resolvedOptions8+

resolvedOptions(): RelativeTimeFormatResolvedOptions

獲取RelativeTimeFormat對(duì)象的格式化選項(xiàng)。

系統(tǒng)能力：SystemCapability.Global.I18n

返回值：

示例：

// 使用 en-GB locale創(chuàng)建RelativeTimeFormat對(duì)象
let relativetimefmt= new Intl.RelativeTimeFormat("en-GB", { style: "short" });
// 獲取RelativeTimeFormat對(duì)象配置項(xiàng)
let options = relativetimefmt.resolvedOptions();
let style = options.style; // style = "short"

RelativeTimeFormatInputOptions9+

表示RelativeTimeFormat對(duì)象可設(shè)置的屬性。

系統(tǒng)能力：SystemCapability.Global.I18n

RelativeTimeFormatResolvedOptions8+

表示RelativeTimeFormat對(duì)象可設(shè)置的屬性。

系統(tǒng)能力：SystemCapability.Global.I18n