Polyglot.js

Polyglot.js is a tiny I18n helper library written in JavaScript, made to work both in the browser and in CommonJS environments (Node). It provides a simple solution for interpolation and pluralization, based off of Airbnb's experience adding I18n functionality to its Backbone.js and Node apps. Polyglot has zero dependencies.

I18n is incredibly important for us at Airbnb, as we have listings in 192 countries, and we translate our site into 30-odd different languages. We're also hiring talented engineers to help us scale up to meet the challenges of buliding a global marketplace.

View the documentation on Github.

View the annotated source.

Download the development version: 7.9kb, unminified with comments.

Download the production version: 2.8kb, minified (1.3kb gzipped).

Polylglot is agnostic to your translation backend. It doesn't perform any translation; it simply gives you a way to manage translated phrases from your client- or server-side JavaScript application.

Installation

For use with Node, install with NPM:

$ npm install node-polyglot

Running the tests

$ npm install

$ npm test

  t
    ✓ should translate a simple string
    ✓ should return the key if translation not found
    ✓ should interpolate
    ✓ should interpolate the same placeholder multiple times
    ✓ should allow you to supply default values

  locale
    ✓ should default to 'en'
    ✓ should get and set locale

  extend
    ✓ should support multiple extends, overriding old keys
    ✓ shouldn't forget old keys

  clear
    ✓ should wipe out old phrases

  replace
    ✓ should wipe out old phrases and replace with new phrases

  pluralize
    ✓ should support pluralization with an integer
    ✓ should support pluralization with an Array
    ✓ should support pluralization of anything with a 'length' property
    ✓ should support the 'pluralize' shortcut


  ✔ 15 tests complete (13ms)

Usage

Instantiation

First, create an instance of the Polyglot class, which you will use for translation.

var polyglot = new Polyglot();

Polyglot is class-based so you can maintain different sets of phrases at the same time, possibly in different locales. This is very useful for example when serving requests with Express, because each request may have a different locale, and you don't want concurrent requests to clobber each other's phrases.

Translation

Tell Polyglot what to say by simply giving it a phrases object, where the key is the canonical name of the phrase and the value is the already-translated string.

polyglot.extend({
  "hello": "Hello"
});

polyglot.t("hello");
=> "Hello"

You can also instantiate with phrases:

var polyglot = new Polyglot({phrases: {"hello": "Hello"}});

Polyglot doesn't do the translation for you. It's up to you to give it the proper phrases for the user's locale.

A common pattern is to gather a hash of phrases in your backend, and output them in a <script> tag at the bottom of the document. For example, in Rails:

app/controllers/home_controller.rb

def index
  @phrases = {
    "home.login" => I18n.t("home.login"),
    "home.signup" => I18n.t("home.signup"),
    ...
  }
end

app/views/home/index.html.erb

<script>
  var polyglot = new Polyglot({phrases: <%= raw @phrases.to_json %>});
</script>

And now you can utilize i.e. polyglot.t("home.login") in your JavaScript application or Handlebars templates.

Interpolation

Polyglot.t() also provides interpolation. Pass an object with key-value pairs of interpolation arguments as the second parameter.

polyglot.extend({
  "hello_name": "Hola, %{name}."
});

polyglot.t("hello_name", {name: "DeNiro"});
=> "Hola, DeNiro."

Pluralization

For pluralization to work properly, you need to tell Polyglot what the current locale is. You can use polyglot.locale("fr") to set the locale to, for example, French. This method is also a getter:

polyglot.locale()
=> "fr"

You can also pass this in during instantiation.

var polyglot = new Polyglot({locale: "fr"});

Currently, the only thing that Polyglot uses this locale setting for is pluralization.

Polyglot provides a very basic pattern for providing pluralization based on a single string that contains all plural forms for a given phrase. Because various languages have different nominal forms for zero, one, and multiple, and because the noun can be before or after the count, we have to be overly explicit about the possible phrases.

To get a pluralized phrase, still use polyglot.t() but use a specially-formatted phrase string that separates the plural forms by the delimeter ||||, or four vertical pipe characters.

For pluralizing "car" in English, Polyglot assumes you have a phrase of the form:

polyglot.extend({
  "num_cars": "%{smart_count} car |||| %{smart_count} cars",
});

