react-translate-maker

React translation module. Internationalize your great project. This library is part of translate-maker.
Star this project on [GitHub][github-url].

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]

[npm-image]: https://img.shields.io/npm/v/react-translate-maker.svg?style=flat-square
[npm-url]: https://www.npmjs.com/react-translate-maker
[travis-image]: https://img.shields.io/travis/CherryProjects/react-translate-maker/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/CherryProjects/react-translate-maker
[coveralls-image]: https://img.shields.io/coveralls/CherryProjects/react-translate-maker/master.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/CherryProjects/react-translate-maker?branch=master
[github-url]: https://github.com/CherryProjects/react-translate-maker

Installation

Install via npm.

``sh
npm install react-translate-maker
`

Versions

If you are using react >= 15.4.0 use version >= 0.3.0 otherwise use version < 0.3.0




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
- Nested and reference translations
- Variables
- Conditioned translations (Plural, Gender etc...)
- Filters capitalize, upperCase, lowerCase etc... and custom filters
- Default translations
- Integrates with React and Angular
- Automatic extraction of translations from your project
- For more details and examples click on translate-maker

Support us

Star this project on [GitHub][github-url].

Usage

$3

`js
import React from 'react';
import Translate, { LocaleProvider, TranslateMaker } from 'react-translate-maker';

