Skip to content
Branch: master
Find file History
ThierryDD and shaharkazaz Inconsistancewith MessageFormat.Options interface (#132)
It should be `customFormatters` instead of `formatters`.
Latest commit 8f3c4fc Oct 15, 2019

README.md

TRANSLOCO MESSAGE FORMAT

Transpiler for @ngneat/transloco that uses messageformat.js to compile translations using ICU syntax for handling pluralization and gender.

Messageformat is a mechanism for handling both pluralization and gender in your app.

You can see its format guide here.

Installation

npm i messageformat @ngneat/transloco-messageformat

Usage

The MessageFormatTranspiler is compatible with the DefaultTranspiler and therefore you can switch without worry that it will break your current translations.

It enables support for the following within your i18n translation files:

{
  "mySelectRule": "{myVar, select, val1 {Value 1} val2 {Value 2} other {Other Value}}",
  "myPluralRule": "{myCount, plural, =0 {no results} one {1 result} other {# results}}"
}

To enable this plugin, add the following to the imports array in your app.module.ts:

import { TranslocoMessageFormatModule } from '@ngneat/transloco-messageformat';

...

@NgModule({
  imports: [
    ...,
    TranslocoMessageFormatModule.init()
  ]
})

Locale initialization

By default, messageformat initializes all locales. You could also provide the locales you will need:

@NgModule({
  imports: [
    ...,
    TranslocoMessageFormatModule.init(
      {
        locales: 'en-GB'
      }
    )
  ]
})

The value for locales is either a string or an array of strings. The first locale is used as the default locale by messageformat. More info here: https://messageformat.github.io/messageformat/MessageFormat

Advanced configuration

MessageFormat instances provide some methods to influence its behaviour, among them addFormatters, setBiDiSupport, and setStrictNumberSign. Learn about their meaning here: https://messageformat.github.io/messageformat/MessageFormat

This is how you would enable bi-directional support and add a custom formatter, for example:

@NgModule({
  imports: [
    ...,
    TranslocoMessageFormatModule.init(
      {
        biDiSupport: true,
        customFormatters: { upcase: v => v.toUpperCase() }
      }
    )
  ]
})
You can’t perform that action at this time.