react-intl-universal

react-intl-universal is a React internationalization package developed by Alibaba Group.

Features

• Can be used not only in React component but also in Vanilla JS.
• Simple. Only three main API and one optional helper.
• Display numbers, currency, dates and times for different locales.
• Pluralize labels in strings.
• Support variables in message.
• Support HTML in message.
• Support for 150+ languages.
• Runs in the browser and Node.js.
• Message format is strictly implemented by ICU standards.
• Locale data in nested JSON format are supported.
• react-intl-universal-extract helps you generate a locale file easily.

Live Demo

react-intl-universal example

Why Another Internationalization Solution for React?

In case of internationalizing React apps, react-intl is one of most popular package in industry. react-intl decorate your React.Component with wrapped component which is injected internationalized message dynamically so that the locale data is able to be loaded dynamically without reloading page. The following is the example code using react-intl.

1import { injectIntl } from 'react-intl';
2class MyComponent extends Component {
3  render() {
4    const intl = this.props;
5    const title = intl.formatMessage({ id: 'title' });
6    return (<div>{title}</div>);
7  }
8};
9export default injectIntl(MyComponent);

However, this approach introduces two major issues.

Firstly, Internationalizing can be applied only in view layer such as React.Component. For Vanilla JS file, there's no way to internationalize it. For example, the following snippet is general form validator used by many React.Component in our apps. We definitely will not have such code separated in different React.Component in order to internationalize the warning message. Sadly, react-intl can't be used in Vanilla JS.

1export default const rules = {
2  noSpace(value) {
3    if (value.includes(' ')) {
4      return 'Space is not allowed.';
5    }
6  }
7};

Secondly, since your React.Component is wrapped by another class, the behavior is not as expected in many way. For example, to get the instance of React.Component, you can't use the normal way like:

1class App {
2  render() {
3    <MyComponent ref="my"/>
4  }
5  getMyInstance() {
6    console.log('getMyInstance', this.refs.my);
7  }
8}

Instead, you need to use the method getWrappedInstance() to get that.

1class MyComponent {...}
2export default injectIntl(MyComponent, {withRef: true});
3
4class App {
5  render() {
6    <MyComponent ref="my"/>
7  }
8  getMyInstance() {
9    console.log('getMyInstance', this.refs.my.getWrappedInstance());
10  }
11}

Furthermore, your React.Component's properties are not inherited in subclass since component is injected by react-intl.

Due to the problem above, we create react-intl-universal to internationalize React app using simple but powerful API.

Get Started

App Examples

• Next.js Apps
• Component

Message With Variables

If the message contains variables the {variable_name} is substituted directly into the string. In the example below, there are two variables {name} and {where}, the second argument representing the variables in get method are substituted into the string.

Locale data:

1{ "HELLO": "Hello, {name}. Welcome to {where}!" }

JS code:

1intl.get('HELLO', { name: 'Tony', where: 'Alibaba' }) // "Hello, Tony. Welcome to Alibaba!"

Plural Form and Number Thousands Separators

Locale data:

1{ "PHOTO": "You have {num, plural, =0 {no photos.} =1 {one photo.} other {# photos.}}" }

JS code:

1intl.get('PHOTO', { num: 0 }); // "You have no photos."
2intl.get('PHOTO', { num: 1 }); // "You have one photo."
3intl.get('PHOTO', { num: 1000000 }); // "You have 1,000,000 photos."

Plural label supports standard ICU Message syntax.

Number thousands separators also varies according to the user's locale. According to this document, United States use a period to indicate the decimal place. Many other countries use a comma instead.

Display Currency

Locale data:

1{ "SALE_PRICE": "The price is {price, number, USD}" }

JS code:

1intl.get('SALE_PRICE', { price: 123456.78 }); // The price is $123,456.78

As mentioned, the locale data is in ICU Message format.

The syntax is {name, type, format}. Here is description:

• name is the variable name in the message. In this case, it's price.
• type is the type of value such as number, date, and time.
• format is optional, and is additional information for the displaying format of the value. In this case, it's USD.

if type is number and format is omitted, the result is formatted number with thousands separators. If format is one of currency code, it will show in corresponding currency format.

Display Dates

Locale data:

1{
2  "SALE_START": "Sale begins {start, date}",
3  "SALE_END": "Sale ends {end, date, long}"
4}

JS code:

