- jQuery.I18n by Wikimedia
- Polyglot by Airbnb
- Globalize by the jQuery team
All of these solutions are quite different and have their own specifics, so we’ll see them all in action.
The source code is available at GitHub.
Now, populate index.html with some markup:
This is enough for us to get started!
Let’s start with a jQuery-based internationalization library developed and maintained by Wikimedia. Wikimedia is a global movement which takes care of well-known projects such as Wikipedia, Wikinews, Wikibooks, and others. jQuery.I18n, in turn, uses a JSON-based localization file format and supports gender, grammar forms, dynamic change of language, fallback chains and more.
Translations for jQuery.I18n can be separated into multiple files (en.json, de.json, etc.) or stored all together in one file. Here is an example of en.json:
As you can see, these files support metadata where you specify authors, date of the latest update, locale, and other information. Next, you provide the actual translations in a key-value format. It is best practice to prefix keys with the app’s name to make it unique, but that’s not mandatory.
For apps of a smaller scope, you may provide all translations in a single file. In this case language’s name is specified as a parent key:
What’s more, you can even provide a path to the translations file:
Loading Translation Files
Now, of course, you may be wondering how to load these translations into your app. There are a couple of ways, and the first is probably the easiest one. Instead of creating a separate JSON file, you can place all translations directly into the script by passing them to the
I can’t say this is a practice to recommend but it is just fine for (really) small projects.
Another solution is to load messages from an external URL (relative or absolute):
When using this approach, the
load will return a promise, so you can place further actions inside the
You can set the locale upon the library’s initialization using either
locale option …
… or by providing it inside the
lang attribute for the
Of course, the locale can be switched later by redefining the
To translate a message, you would provide a key to the
or just employ a
Note that messages support interpolation by taking parameters. These are written as
To start off, copy our base index.html file as the jquery_i18n.html. Create a new jquery_i18n directory and place the main-jquery_i18n.js file inside.
Next clone jQuery.I18n somewhere on your PC along with sub-modules:
We will require all files from the src directory (without the languages folder) and also CLDRPluralRuleParser.js from thelibs\CLDRPluralRuleParser\src. Copy all of these into the jquery_i18n folder and then include them in the proper order:
Preferred Language and Switchers
Let’s also provide the initial locale via the
Lastly, add links to switch the language and a couple of empty tags that are going to host our translated content. I’ll work with English and Russian, but of course, you may choose any other languages – it does not really matter. For real-world apps, make sure your texts are properly translated, preferably by a human.
Now proceed to the script. We’ll need to load translations as soon as the document is ready. For simplicity, let’s store all our messages in the script:
welcome key – the same name lives in the
data-i18n attribute for the
h1 tag. This way, a proper translation will be used automatically – all we have to do is run this process by calling the
i18n() function. I’ll extract it inside the
Switching the Language
Next, let’s take care of language switching. This is simple – just listen to the
click event, extract the value of the
data-locale attribute and then set the locale accordingly:
Lastly, we are going to add a translation for the
#messages section. This is going a be a bit more complex:
Here, pluralization and gender info are used at the same time. For Russian, I had to add more options because pluralization rules are more complex. In order for this to work, tweak the
Now open the page and try to switch between languages – everything should be working just great!
Polyglot.js is a small solution created by Airbnb (an engineering company) that works in browser and in Common.js environments. It supports interpolation and pluralization while having zero dependencies. Grab production version here.
Getting Started with Polyglot
So, to start working with Polyglot, instantiate it:
It’s class-based, therefore you may work with different sets of locales at the same time.
Next, provide a list of phrases:
As a common pattern, the documentation suggests to prepare a hash of phrases on the backend and then output them in the
script tag. Note that Polyglot won’t do translation – it’s your job to give proper phrases based on a users’ locale.
You can replace or completely remove phrases (for example, to free up memory) by using
clear methods, respectively.
Note that Polyglot also supports nesting:
If you’ve come from the Rails world, interpolation should look familiar to you:
To perform the actual translation, apply the
If your key is nested, use dot
. as a delimiter:
Note that a language’s name is not provided anywhere – currently, it is used only when working with pluralization. To set it, employ the
locale function …
… or set it upon instantiating a new object by passing a
Messages with pluralization should be delimited with four pipes (
The correct message will be picked based on the
Now, let’s quickly see this solution in action. Copy the index.html file and name it polyglot.html. Then create a polyglot folder and place the production version of the script inside. Also, create the main-polyglot.js file there and hook everything up:
For this demo, we will utilize Underscore.js’ template engine to render content (though you may stick with Handlebars or some other solution). If you haven’t worked with such templates before, the idea is pretty simple: you have a markup with some parameters. This template is then being “compiled” (meaning that the parameters receive their values) and rendered on the page like any other HTML.
So, place the production version of Underscore into the common folder and load it:
I am going to place our template directly onto the page, at the very bottom. Note that it has to be wrapped with a
Next, inside the script, let’s wait until the document is ready and then instantiate the Polyglot class while providing two messages:
Here, we used interpolation and pluralization (note the parameter’s name
smart_count – when using another name the pluralization seems to stop working). Now, let’s grab the template …
… and then provide values to the parameters inside it:
Here is the resulting code:
Load the HTML document and test it out!
Globalize is a pretty big internationalization library developed by the members of the jQuery core team. It works in the browser (supporting all modern browsers and IE starting from version 9) and with Node.js, providing many useful features including number, date and time parsing, pluralization, interpolation, unit support and much more. It uses Unicode CLDR that provides key building blocks for software to support the world’s languages, with the largest and most extensive standard repository of locale data available. What’s more, Globalize is modular and does not contain any I18n data – you are free to load it yourself.
There are three main API functions:
Globalize.load()– loads CLDR locale data in JSON format (such as date and time formats, names of the month etc)
Globalize.locale()– getter and setter for the locale
[new] Globalize– instantiates a new Globalize object
Also, there are a variety of different functions for each module that you can find here.
Globalize in Practice
Let’s see Globalize in action right away. Copy the index.html file and name it globalize.html. Also, create the globalize folder with the globalize-main.js file inside.
As long as Globalize is modular, you need to load dependencies in the proper order. There is even an online tool available helping you to identify the necessary dependencies. Therefore, you’ll need to download the latest version of Globalize as well as CLDR. Here is the list of Globalize’s files to grab (place them inside the globalize folder of your project):
Unfortunately, that’s not all. Here are the required CLDR files that have to be placed inside cldr folder (create it now):
Phew. The last part is providing some common locale data for CLDR – download it here and place it under the cldr/cldr_data.jsname. Finally, hook all those files in the proper order:
Also, add a couple of placeholders for our content:
Now, let’s load a welcome message:
Here we are using the message-formatter module.
Next, instantiate the Globalize class and populate the
messageFormatter returns a function that we then call and pass the object containing a name. You can re-write it as:
Actually, message’s parameters do not need to be named – you may say
2 etc instead:
In this case, pass an array to the formatter:
Working with Currency
Next, provide another message containing today’s date and total earnings:
When formatting the currency, we pass
USD as the second argument. This argument is used to display a proper symbol when rendering the result. The symbol itself was defined inside the clrd_data.js file:
medium is the name of the date-time format – it was also defined inside the clrd_data.js file as:
1 is the date and
0 is time. Date and time, in turn, are formatted using the following masks:
Now that everything is ready, you can observe the result!
Phrase Saves the Day Once Again
Managing translations for multiple languages can be tedious indeed. With Phrase, however, the whole process becomes much simpler.
Grab your free trial if you have not signed up already and create a new project. Phrase supports a great range of various formats from simple to nested JSON (and specific formats for AngularJS or React). Next just add as many locales as you need and upload existing JSON files with translations if you have any.
Having done that you will be able to quickly understand which translations are missing, manage your keys and messages as well as download updated translations with one click. What’s even cooler, you can easily request support from professional translators (which is probably better as localization is not only about translation). Therefore, I really encourage you to give Phrase a try!
Hopefully, you found this article useful and interesting. Thanks for staying with me and happy coding!