README

Translate Maker

Lightweight translation module. Internationalize your great project.

Features

Build on standards (ICU Message syntax, Unicode CLDR), ES6 and promises
Support for 190+ languages
Runs in the browser and Node.js
JSON Structure
Variables and references
Nested objects
Conditioned translations (Plural, Gender, Ordinal etc...)
Filters capitalize, upperCase, lowerCase etc... and custom filters
Default translations and Default references
Resource adapters (Memory, File, XHR)
Cache modules (with support for dehydration / rehydration)
Integrates with React and Angular
Webpack support
Automatic extraction of translations from modules that use react-translate-maker
And much more (functions, object translations etc..)

Support us

Star this project on GitHub.

Installation

Using npm:

$ npm install --save translate-maker

Then with a module bundler like webpack that supports either CommonJS or ES2015 modules, use as you would anything else:

// using an ES6 transpiler, like babel
import Translate from 'translate-maker';

// not using an ES6 transpiler
var Translate = require('translate-maker').Translate;

UMD

The UMD build is also available on unpkg:

<script src="https://unpkg.com/translate-maker/umd/TranslateMaker.min.js"></script>

You can find the library on window.TranslateMaker.

Usage

Basic

import Translate from 'translate-maker';

const t = new Translate();

// add new translation named greeting
t.set('greeting', 'Good morning');

// get translation by key greeting
const result = t.get('greeting');
console.log(result); // => Good morning

Basic set with JSON

You can set translation by (key, value) or like an object

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  greeting: 'Good morning'
});

const result = t.get('greeting');
console.log(result); // => Good morning

External variables

You can use your own variables from your code. Use the dollar syntax { $name }.

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  greeting: 'Good morning {$name}'
});

const result = t.get('greeting', {
  name: 'Zlatko'
});
console.log(result); // => Good morning Zlatko

Nested external variables

Very often is your variable an object for example user can contains firstName and lastName etc...

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  greeting: 'Good morning {$user.firstName} {$user.lastName}'
});

const user = {
  firstName: 'Zlatko',
  lastName: 'Fedor'
};

const result = t.get('greeting', {
  user: user
});
console.log(result); // => Good morning Zlatko Fedor

Functions

You can use functions in external variables

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  greeting: 'Hi {$user.getName}',
});

const user = {
  _name: 'Zlatko',
  getName: function() {
    return this._name;
  }
};

const result = t.get('greeting', {
  user: user
});
console.log(result); // => Hi Zlatko

Object translations

Sometimes you want to translate whole object at once. For example all options for tag select.

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  options: {
    left: 'Go Left',
    top: 'Go Top',
    right: 'Go Right',
    bottom: 'Go Bottom'
  }
});

const options = {
  left: 'options.left',
  right: 'options.right',
};

const result = t.get(options);
console.log(result); // => { left: 'Go Left', right: 'Go Right' }

Reference translation

You can reference other translations in a string by using the brace syntax { name }. There is no dollar.

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  morning: 'morning',
  greeting: 'Good {morning} {$name}'
});

const result = t.get('greeting', {
  name: 'Zlatko'
});
console.log(result); // => Good morning Zlatko

Multiple variants

You can reference other translations in a string by using the brace syntax { name }.

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  dayparts: {
    morning: 'morning',
    afternoon: 'afternoon',
    evening: 'evening'
  },
  greeting: {
    morning: 'Good {dayparts.morning} {$name}',
    afternoon: 'Good {dayparts.afternoon} {$name}',
    evening: 'Good {dayparts.evening} {$name}'
  }
});

const result = t.get('greeting.afternoon', {
  name: 'Zlatko'
});
console.log(result); // => Good afternoon Zlatko

Default variants

You can set one variant as default with underscore "_" at the beginning.

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  dayparts: {
    morning: 'morning',
    afternoon: 'afternoon',
    evening: 'evening'
  },
  greeting: {
    _morning: 'Good {dayparts.morning}',
    afternoon: 'Good {dayparts.afternoon}',
    evening: 'Good {dayparts.evening}'
  }
});

const result = t.get('greeting');
console.log(result); // => Good morning

Default variants for references

You can set default variant for reference too.

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  dayparts: {
    _morning: 'morning',
    afternoon: 'afternoon',
    evening: 'evening'
  },
  greeting: {
    _morning: 'Good {dayparts}',
    afternoon: 'Good {dayparts.afternoon}',
    evening: 'Good {dayparts.evening}'
  }
});

const result = t.get('greeting');
console.log(result); // => Good morning

Default translation

You can use default translation if your translation is missing.

Each translation is available with object notation.

import Translate from 'translate-maker';

const t = new Translate();

const result = t.get('greeting', 'Hi, how are you?');
console.log(result); // => Hi, how are you?

const result2 = t.get('greeting', {
  name: 'Zlatko'
},'Hi {$name}, how are you?');
console.log(result2); // => Hi Zlatko, how are you?

Combination external variables and references