1intl.get('SALE_START', {start:new Date()}); // Sale begins 4/19/2017
2intl.get('SALE_END', {end:new Date()}); // Sale ends April 19, 2017

If type is date, format has the following values:

• short shows date as shortest as possible
• medium shows short textual representation of the month
• long shows long textual representation of the month
• full shows dates with the most detail

Display Times

Locale data:

1{
2  "COUPON": "Coupon expires at {expires, time, medium}"
3}

JS code:

1intl.get('COUPON', {expires:new Date()}); // Coupon expires at 6:45:44 PM

if type is time, format has the following values:

• short shows times with hours and minutes
• medium shows times with hours, minutes, and seconds
• long shows times with hours, minutes, seconds, and timezone

Default Message

When the specific key does't exist in current locale, you may want to make it return a default message. Use defaultMessage method after get method. For example,

Locale data:

1{ "HELLO": "Hello, {name}" }

JS code:

1const name = 'Tony';
2intl.get('HELLO', { name }).defaultMessage(`Hello, ${name}`); // "Hello, Tony"

Or using d for short:

1const name = 'Tony';
2intl.get('HELLO', { name }).d(`Hello, ${name}`); // "Hello, Tony"

And getHTML also supports default message.

1const name = 'Tony';
2intl.getHTML('HELLO').d(<div>Hello, {name}</div>) // React.Element with "<div>Hello, Tony</div>"

HTML Message

The get method returns string message. For HTML message, use getHTML instead. For example,

Locale data:

1{ "TIP": "This is <span style='color:red'>HTML</span>" }

JS code:

1intl.getHTML('TIP'); // {React.Element}

Helper

react-intl-universal provides a utility helping developer determine the user's currentLocale. As the running examples, when user select a new locale, it redirect user new location like http://localhost:3000?lang=en-US. Then, we can use intl.determineLocale to get the locale from URL. It can also support determine user's locale via cookie, localStorage, and browser default language. Refer to the APIs section for more detail.

Debugger mode

When developing a website with multiple languages (i18n), translators are usually responsible for translating the content instead of the web developer. However, translators often struggle to find the specific message they need to edit on the webpage because they don't know its key. This leads to them having to ask the developer for the key, resulting in a lot of time wasted on communication.

To solve this issue, a solution is proposed: When the debugger mode in react-intl-universal is enabled, each message on the webpage will be wrapped in a special span element with the key "data-i18n-key". This way, translators can easily see the key of the message and make the necessary edits themselves using some message management system, without needing to ask the developer.

Enabling debugger mode:

1intl.init({
2  // ...
3  debug: true
4})

Message will be wrapped in a span element with the key "data-i18n-key":

Component Internationalization

When internationalizing a React component, you don't need to intl.init again. You could make it as peerDependency, then just load the locale data in the compoent.

APIs Definition

1  /**
2   * Initialize properties and load CLDR locale data according to currentLocale
3   * @param {Object} options
4   * @param {string} options.escapeHtml To escape html. Default value is true.
5   * @param {string} options.currentLocale Current locale such as 'en-US'
6   * @param {Object} options.locales App locale data like {"en-US":{"key1":"value1"},"zh-CN":{"key1":"值1"}}
7   * @param {Object} options.warningHandler Ability to accumulate missing messages using third party services. See https://github.com/alibaba/react-intl-universal/releases/tag/1.11.1
8   * @param {string} options.fallbackLocale Fallback locale such as 'zh-CN' to use if a key is not found in the current locale
9   * @param {boolean} options.debug If debugger mode is on, the message will be wrapped by a span with data key
10   * @param {string} options.dataKey If debugger mode is on, the message will be wrapped by a span with this data key. Default value 'data-i18n-key'
11   * @returns {Promise}
12   */
13  init(options)
14
15
16  /**
17   * Load more locales after init
18   * @param {Object} locales App locale data 
19   */
20  load(locales)
21
22
23  /**
24   * Get the formatted message by key
25   * @param {string} key The string representing key in locale data file
26   * @param {Object} variables Variables in message
27   * @returns {string} message
28   */
29  get(key, variables)
30
31  /**
32   * Get the formatted html message by key.
33   * @param {string} key The string representing key in locale data file
34   * @param {Object} variables Variables in message
35   * @returns {React.Element} message
36  */
37  getHTML(key, options)
38
39  /**
40   * Helper: determine user's locale via URL, cookie, and browser's language.
41   * You may not need this API, if you have other rules to determine user's locale.
42   * @param {string} options.urlLocaleKey URL's query Key to determine locale. Example: if URL=http://localhost?lang=en-US, then set it 'lang'
43   * @param {string} options.cookieLocaleKey Cookie's Key to determine locale. Example: if cookie=lang:en-US, then set it 'lang'
44   * @param {string} options.localStorageLocaleKey LocalStorage's Key to determine locale such as 'lang'
45   * @returns {string} determined locale such as 'en-US'
46   */
47  determineLocale(options)
48
49  /**
50  * Change current locale
51  * @param {string} newLocale Current locale such as 'en-US'
52  */
53  changeCurrentLocale(newLocale)
54
55  /**
56   * Get the inital options 
57   * @returns {Object} options includes currentLocale and locales
58   */
59  getInitOptions()

