Provides internationalization functionalities based on Chrome.i18n, and formats the localized message strings with number, date, plural, and select placeholders.
This package enables internationalization in the format provided by Chrome, and provides formatting support for dates, numbers, plurals and so on, according to the specifications provided by FormatJS.
The localized messages should be saved in a dedicated locales folder (it can be anywhere in your path, you can just provide it to this module on initialization), one file per locale (e.g. en.json and fr.json), in the JSON format specified by chrome.i18n.
{
"hello_world": {
"message": "Hello, world!",
"description": "Greetings message"
}
}This module depends on intl to be available in your node environment. Both the intl documentation and the formatJS documentation provide tutorials on how to set it up correctly.
In case intl is not set up correctly, since most Node environments only support the english language, the formatting of strings will be defaulted to English.
After making sure that the polyfill is correctly installed, this module can be set up to the desired locale, and used to get internationalized messages:
const chromeI18n = new ChromeI18n('en', 'en', './sample/locales');
chromeI18n.getMessage('hello_world');
$ Hello, world!
It allows to format messages based on the conventions of the chosen locale. For example, in English we would see the following message:
const chromeI18n = new ChromeI18n('en', 'en', './sample/locales');
chromeI18.getMessage('annie_action', { numPhotos: 1000 });
$ Annie took 1,000 photos.
While in french, the number is formatted differently:
const chromeI18n = new ChromeI18n('fr', 'en', './sample/locales');
chromeI18.getMessage('annie_action', { numPhotos: 1000 });
$ Annie a pris 1 000 photographies.
For more details on usage, or to see it in action, refer to the sample code.
You can run the sample with npm run sample.