English (and German, Spanish, Italian, and a few others) there are only two plural forms: singular and not-singular.

polyglot.t() will choose the appropriate phrase based on the provided smart_count option.

polyglot.t("num_cars", {smart_count: 0});
=> "0 cars"

polyglot.t("num_cars", {smart_count: 1});
=> "1 car"

polyglot.t("num_cars", {smart_count: 2});
=> "2 cars"

However, some languages get a bit more complicated. In Czech, there are three separate forms: 1, 2 through 4, and 5 and up. Russian is even crazier.

The smart_count option can be a Number or anything with a length property, such as an Array or a Backbone.Collection.

var Cars = Backbone.Collection.extend({});
var cars = new Cars;

polyglot.t("num_cars", {smart_count: cars});
=> "0 cars"

cars.add({make: "Ford", model: "Fiesta"});

polyglot.t("num_cars", {smart_count: cars});
=> "1 car"

cars.add({make: "Subaru", model: "Impreza"});

polyglot.t("num_cars", {smart_count: cars});
=> "2 cars"

Public Methods

Polyglot.prototype.extend(phrases)

Use extend to tell Polyglot how to translate a given key.

polyglot.extend({
  "hello": "Hello",
  "hello_name": "Hello, %{name}"
});

The key can be any string. Feel free to call extend multiple times; it will override any phrases with the same key, but leave existing phrases untouched.

Polyglot.prototype.clear()

Clears all phrases. Useful for special cases, such as freeing up memory if you have lots of phrases but no longer need to perform any translation. Also used internally by replace.

Polyglot.prototype.replace(phrases)

Completely replace the existing phrases with a new set of phrases. Normally, just use extend to add more phrases, but under certain circumstances, you may want to make sure no old phrases are lying around.

Polyglot.prototype.t(key, interpolationOptions)

The most-used method. Provide a key, and t() will return the phrase.

polyglot.t("hello");
=> "Hello"

The phrase value is provided first by a call to polyglot.extend() or polyglot.replace().

Pass in an object as the second argument to perform interpolation.

polyglot.t("hello_name", {name: "Spike"});
=> "Hello, Spike"

If you like, you can provide a default value in case the phrase is missing. Use the special option key "_" to specify a default.

polyglot.t("i_like_to_write_in_language", {
  _: "I like to write in %{language}.",
  language: "JavaScript"
});
=> "I like to write in JavaScript."

Polyglot.prototype.pluralize(noun, count)

The pluralize() method is a simple wrapper around t()'s pluralization behavior. We pluralize based on the the value of the smart_count interpolated variable.

For pluralizing "car", it assumes you have a phrase defined like:

polyglot.extend({
  "shared.pluralize.car": "%{smart_count} car |||| %{smart_count} cars"
});

A call to pluralize() simply calls t() with an expected phrase key format, passing in the second argument as smart_count:

polyglot.pluralize('car', 2);

is equivalent to

polyglot.t('shared.pluralize.car', {smart_count: 2});

pluralize() will choose the appropriate phrase based on the provided count.

polyglot.pluralize("car", 0);
=> "0 cars"

polyglot.pluralize("car", 1);
=> "1 car"

polyglot.pluralize("car", 2);
=> "2 cars"

The second argument can be a Number or anything with a length property, such as an Array or a Backbone.Collection.

var cars = new Backbone.Collection();

polyglot.pluralize("car", cars);
=> "0 cars"

cars.add({make: "Ford", model: "Fiesta"});

polyglot.pluralize("car", cars);
=> "1 car"

cars.add({make: "Subaru", model: "Impreza"});

polyglot.pluralize("car", cars);
=> "2 cars"

History

v0.2.1: May 2, 2013

Added allowMissing option to let the phrase key be the default translation (thanks @ziad-saab).

v0.2.0: Dec 20, 2012

Breaking change: Moved from Singleton pattern to class-based. Now you create an instance of the Polyglot class rather than using class methods directly on it. The reason is to allow maintaining multiple sets of phrases, which is something we ran into at Airbnb with a highly-concurrent Express app.
Breaking change: Removed the built-in Handlebars helpers, because Handlebars is a singleton, and it's messy to create a single helper function that can be bound to different Polyglot instances. Instead, it's super easy to create your own, based on your requirements.

chenglou/polyglot.js