const translate = new TranslateMaker({
data: {
en_US: {
hello: 'Hello {$user.name}',
followers: {$user.name} has {$user.followers, plural,
zero {no followers}
one {# follower}
{# followers}
}
}
}
});

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

React.render(





);
`

The result will be


`html



`

$3

If you want to load localisation files automatically with the require function you can use File adapter.

#### File structure

`
project
│ component.jsx
└──locales
│ en_US.js
`

#### en_US.js

`js
export default {
gender: {$gender, select, male {boy} female {girl}},
working: {gender, $user1.gender as gender | capitalize} {$user1.name} is working with
{gender, $user2.gender as gender} {$user2.name}
};
`

#### component.jsx

`js
import React from 'react';
import Translate { LocaleProvider, TranslateMaker, Gender, FileAdapter } from 'react-translate-maker';
import path from 'path';

const translate = new TranslateMaker({
adapter: new FileAdapter({
path: path.join(__dirname, '/locales'),
});
});

const currentLocale = 'en_US';

const user1 = {
gender: Gender.MALE,
name: 'Zlatko',
};

const user1 = {
gender: Gender.FEMALE,
name: 'Livia',
};

React.render(



);
`

The result will be


`html
Boy Zlatko is working with girl Livia
`

$3

If you want to use webpack with file adapter you need to use own function getFile. You need to use getFile instead of path because you need to change the webpack context.

#### component.jsx

`js
import React from 'react';
import Translate { LocaleProvider, TranslateMaker, Gender, FileAdapter } from 'react-translate-maker';

const translate = new TranslateMaker({
adapter: new FileAdapter({
getFile: (locale, namespace) => require('./locale/' + locale),
});
});

const currentLocale = 'en_US';

const user1 = {
gender: Gender.MALE,
name: 'Zlatko',
};

const user1 = {
gender: Gender.FEMALE,
name: 'Livia',
};

React.render(



);
`

$3

`js
import React, { Component } from 'react';
import Translate, { LocaleProvider } from 'react-translate-maker';

const currentLocale = 'en_US';
const data = {
en_US: {
inputSearch: 'Search',
},
};

React.render(


{placeholder => (

)}


);
`

The result will be

`html

`

$3

`js
import React, { Component } from 'react';
import { LocaleProvider, ProvideTranslate } from 'react-translate-maker';

class MyComponent extends Component {
render() {
const { translate } = this.props;

return (

);
}
}

const currentLocale = 'en_US';
const data = {
en_US: {
inputSearch: 'Search',
},
};

React.render(


{translate => (

)}


);
`

The result will be

`html

`

$3

Sometimes when you are using dot notation you can stack with long paths. For example: header.navigation.button.login. You can use component named Namespace which will help you to simplify your jsx file.

`js
import React from 'react';
import Translate { LocaleProvider, Namespace } from 'react-translate-maker';

const currentLocale = 'en_US';
const data = {
en_US: {
header: {
navigation: {
title: 'MyProject',
button: {
login: 'Log In',
signup: 'Sign Up',
},
},
},
},
};

React.render(







);
`

$3

`js
import React from 'react';
import Translate { LocaleProvider, Namespace } from 'react-translate-maker';

const currentLocale = 'en_US';
const data = {
en_US: {
header: {
navigation: {
title: 'MyProject',
button: {
login: 'Log In',
signup: 'Sign Up',
},
},
},
},
};

React.render(








);
`

$3

Sometimes you need to provide HTML content.

`js
import React from 'react';
import { LocaleProvider, Translate } from 'react-translate-maker';

const currentLocale = 'en_US';
const data = {
en_US: {
welcome: 'Welcome back {$user}. How is it going?',
},
};

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

React.render(

path="welcome"
params={{
user: {user.name}
}} />

);
`

The result will be

`html
Welcome back Zlatko. How is it going?
`

$3

We are providing a component for the locale switch. It is a select with everything what do you need.
You can use it in two ways. Here is first example.

`js
import React, { Component } from 'react';
import Translate { LocaleProvider, LocaleSwitch } from 'react-translate-maker';

const data = {
en_US: {
language: 'Language',
button: {
login: 'Log In',
signup: 'Sign Up',
},
},
sk_SK: {
language: 'Jazyk',
button: {
login: 'Prihlasit sa',
signup: 'Odhlasit sa',
},
},
};

const locales = [{
label: 'English',
value: 'en_US',
}, {
label: 'Slovenčina',
value: 'sk_SK',
}];

const DEFAULT_LOCALE = 'en_US';

class App extends Component {
constructor(props, context) {
super(props, context);

this.state = {
locale: DEFAULT_LOCALE,
};
}

handleLocaleChange(locale) {
this.setState({
locale: locale,
});
}

render() {
const { data, locales } = this.props;
const currentLocale = this.state.locale;

return (



);
}
}

React.render();
`

As you can see in previous example. We are using onChange event. The main reason for that is that LocaleProvider is a controlled component. That means if you wanted to change property named locale of the LocaleProvider you need to change it directly in the render function.

If you want to use LocaleProvider as uncontrolled component you can do that. But all properties of the LocaleProvider will be used only as initialisation properties. Here is a second example (please take a loon on the property named controlled of the LocaleProvider).

`js
import React, { Component } from 'react';
import Translate { LocaleProvider, LocaleSwitch } from 'react-translate-maker';

const data = {
en_US: {
language: 'Language',
button: {
login: 'Log In',
signup: 'Sign Up',
},
},
sk_SK: {
language: 'Jazyk',
button: {
login: 'Prihlasit sa',
signup: 'Odhlasit sa',
},
},
};

const locales = [{
label: 'English',
value: 'en_US',
}, {
label: 'Slovenčina',
value: 'sk_SK',
}];

const DEFAULT_LOCALE = 'en_US';

class App extends Component {
render() {
const { data, locales } = this.props;
const currentLocale = this.state.locale;

return (



);
}
}

React.render();
`

The main difference is that you are not able to change locale of the LocaleProvider with property named locale after first render.

#### Properties of the LocaleSwitch

- onChange (function): Callback witch a new locale (immediate change)
- onLocaleChange (function): Callback witch a new locale (after success change)
- setLocale (Boolean): It will set locale automatically in the translate-maker after change (default: true)
- locales (array): Array of the available locales. [{ label: 'English', value: 'en_US' }]
- all properties of the standard select component




$3

Sometimes you need to provide HTML content.

`js
import React from 'react';
import Translate, { LocaleProvider } from 'react-translate-maker';

const currentLocale = 'en_US';
const data = {
en_US: {
welcome: 'Welcome {$user.name | star}',
},
};

const filters = {
star: function star(value) {
return ' ' + value + ' ';
},
};

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

React.render(



);
`

The result will be

`html
Welcome Zlatko
`

$3

- locale (String): Current locale ID (default null)
- locales (Array): List of available locales IDs (default null)
- cache (Instance of Cache): Cache of the translations (default MemoryCache)
- adapter (Instance of Adapter | data): Adapter provides translations (default see option defaultAdapter)
- defaultAdapter (Class of Adapter): Default adapter (default MemoryAdapter)
- dotNotation (Boolean): You can turn of dot notation. This is useful if you are using PO translation files (default true)
- mode (Enum): You can use full compatible ICU version with Mode.ICU. After that you can use external variables witout dolar character (Default Mode.MAIN)
- references (Boolean): You can turn on/off references. (Default true)
- variables (Boolean): You can turn on/off variables. (Default true)
- combinations (Boolean): You can turn on/off combinations. (Default true)
- defaultValue (Function): What you will see for missing translations (Default (path, attrs) => Missing default translation for: ${path})
- filters (Object): Object with custom filters
- controlled (Boolean): You can set component as uncontrolled (default true). More information.

$3

Please take a look on translate-maker

Roadmap

- [ ] Locales property of the LocaleSwitch can be an object
- [ ] Locales property of the LocaleSwitch can be autopopulated from the adapter
- [ ] Locales property of the LocaleSwitch can be translated automatically by translate-maker

Support us

Star this project on [GitHub][github-url].

Running Tests

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

`sh
npm install
`

Then run the tests:

`sh
npm test
``