Skip to content
This repository has been archived by the owner on Jul 31, 2023. It is now read-only.

tc39/proposal-intl-displaynames-v2

Repository files navigation

Proposal: Intl.DisplayNames V2

Stage

Stage 3

Champion

  • Frank Tang @FrankYFTang

Reviwers

  • Shane Carr @sffc
  • Ujjwal Sharma @ryzokuken

Editors

  • Richard Gibson @gibson042

Motivation

Main motivation for Intl.DisplayNames project was to enable developers to get translation of language, region or script display names on the client. Translation of languages, regions or script display names requires large amount of data to transmit on the network, which is already available in most browsers. These display name translations also carry steep data size penalty for developers. This API will allow web developers to shrink the size of their HTML and/ or ECMA script code without the need to include the human readable form of display names and therefore reduce the download size to decrease latency. Also, this API will reduce the localization cost for the web developers. Our goal is to expose this data through Intl API for use in e.g. language, region and script pickers, etc.

In Intl.DisplayNames API, we already cover language, region, script, and currency. This proposal enhance the Intl.DisplayNames API and cover more.

Please also see prior work of the first version of Intl.DisplayNames on the Intl.DisplayNames repo

Scoped Enhancements

  • Date Time Field
  • Calendar Names
  • Language Display : standard vs dialect

Changes of scope

  • During 2021-01 ECMA402 meeting, we decided not to include Weekday, Month, TimeZone, and Numbering System.
  • During 2021-03-11 ECMA402 meeting, we decided to add back dateTimeField.
  • During 2021-04-08 ECMA402 meeting, we agree the name of the dialectHandling and proceed to TC39 for Stage 3. Shane and Ujjwal agreed to be Stage 3 reviewers.
  • During 2021-05-06 ECMA402 meeting, we agree to drop the "unit" support and rename dialectHandling to languageDisplay.

Examples

Calender Names

d8> dn = new Intl.DisplayNames("en", {type: "calendar"})
d8> dn.of("roc")
"Minguo Calendar"
d8> dn.of("persian")
"Persian Calendar"
d8> dn.of("gregory")
"Gregorian Calendar"
d8> dn.of("ethioaa")
"Ethiopic Amete Alem Calendar"
d8> dn.of("japanese")
"Japanese Calendar"
d8> dn.of("dangi")
"Dangi Calendar"
d8> dn.of("chinese")
"Chinese Calendar"


d8>  dn = new Intl.DisplayNames("zh", {type: "calendar"})
d8> dn.of("roc")
"民国纪年"
d8> dn.of("persian")
"波斯历"
d8> dn.of("gregory")
"公历"
d8> dn.of("ethioaa")
"埃塞俄比亚阿米特阿莱姆日历"
d8> dn.of("japanese")
"和历"
d8> dn.of("dangi")
"檀纪历"
8> dn.of("chinese")
"农历"

Date Time Field Names

$ out/x64.release/d8 --harmony_intl_displaynames_v2
d8> dn = new Intl.DisplayNames("zh", {type: "dateTimeField"})
[object Intl.DisplayNames]
d8> dn.of("era")
"纪元"
d8> dn.of("year")
"年"
d8> dn.of("month")
"月"
d8> dn.of("quarter")
"季度"
d8> dn.of("weekOfYear")
"周"
d8> dn.of("weekday")
"工作日"
d8> dn.of("dayPeriod")
"上午/下午"
d8> dn.of("day")
"日"
d8> dn.of("hour")
"小时"
d8> dn.of("minute")
"分钟"
d8> dn.of("second")
"秒"

d8> dn = new Intl.DisplayNames("es", {type: "dateTimeField"})
[object Intl.DisplayNames]
d8> dn.of("era")
"era"
d8> dn.of("year")
"año"
d8> dn.of("month")
"mes"
d8> dn.of("quarter")
"trimestre"
d8> dn.of("weekOfYear")
"semana"
d8> dn.of("weekday")
"día de la semana"
d8> dn.of("dayPeriod")
"a. m./p. m."
d8> dn.of("day")
"día"
d8> dn.of("hour")
"hora"
d8> dn.of("minute")
"minuto"
d8> dn.of("second")
"segundo"

Language Display

~/v8/v8$ out/x64.release/d8 --harmony_intl_displaynames_v2
V8 version 9.1.0 (candidate)
d8> dn1 = new Intl.DisplayNames("en", {type: "language"})                  
[object Intl.DisplayNames]
d8> dn1.of("en")
"English"
d8> dn1.of("en-GB")
"British English"
d8> dn1.of("en-US")
"American English"
d8> dn1.of("en-AU")
"Australian English"
d8> dn1.of("en-CA")
"Canadian English"
d8> dn1.of("zh")
"Chinese"
d8> dn1.of("zh-Hant")
"Traditional Chinese"
d8> dn1.of("zh-Hans")
"Simplified Chinese"

// Same as above
d8> dn2 = new Intl.DisplayNames("en", {type: "language", languageDisplay: "dialect"})
[object Intl.DisplayNames]
d8> dn2.of("en")
"English"
d8> dn2.of("en-GB")
"British English"
d8> dn2.of("en-US")
"American English"
d8> dn2.of("en-AU")
"Australian English"
d8> dn2.of("en-CA")
"Canadian English"
d8> dn2.of("zh")
"Chinese"
d8> dn2.of("zh-Hant")
"Traditional Chinese"
d8> dn2.of("zh-Hans")
"Simplified Chinese"

// Now switch to standard name
d8> dn3 = new Intl.DisplayNames("en", {type: "language", languageDisplay: "standard"})
[object Intl.DisplayNames]
d8> dn3.of("en")
"English"
d8> dn3.of("en-GB")
"English (United Kingdom)"
d8> dn3.of("en-AU")
"English (Australia)"
d8> dn3.of("en-CA")
"English (Canada)"
d8> dn3.of("en-US")
"English (United States)"
d8> dn3.of("zh")
"Chinese"
d8> dn3.of("zh-Hant")
"Chinese (Traditional)"
d8> dn3.of("zh-Hans")
"Chinese (Simplified)"

Discussed Scopes during Stage 1

Discussed Scopes during Stage 2

  • 2021-03-11: Add back dateTimeField
  • 2021-05-06: Remove unit

Entrance Criteria For Stage 3

  • All Stage 2 Criterias
  • Complete spec text
  • Designated reviewers have signed off on the current spec text
  • All ECMAScript editors have signed off on the current spec text

Entrance Criteria For Stage 2

  • All Stage 1 Criterias
  • Initial spec text

Entrance Criteria For Stage 1

  • Identified “champion” who will advance the addition: DONE- @FrankYFTang
  • Prose outlining the problem or need and the general shape of a solution
  • Illustrative examples of usage
  • High-level API
  • Discussion of key algorithms, abstractions and semantics
  • Identification of potential “cross-cutting” concerns and implementation challenges/complexity
  • A publicly available repository for the proposal that captures the above requirements: DONE https://github.com/tc39/intl-displaynames-v2

Experimentals