You can use JSON structure as well

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  dayparts: {
    _morning: 'morning',
    afternoon: 'afternoon',
    evening: 'evening'
  },
  greeting: 'Good {dayparts.$daypartVariant} {$user.name}',
});

const user = {
  name: 'Zlatko'
};

const result = t.get('greeting', {
  daypartVariant: 'afternoon',
  user: user
});
console.log(result); // => Good afternoon Zlatko

Escape variable notation

If you want to escape {name} use {name}

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  dayparts: {
    _morning: 'morning',
    afternoon: 'afternoon',
    evening: 'evening'
  },
  greeting: 'Good \\{dayparts.$daypartVariant\\} \\{$user.name\\}',
});

const user = {
  name: 'Zlatko'
};

const result = t.get('greeting', {
  daypartVariant: 'afternoon',
  user: user
});
console.log(result); // => Good {dayparts.$daypartVariant} {$user.name}

Conditional translation

Sometimes you want to show different translation based on Gender or Tense or other enumerable variables. The logic is equivalent to the IF statement. Default option is option without variables. You can use number of variables as you want. In next example we are using variables "past", "future" and default value.

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  run: `{$user.name} {$tense, select,
    past   {ran}
    future {will run}
           {is running}
  }`
});

const user = {
  name: 'Zlatko'
};

const result = t.get('run', {
  tense: 'future',
  user: user
});
console.log(result); // => Zlatko will run

Complex example of the conditional translation

Here is little bit complex gender example where is translation based on two external variables.

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  working: `{$user1.gender, select,
    male   {Boy}
    female {Girl}
  } {$user1.name} is working with {$user2.gender, select,
    male   {boy}
    female {girl}
  } {$user2.name}`,
});

const user1 = {
  gender: 'male',
  name: 'Zlatko'
};

const user2 =  {
  gender: 'female',
  name: 'Livia'
};

const result = t.get('working', {
  user1: user1,
  user2: user2
});
console.log(result); // => Boy Zlatko is working with girl Livia

Combination of the conditional translation and reference translation

As you can see in the example above we are using gender selection twice. We can avoid duplication with reference translation. We are able to send into the nested translation different argments. Please take a look on the keyword "as".

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  gender: `{$gender, select, male {boy} female {girl}}`,
  working: `{gender, $user1.gender as gender} {$user1.name} working with {gender, $user2.gender as gender} {$user2.name}`,
});

const user1 = {
  gender: 'male',
  name: 'Zlatko'
};

const user2 =  {
  gender: 'female',
  name: 'Livia'
};

const result = t.get('working', {
  user1: user1,
  user2: user2
});
console.log(result); // => boy Zlatko is working with girl Livia

Filters

As you can see our two examples above are not same. We have two diferent results:

Boy Zlatko is working with girl Livia
boy Zlatko is working with girl Livia

We need to capitalize first character. For this behavior we have filters. Here is a very simple example

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  greeting: `Hello {$name | uppercase}`,
});

const result = t.get('working', {
  name: 'Zlatko'
});

console.log(result); // => Hello ZLATKO

It is very simple to rewrite our working example

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  gender: `{$gender, select, male {boy} female {girl}}`,
  working: `{gender, $user1.gender as gender | capitalize} {$user1.name} working with {gender,
  $user2.gender as gender} {$user2.name}`,
});

const user1 = {
  gender: 'male',
  name: 'Zlatko'
};

const user2 =  {
  gender: 'female',
  name: 'Livia'
};

const result = t.get('working', {
  user1: user1,
  user2: user2
});
console.log(result); // => Boy Zlatko is working with girl Livia

Plural example

For this task you can use conditional translations as well.

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  followers: `{$user.name} has {$user.followers, plural,
    zero  {no followers}
    one   {{$user.followers} follower}
    other {{$user.followers} followers}
  }`
});

const user = {
  name: 'Zlatko',
  followers: 15,
};

const result = t.get('followers', {
  user: user
});
console.log(result); // => Zlatko has 15 followers

You can use "#" instead of variable. In next example character "#" will equal $user.followers

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  followers: `{$user.name} has {$user.followers, plural,
    zero {no followers}
    one  {# follower}
         {# followers}
  }`
});

const user = {
  name: 'Zlatko',
  followers: 15,
};

const result = t.get('followers', {
  user: user
});
console.log(result); // => Zlatko has 15 followers

Plural function is using module CLDR which can have one of these values based on your current locale:

['zero', 'one', 'two', 'few', 'many', 'other']

or you can use exact value

=1 when value is equal 1 =2 when value is equal 2 =3 when value is equal 3 ...

You can use predefined constant named Plural instead of String representation

import Translate, { Plural } from 'translate-maker';

const t = new Translate();
t.set({
  followers: `{$user.name} has {$user.followers, plural,
    ${Plural.ZERO} {no followers}
    ${Plural.ONE}  {# follower}
                   {# followers}
  }`
});

You can use predefined constant named Gender instead of String representation

import Translate, { Gender } from 'translate-maker';

