A sane JavaScript internationalisation library
JavaScript CoffeeScript HTML
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec Make events more intelligent Apr 25, 2016
.gitmodules Update to /florian GitHub URL Apr 8, 2016
.travis.yml Use modern node version for travis Apr 8, 2016
Gruntfile.coffee
History.md
LICENSE Use newest observable_js via NPM Apr 25, 2016
README.md
bower.json
package.json
testem.yml adjust port Dec 22, 2012

README.md

X18n Build Status

X18n is a JavaScript library that helps you to translate web apps that do a lot on the client side. It automatically detects the user language and sorts the available translations smartly. It has nice interpolation and pluralisation features that are also compatible with Ruby's r18n gem.

If you use React it's super easy to translate your app using react-x18n.

Overview

npm install x18n or just grab x18n_build.js

x18n.register('en', {
  user: {
    greeting: 'Welcome %1',
    browser: 'You are using %{browser}.',
    logout: 'Logout',
    count: {
      1: 'There is 1 user online.',
      n: 'There are %1 users online.'
    }
  }
});

let t = x18n.t;
t('user.logout'); // 'Logout'
t('user.greeting', 'John'); // 'Welcome John'
t('user.browser', {browser: 'Chromium'}); // 'You are using Chromium.'

t('user.count').plural(1); // 'There is 1 user online.'
t('user.count').plural(2); // 'There are 2 users online.'

x18n.on(['lang:change', 'dict:change'], function () {
  // Update the UI
});

Features

  • Auto detects the user language.
  • Straightforward interpolation and pluralisation.
  • Super easy to use with React
  • If you don't use React: An event system that enables you to easily re-render the UI when new translations are added or the language changes.
  • If a translation is missing x18n will choose a translation from a similiar locale, will save missing translations in an accessible object and will fire an event.
  • r18n compatible interpolation and pluralisation: All you need to do to use your r18n local dictionaries in x18n is to convert them from YAML to JSON and to register the objects.

Wiki entries

Adapters

X18n has no opinion about views. Because of this the x18n core stays small. Adapters are x18n extensions that are responsible for updating the view when translations change.

The idea is that you are only responsible for registering translations, optionaly defining the user's language and adding data bindings to your HTML elements. The adapter will then update your HTML whenever the language changes or the dictionary is updated.

Currently there are adapters available for:

TypeScript

There's a TypeScript adapter available at anwfr/x18n-ts.