angular-ecmascript-intl

Angular ECMAScript Intl

Contains pipes to transform internationalization data using Intl.* browser APIs.

Getting started

Install the package:

npm install angular-ecmascript-intl --save

Import the IntlModule:

import {NgModule} from '@angular/core';
import {IntlModule} from 'angular-ecmascript-intl';

@NgModule({
  imports: [
    IntlModule,
  ],
})
export class MyModule {
}

By default, the pipe will use the browser default locale. If you want to override it, you can provide the INTL_LOCALES injection token:

import {NgModule} from '@angular/core';
import {INTL_LOCALES} from 'angular-ecmascript-intl';

@NgModule({
  providers: [
    {
      provide: INTL_LOCALES,
      useValue: 'de-DE',
    },
  ],
})
export class MyModule {
}

Now you can use the pipes, see below.

Pipes

Date Pipe

Use the date pipe like the following:

{{myDate | intlDate: options}}

The input date can be one of the following:

• Date object
• number (UNIX timestamp)
• string (will be parsed by new Date() constructor)
• null
• undefined

The options are the same as the options for new Intl.DateTimeFormat(). For a list of the options, see their docs.

With the INTL_DATE_PIPE_DEFAULT_OPTIONS injection token you can specify default options.

Decimal pipe

Use the decimal pipe like the following:

{{1.24 | intlDecimal: options}}

The input can be one of the following:

• number
• string (must be parseable as number)
• null
• undefined

The options are the same as the options for new Intl.NumberFormat(). For a list of the options, see their docs.

With the INTL_DECIMAL_PIPE_DEFAULT_OPTIONS injection token you can specify default options.

Percent pipe

Use the percent pipe like the following:

{{0.24 | intlPercent: options}}

The input can be one of the following:

• number
• string (must be parseable as number)
• null
• undefined

The options are the same as the options for new Intl.NumberFormat(). For a list of the options, see their docs.

With the INTL_PERCENT_PIPE_DEFAULT_OPTIONS injection token you can specify default options.

Currency pipe

Use the currency pipe like the following:

{{1.24 | intlCurrency: 'USD': options}}

The input can be one of the following:

• number
• string (must be parseable as number)
• null
• undefined

The currency code parameter is required and must be a valid ISO 4217 currency code. If you want to transform a decimal number instead, use the intlDecimal pipe.

The options are the same as the options for new Intl.NumberFormat(). For a list of the options, see their docs.

With the INTL_CURRENCY_PIPE_DEFAULT_OPTIONS injection token you can specify default options.

Language pipe

Use the language pipe like the following:

{{'en-US' | intlLanguage: options}}

The input can be one of the following:

• string (must be a BCP 47 IETF language tag)
• null
• undefined

The options are the same as the options for new Intl.DisplayNames(). For a list of the options, see their docs.

With the INTL_LANGUAGE_PIPE_DEFAULT_OPTIONS injection token you can specify default options.

Background

For more context, see the following GitHub issue

Feature Roadmap

• Performance: Prepare Intl.* object with default options, only construct new object when necessary
• Country pipe
• Relative time
• Migration Schematics for usages of Angular pipes

Chore Roadmap

• Linting
• Pull request verification
• Automatic dependency updates
• Automatic npm publishing
• Automatic changelog generation