Compatibility with react-intl

As mentioned in the issue Mirror react-intl API, to make people switch their existing React projects from react-intl to react-intl-universal. We provide two compatible APIs as following.

1  /**
2   * As same as get(...) API
3   * @param {Object} options 
4   * @param {string} options.id 
5   * @param {string} options.defaultMessage
6   * @param {Object} variables Variables in message
7   * @returns {string} message
8  */
9  formatMessage(options, variables)

1  /**
2   * As same as getHTML(...) API
3   * @param {Object} options 
4   * @param {string} options.id 
5   * @param {React.Element} options.defaultMessage
6   * @param {Object} variables Variables in message
7   * @returns {React.Element} message
8  */
9  formatHTMLMessage(options, variables)

For example, the formatMessage API

1const name = 'Tony';
2intl.formatMessage({ id:'hello', defaultMessage: `Hello, ${name}`}, {name});

is equivalent to get API

1const name = 'Tony';
2intl.get('hello', {name}).d(`Hello, ${name}`);

And the formatHTMLMessage API

1const name = 'Tony';
2intl.formatHTMLMessage({ id:'hello', defaultMessage: <div>Hello</div>}, {name});

is equivalent to getHTML API

1const name = 'Tony';
2intl.getHTML('hello', {name}).d(<div>Hello</div>);

FAQ

1. How to Internationalize Message in Constants Object

If constants are defined outside of a React component, the message in constants.fruits may get loaded before intl.init(...). This can cause a warning to be displayed, such as react-intl-universal locales data "null" not exists.

1// Wrong: the message in constants.fruits is loaded before `intl.init(...)`
2const constants = {
3  fruits : [
4    { label: intl.get('banana'), value: 'banana' },
5    { label: intl.get('apple'), value: 'apple' },
6  ]
7}
8function MyComponent() {
9  return <Select dataSource={constants.fruits} />
10}

To fix this, you should call intl.init before render.

Solution 1

Make the message object as a function, and call it at render function.

1const constants = {
2    fruits : () => [  // as arrow function
3        { label: intl.get('banana'), value: 'banana' },
4        { label: intl.get('apple'), value: 'apple' },
5    ]
6}
7function MyComponent() {
8    // fruits is a function which returns message when rendering
9    return <Select dataSource={constants.fruits()} />
10}

Solution 2

Use getter syntax to make a function call when that property is looked up

1const constants = {
2  fruits: [
3    {
4      get label() {
5        return intl.get("banana");
6      },
7      value: "banana",
8    },
9    {
10      get label() {
11        return intl.get("apple");
12      },
13      value: "apple",
14    },
15  ],
16};
17function MyComponent() {
18  // When "label" property is looked up, it actually make a function call 
19  return <Select dataSource={constants.fruits} />;
20}

2. How to Bind Event Handlers to an Internationalized Message

1const MyComp = (props) => {
2  const onClick = (e) => {
3    if (e.target.tagName === 'A') {
4      // event handler for "A" tag in the message
5    }
6  };
7  return (
8    // Wrap the message in a container and listen for the children's events.
9    <span onClick={onClick}>
10      {intl.getHTML('more_detail').d(<span>Please refer to the <a>document</a> for more detail.</span>)}
11    </span>
12  )
13}

Other Frontend Tools

• react-intl-universal-extract: Extract default messages in application. This package will generate a json file which contains the extracted messages.
• react-intl-universal-pseudo-converter: A pseudo-localization tool for testing internationalization.
• JSON5 Editor: JSON for Humans.
• Compare NPM Packages: Find the Best npm Package for Your Project.

License

This software is free to use under the BSD license.