const t = new Translate();
t.set({
  working: `{$user1.gender, select,
    ${Gender.MALE}   {Boy}
    ${Gender.FEMALE} {Girl}
  } {$user1.name} is working with {$user2.gender, select,
    ${Gender.MALE}   {boy}
    ${Gender.FEMALE} {girl}
  } {$user2.name}`,
});

const user1 = {
  gender: 'male',
  name: 'Zlatko'
};

const user2 =  {
  gender: 'female',
  name: 'Livia'
};

const result = t.get('working', {
  user1: user1,
  user2: user2
});
console.log(result); // => Boy Zlatko is working with girl Livia

Ordinal example

import Translate from 'translate-maker';

const t = new Translate();
t.set({
  takeRight: `Take the {$position, ordinal,
    one {#st}
    two {#nd}
    few {#rd}
        {#th}
  } right`
});

const result = t.get('followers', {
  position: 2
});
console.log(result); // => Take the 2nd right

const result2 = t.get('followers', {
  position: 11
});
console.log(result2); // => Take the 11th right

Filters

You can use one of the predefined filters:

as
camelCase
capitalize
escape
lowerCase
plural
ordinal
select {$gender | select, male {Boy}, female {Girl}, {Girl/Boy}}
trim
trunc {$name | trunc, 6, '...'}
upperCase

Filter is simple function with arguments. We are supporting various argument types. Basic types are fully compatible with JSON. You can use ',' or space beatwean arguments.

null (null)
undefined (undefined)
bool (true, false)
string ('He's cool' or "He's cool")
number (45, -5.2)
references (daytypes.morning)
variables ($user.name)
key value (male {he is boy} or you can use default value without key {is boy or girl})

You can use multiple filters as well. Please use character "|" between filters. First filter can be splitted by comma ",""

t.set({
  'hello': 'Hello {$user.name | trunc, 6 | capitalize}'
});

Next syntax is same:

Hello {$user.name | trunc, 6 | capitalize}
Hello {$user.name | trunc 6 | capitalize}
Hello {$user.name, trunc, 6 | capitalize}
Hello {$user.name, trunc 6 | capitalize}

Own filters

import Translate from 'translate-maker';

function filter(value) {
  return value + '***';
}

const t = new Translate();
t.setFilter('star', filter);

t.set({
  'hello': 'Hello ${name | star}'
});

const result = t.get('hello', {
  name: 'Zlatko'
});

console.log(result); // => Hello Zlatko***

Complex own filter

Each function has 4 fixed arguments. Others are optional.

value (initial value)
part (more information about current filter)
attrs (attributes passed by the user)
metadata (metadata assigned to the current translation)

import trunc from 'lodash/string/trunc';

function truncFilter(value, part, attrs, metadata, length = 30, omission = '...') {
  return trunc(value, {
    length,
    omission,
  });
}

Metadata

Each filter can handle own metadata. For example you can see offset in next plural example. Structure of the metadata is key: value.

import Translate from 'translate-maker';

const t = new Translate();

t.set({
  following: `{$user.name} {$user.followers, plural, offset: 1
    zero {follows nobody}
    one  {follows {$follower.name}}
         {follows {$follower.name} and # others}
  }`
});

const user = {
  name: 'Zlatko',
  followers: 3,
};

const follower = {
  name: 'Livia'
};

const result = t.get('following', {
  user: user,
  follower: follower
});

console.log('result'); // => Zlatko follows Livia and 2 others

Value can be:

null (null)
undefined (undefined)
bool (true, false)
string ('He's cool' or "He's cool")
number (45, -5.2)
references (daytypes.morning)
variables ($user.name)

There is no support for pairs as value.

Differences from the ICU MessageFormat syntax

There is only one difference. External variables have $ prefix. If you want to use full compatible ICU standard you can do that. Set option named mode to ICU. FYI: [combinations][combinations-hash] will stop to work because it is not compatible with ICU standard.

import Translate, { Mode } from 'translate-maker';

const t = new Translate({
  mode: Mode.ICU,
});

t.set({
  following: `{user.name} {user.followers, plural, offset: 1
    zero {follows nobody}
    one  {follows {follower.name}}
         {follows {follower.name} and # others}
  }`
});

const user = {
  name: 'Zlatko',
  followers: 3,
};

const follower = {
  name: 'Livia'
};

const result = t.get('following', {
  user: user,
  follower: follower
});

console.log('result'); // => Zlatko follows Livia and 2 others

Browser compatibility

Internet Explorer 6+

Running Tests

To run the test suite, first invoke the following command within the repo, installing the development dependencies:

npm install

Then run the tests:

npm test

Usage no npm install needed!

README

Translate Maker

Features

Support us

Installation

UMD

Usage

Basic

Basic set with JSON

External variables

Nested external variables

Functions

Object translations

Reference translation

Multiple variants

Default variants

Default variants for references

Default translation

Combination external variables and references

Escape variable notation

Conditional translation

Complex example of the conditional translation

Combination of the conditional translation and reference translation

Filters

Plural example

Ordinal example

Filters

Own filters

Complex own filter

Metadata

Differences from the ICU MessageFormat syntax

Browser compatibility

Running Tests