BREAKING CHANGE: Because of multiple bugs and browser inconsistencies, we have dropped the intl api in favor of data exported from the Unicode Common Locale Data Repository (CLDR). Unfortunately we had to change the i18n pipes (date, number, currency, percent) and there are some breaking changes. 1. I18n pipes * Breaking change: - By default Angular now only contains locale data for the language `en-US`, if you set the value of `LOCALE_ID` to another locale, you will have to import new locale data for this language because we don't use the intl API anymore. * Features: - you don't need to use the intl polyfill for Angular anymore. - all i18n pipes now have an additional last parameter `locale` which allows you to use a specific locale instead of the one defined in the token `LOCALE_ID` (whose value is `en-US` by default). - the new locale data extracted from CLDR are now available to developers as well and can be used through an API (which should be especially useful for library authors). - you can still use the old pipes for now, but their names have been changed and they are no longer included in the `CommonModule`. To use them, you will have to import the `DeprecatedI18NPipesModule` after the `CommonModule` (the order is important): ```ts import { NgModule } from '@angular/core'; import { CommonModule, DeprecatedI18NPipesModule } from '@angular/common'; @NgModule({ imports: [ CommonModule, // import deprecated module after DeprecatedI18NPipesModule ] }) export class AppModule { } ``` Dont forget that you will still need to import the intl API polyfill if you want to use those deprecated pipes. 2. Date pipe * Breaking changes: - the predefined formats (`short`, `shortTime`, `shortDate`, `medium`, ...) now use the patterns given by CLDR (like it was in AngularJS) instead of the ones from the intl API. You might notice some changes, e.g. `shortDate` will be `8/15/17` instead of `8/15/2017` for `en-US`. - the narrow version of eras is now `GGGGG` instead of `G`, the format `G` is now similar to `GG` and `GGG`. - the narrow version of months is now `MMMMM` instead of `L`, the format `L` is now the short standalone version of months. - the narrow version of the week day is now `EEEEE` instead of `E`, the format `E` is now similar to `EE` and `EEE`. - the timezone `z` will now fallback to `O` and output `GMT+1` instead of the complete zone name (e.g. `Pacific Standard Time`), this is because the quantity of data required to have all the zone names in all of the existing locales is too big. - the timezone `Z` will now output the ISO8601 basic format, e.g. `+0100`, you should now use `ZZZZ` to get `GMT+01:00`. | Field type | Format | Example value | v4 | v5 | |------------|---------------|-----------------------|----|---------------| | Eras | Narrow | A for AD | G | GGGGG | | Months | Narrow | S for September | L | MMMMM | | Week day | Narrow | M for Monday | E | EEEEE | | Timezone | Long location | Pacific Standard Time | z | Not available | | Timezone | Long GMT | GMT+01:00 | Z | ZZZZ | * Features - new predefined formats `long`, `full`, `longTime`, `fullTime`. - the format `yyy` is now supported, e.g. the year `52` will be `052` and the year `2017` will be `2017`. - standalone months are now supported with the formats `L` to `LLLLL`. - week of the year is now supported with the formats `w` and `ww`, e.g. weeks `5` and `05`. - week of the month is now supported with the format `W`, e.g. week `3`. - fractional seconds are now supported with the format `S` to `SSS`. - day periods for AM/PM now supports additional formats `aa`, `aaa`, `aaaa` and `aaaaa`. The formats `a` to `aaa` are similar, while `aaaa` is the wide version if available (e.g. `ante meridiem` for `am`), or equivalent to `a` otherwise, and `aaaaa` is the narrow version (e.g. `a` for `am`). - extra day periods are now supported with the formats `b` to `bbbbb` (and `B` to `BBBBB` for the standalone equivalents), e.g. `morning`, `noon`, `afternoon`, .... - the short non-localized timezones are now available with the format `O` to `OOOO`. The formats `O` to `OOO` will output `GMT+1` while the format `OOOO` will be `GMT+01:00`. - the ISO8601 basic time zones are now available with the formats `Z` to `ZZZZZ`. The formats `Z` to `ZZZ` will output `+0100`, while the format `ZZZZ` will be `GMT+01:00` and `ZZZZZ` will be `+01:00`. * Bug fixes - the date pipe will now work exactly the same across all browsers, which will fix a lot of bugs for safari and IE. - eras can now be used on their own without the date, e.g. the format `GG` will be `AD` instead of `8 15, 2017 AD`. 3. Currency pipe * Breaking change: - the default value for `symbolDisplay` is now `symbol` instead of `code`. This means that by default you will see `$4.99` for `en-US` instead of `USD4.99` previously. * Deprecation: - the second parameter of the currency pipe (`symbolDisplay`) is no longer a boolean, it now takes the values `code`, `symbol` or `symbol-narrow`. A boolean value is still valid for now, but it is deprecated and it will print a warning message in the console. * Features: - you can now choose between `code`, `symbol` or `symbol-narrow` which gives you access to more options for some currencies (e.g. the canadian dollar with the code `CAD` has the symbol `CA$` and the symbol-narrow `$`). 4. Percent pipe * Breaking change - if you don't specify the number of digits to round to, the local format will be used (and it usually rounds numbers to 0 digits, instead of not rounding previously), e.g. `{{ 3.141592 | percent }}` will output `314%` for the locale `en-US` instead of `314.1592%` previously. Fixes #10809, #9524, #7008, #9324, #7590, #6724, #3429, #17576, #17478, #17319, #17200, #16838, #16624, #16625, #16591, #14131, #12632, #11376, #11187 PR Close #18284
222 lines
8.6 KiB
TypeScript
222 lines
8.6 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google Inc. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
import {NumberFormatStyle} from '../../i18n/locale_data_api';
|
|
|
|
export class NumberFormatter {
|
|
static format(num: number, locale: string, style: NumberFormatStyle, opts: {
|
|
minimumIntegerDigits?: number,
|
|
minimumFractionDigits?: number,
|
|
maximumFractionDigits?: number,
|
|
currency?: string|null,
|
|
currencyAsSymbol?: boolean
|
|
} = {}): string {
|
|
const {minimumIntegerDigits, minimumFractionDigits, maximumFractionDigits, currency,
|
|
currencyAsSymbol = false} = opts;
|
|
const options: Intl.NumberFormatOptions = {
|
|
minimumIntegerDigits,
|
|
minimumFractionDigits,
|
|
maximumFractionDigits,
|
|
style: NumberFormatStyle[style].toLowerCase()
|
|
};
|
|
|
|
if (style == NumberFormatStyle.Currency) {
|
|
options.currency = typeof currency == 'string' ? currency : undefined;
|
|
options.currencyDisplay = currencyAsSymbol ? 'symbol' : 'code';
|
|
}
|
|
return new Intl.NumberFormat(locale, options).format(num);
|
|
}
|
|
}
|
|
|
|
type DateFormatterFn = (date: Date, locale: string) => string;
|
|
|
|
const DATE_FORMATS_SPLIT =
|
|
/((?:[^yMLdHhmsazZEwGjJ']+)|(?:'(?:[^']|'')*')|(?:E+|y+|M+|L+|d+|H+|h+|J+|j+|m+|s+|a|z|Z|G+|w+))(.*)/;
|
|
|
|
const PATTERN_ALIASES: {[format: string]: DateFormatterFn} = {
|
|
// Keys are quoted so they do not get renamed during closure compilation.
|
|
'yMMMdjms': datePartGetterFactory(combine([
|
|
digitCondition('year', 1),
|
|
nameCondition('month', 3),
|
|
digitCondition('day', 1),
|
|
digitCondition('hour', 1),
|
|
digitCondition('minute', 1),
|
|
digitCondition('second', 1),
|
|
])),
|
|
'yMdjm': datePartGetterFactory(combine([
|
|
digitCondition('year', 1), digitCondition('month', 1), digitCondition('day', 1),
|
|
digitCondition('hour', 1), digitCondition('minute', 1)
|
|
])),
|
|
'yMMMMEEEEd': datePartGetterFactory(combine([
|
|
digitCondition('year', 1), nameCondition('month', 4), nameCondition('weekday', 4),
|
|
digitCondition('day', 1)
|
|
])),
|
|
'yMMMMd': datePartGetterFactory(
|
|
combine([digitCondition('year', 1), nameCondition('month', 4), digitCondition('day', 1)])),
|
|
'yMMMd': datePartGetterFactory(
|
|
combine([digitCondition('year', 1), nameCondition('month', 3), digitCondition('day', 1)])),
|
|
'yMd': datePartGetterFactory(
|
|
combine([digitCondition('year', 1), digitCondition('month', 1), digitCondition('day', 1)])),
|
|
'jms': datePartGetterFactory(combine(
|
|
[digitCondition('hour', 1), digitCondition('second', 1), digitCondition('minute', 1)])),
|
|
'jm': datePartGetterFactory(combine([digitCondition('hour', 1), digitCondition('minute', 1)]))
|
|
};
|
|
|
|
const DATE_FORMATS: {[format: string]: DateFormatterFn} = {
|
|
// Keys are quoted so they do not get renamed.
|
|
'yyyy': datePartGetterFactory(digitCondition('year', 4)),
|
|
'yy': datePartGetterFactory(digitCondition('year', 2)),
|
|
'y': datePartGetterFactory(digitCondition('year', 1)),
|
|
'MMMM': datePartGetterFactory(nameCondition('month', 4)),
|
|
'MMM': datePartGetterFactory(nameCondition('month', 3)),
|
|
'MM': datePartGetterFactory(digitCondition('month', 2)),
|
|
'M': datePartGetterFactory(digitCondition('month', 1)),
|
|
'LLLL': datePartGetterFactory(nameCondition('month', 4)),
|
|
'L': datePartGetterFactory(nameCondition('month', 1)),
|
|
'dd': datePartGetterFactory(digitCondition('day', 2)),
|
|
'd': datePartGetterFactory(digitCondition('day', 1)),
|
|
'HH': digitModifier(
|
|
hourExtractor(datePartGetterFactory(hour12Modify(digitCondition('hour', 2), false)))),
|
|
'H': hourExtractor(datePartGetterFactory(hour12Modify(digitCondition('hour', 1), false))),
|
|
'hh': digitModifier(
|
|
hourExtractor(datePartGetterFactory(hour12Modify(digitCondition('hour', 2), true)))),
|
|
'h': hourExtractor(datePartGetterFactory(hour12Modify(digitCondition('hour', 1), true))),
|
|
'jj': datePartGetterFactory(digitCondition('hour', 2)),
|
|
'j': datePartGetterFactory(digitCondition('hour', 1)),
|
|
'mm': digitModifier(datePartGetterFactory(digitCondition('minute', 2))),
|
|
'm': datePartGetterFactory(digitCondition('minute', 1)),
|
|
'ss': digitModifier(datePartGetterFactory(digitCondition('second', 2))),
|
|
's': datePartGetterFactory(digitCondition('second', 1)),
|
|
// while ISO 8601 requires fractions to be prefixed with `.` or `,`
|
|
// we can be just safely rely on using `sss` since we currently don't support single or two digit
|
|
// fractions
|
|
'sss': datePartGetterFactory(digitCondition('second', 3)),
|
|
'EEEE': datePartGetterFactory(nameCondition('weekday', 4)),
|
|
'EEE': datePartGetterFactory(nameCondition('weekday', 3)),
|
|
'EE': datePartGetterFactory(nameCondition('weekday', 2)),
|
|
'E': datePartGetterFactory(nameCondition('weekday', 1)),
|
|
'a': hourClockExtractor(datePartGetterFactory(hour12Modify(digitCondition('hour', 1), true))),
|
|
'Z': timeZoneGetter('short'),
|
|
'z': timeZoneGetter('long'),
|
|
'ww': datePartGetterFactory({}), // Week of year, padded (00-53). Week 01 is the week with the
|
|
// first Thursday of the year. not support ?
|
|
'w':
|
|
datePartGetterFactory({}), // Week of year (0-53). Week 1 is the week with the first Thursday
|
|
// of the year not support ?
|
|
'G': datePartGetterFactory(nameCondition('era', 1)),
|
|
'GG': datePartGetterFactory(nameCondition('era', 2)),
|
|
'GGG': datePartGetterFactory(nameCondition('era', 3)),
|
|
'GGGG': datePartGetterFactory(nameCondition('era', 4))
|
|
};
|
|
|
|
|
|
function digitModifier(inner: DateFormatterFn): DateFormatterFn {
|
|
return function(date: Date, locale: string): string {
|
|
const result = inner(date, locale);
|
|
return result.length == 1 ? '0' + result : result;
|
|
};
|
|
}
|
|
|
|
function hourClockExtractor(inner: DateFormatterFn): DateFormatterFn {
|
|
return function(date: Date, locale: string): string { return inner(date, locale).split(' ')[1]; };
|
|
}
|
|
|
|
function hourExtractor(inner: DateFormatterFn): DateFormatterFn {
|
|
return function(date: Date, locale: string): string { return inner(date, locale).split(' ')[0]; };
|
|
}
|
|
|
|
function intlDateFormat(date: Date, locale: string, options: Intl.DateTimeFormatOptions): string {
|
|
return new Intl.DateTimeFormat(locale, options).format(date).replace(/[\u200e\u200f]/g, '');
|
|
}
|
|
|
|
function timeZoneGetter(timezone: string): DateFormatterFn {
|
|
// To workaround `Intl` API restriction for single timezone let format with 24 hours
|
|
const options = {hour: '2-digit', hour12: false, timeZoneName: timezone};
|
|
return function(date: Date, locale: string): string {
|
|
const result = intlDateFormat(date, locale, options);
|
|
// Then extract first 3 letters that related to hours
|
|
return result ? result.substring(3) : '';
|
|
};
|
|
}
|
|
|
|
function hour12Modify(
|
|
options: Intl.DateTimeFormatOptions, value: boolean): Intl.DateTimeFormatOptions {
|
|
options.hour12 = value;
|
|
return options;
|
|
}
|
|
|
|
function digitCondition(prop: string, len: number): Intl.DateTimeFormatOptions {
|
|
const result: {[k: string]: string} = {};
|
|
result[prop] = len === 2 ? '2-digit' : 'numeric';
|
|
return result;
|
|
}
|
|
|
|
function nameCondition(prop: string, len: number): Intl.DateTimeFormatOptions {
|
|
const result: {[k: string]: string} = {};
|
|
if (len < 4) {
|
|
result[prop] = len > 1 ? 'short' : 'narrow';
|
|
} else {
|
|
result[prop] = 'long';
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
function combine(options: Intl.DateTimeFormatOptions[]): Intl.DateTimeFormatOptions {
|
|
return options.reduce((merged, opt) => ({...merged, ...opt}), {});
|
|
}
|
|
|
|
function datePartGetterFactory(ret: Intl.DateTimeFormatOptions): DateFormatterFn {
|
|
return (date: Date, locale: string): string => intlDateFormat(date, locale, ret);
|
|
}
|
|
|
|
const DATE_FORMATTER_CACHE = new Map<string, string[]>();
|
|
|
|
function dateFormatter(format: string, date: Date, locale: string): string {
|
|
const fn = PATTERN_ALIASES[format];
|
|
|
|
if (fn) return fn(date, locale);
|
|
|
|
const cacheKey = format;
|
|
let parts = DATE_FORMATTER_CACHE.get(cacheKey);
|
|
|
|
if (!parts) {
|
|
parts = [];
|
|
let match: RegExpExecArray|null;
|
|
DATE_FORMATS_SPLIT.exec(format);
|
|
|
|
let _format: string|null = format;
|
|
while (_format) {
|
|
match = DATE_FORMATS_SPLIT.exec(_format);
|
|
if (match) {
|
|
parts = parts.concat(match.slice(1));
|
|
_format = parts.pop() !;
|
|
} else {
|
|
parts.push(_format);
|
|
_format = null;
|
|
}
|
|
}
|
|
|
|
DATE_FORMATTER_CACHE.set(cacheKey, parts);
|
|
}
|
|
|
|
return parts.reduce((text, part) => {
|
|
const fn = DATE_FORMATS[part];
|
|
return text + (fn ? fn(date, locale) : partToTime(part));
|
|
}, '');
|
|
}
|
|
|
|
function partToTime(part: string): string {
|
|
return part === '\'\'' ? '\'' : part.replace(/(^'|'$)/g, '').replace(/''/g, '\'');
|
|
}
|
|
|
|
export class DateFormatter {
|
|
static format(date: Date, locale: string, pattern: string): string {
|
|
return dateFormatter(pattern, date, locale);
|
|
}
|
|
}
|