Skip to content
Client-side internationalization / localization library
Branch: master
Clone or download
Pull request Compare This branch is 50 commits ahead, 47 commits behind fabi1cazenave:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
README.md
l10n.js

README.md

client-side, cross-browser l10n for modern web applications

Unlike other i18n/l10n libraries, html10n.js provides:

  • declarative localization: elements with l10n-* attributes are automatically translated when the document is loaded
  • named variables instead of printf-like %s tokens
  • a simple and full-featured pluralization system

Thanks to @fabi1cazenave for his original work on webL10n on which this project is based. Instead of featuring some *.ini/*.properties/*.lol format, this project expects translations to be provided in JSON for easier handling in JavaScript and better client-side performance.

Example

Here’s a quick way to get a multilingual HTML page:

<html>
<head>
  <script type="text/javascript" src="l10n.js"></script>
  <link rel="localizations" href="i18n.json" type="application/l10n+json"/>
</head>
<body>
  <button data-l10n-id="test" title="click me!">This is a test</button>
</body>
</html>
  • l10n resource files are associated to the HTML document with a <link> element
  • translatable elements carry a data-l10n-id attribute and optionally a data-l10n-args attribute containing the message arguments as JSON.
  • l10n resources are stored in a bullet-proof *.json file:
{
"en": {
  "test": "This is a test",
  "test.title": "click me!"
},
"fr": {
  "test": "Ceci est un test",
  "test.title": "cliquez-moi!"
}
}

JavaScript API

html10n.js exposes a rather simple API, all contained in the html10n object.

  • localized event: fired when the page has been translated;
  • localize method: set the ISO-639-1 code of the current locale and start translating the document;
  • get method: get a translated string.
html10n.bind("localized", function() {
  console.log("Localized!");
});

html10n.localize('fr');

Do note, that html1n.js waits for the document to be fully loaded, until it loads translation. You could circumvent this by calling html10n.index() manually, but it's not advised.

var message = html10n.get('test');
alert(message);

You will probably use the gettext-like alias:

alert(_('test'));

To handle complex strings, the get() method can accept optional arguments:

alert(_('welcome', { user: "John" }));

where welcome is defined like this:

{
"en": {
  "welcome": "welcome, {{user}}!"
},
"fr": {
  "welcome": "bienvenue, {{user}} !"
}
}

l10n arguments

You can specify a default value in JSON for any argument in the HTML document with the data-l10n-args attribute. In the last example, that would be:

<p data-l10n-id="welcome" data-l10n-args='{ "user": "your awesomeness" }'>Welcome!</p>

include rules

If you don’t want to have all your locales in a single file, simply use an include rule in your locale files to include another language:

{ "en": {
// ...
},
"fr": "/locales/fr.json",
"nl": "/locales/nl.json"
}

Pluralization

The following string might be gramatically incorrect when n equals zero or one:

"unread": "You have {{n}} unread messages"

This can be solved by using the pre-defined plural() macro:

{
"en": {
 "unreadMessages": "You have {{n}} unread {[ plural(n) one: message, other: messages ]}"
}
}

Here, plural() is a macro taking a selector param based on which it picks on of the provided options.

plural() chooses between zero | one | two | few | many | other, depending on the param (n) and the current language, as specified in the Unicode plural rules. If one of these indexes isn’t specified in your message, other will be used instead.

Macros

Macros are defined in html10n.macros as functions taking the following arguments: (key, param, opts), where

  • key (String) is the key of the current message
  • param (mixed) is the value of the argument, passed as the macro parameter
  • opts (Object) is a hash of options that may be used to produce the output (s. plural() macro above)

All macros should return a string that will replace the macro in the message.

Translating DOM properties

By default, we currently assume that all strings are applied to the textContent DOM node property. However, you can modify other properties of the relevant DOM nodes by choosing a message id that ends with the property name like so:

{
  "welcome.innerHTML": "welcome, <strong>{{user}}</strong>!"
}

Browser support

Should work with Firefox, Chrome, Opera and Internet Explorer 6 to 10.

License

MIT license.

You can’t perform that action at this time.