Skip to content

Latest commit

History

57 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

react-localization

Simple module to localize the React interface using the same syntax used in the ReactNativeLocalization module.

How it works

The library uses the current interface language, then it loads and displays the strings matching the current interface locale or the default language (the first one if a match is not found) if a specific localization can't be found.

It's possible to force a language different from the interface one.

##Installation npm install --save react-localization

Usage

In the React class that you want to localize require the library and define the strings object passing to the constructor a simple object containing a language key (i.e. en, it, fr..) and then a list of key-value pairs with the needed localized strings.

\\ES6modulesyntaximportLocalizedStringsfrom'react-localization';letstrings=newLocalizedStrings({en:{how:"How do you want your egg today?",boiledEgg:"Boiled egg",softBoiledEgg:"Soft-boiled egg",choice:"How to choose the egg"},it: {how:"Come vuoi il tuo uovo oggi?",boiledEgg:"Uovo sodo",softBoiledEgg:"Uovo alla coque",choice:"Come scegliere l'uovo"}});

Then use the strings object literal directly in the render method accessing the key of the localized string.

<Textstyle={styles.title}>{strings.how}</Text>

API

  • setLanguage(languageCode) - to force manually a particular language
  • getLanguage() - to get the current displayed language
  • getInterfaceLanguage() - to get the current device interface language
  • formatString() - to format the passed string replacing its placeholders with the other arguments strings
  • setContent(props) - to dynamically load another set of strings
 en:{bread:"bread",butter:"butter",question:"I'd like {0} and {1}, or just {0}"}...strings.formatString(strings.question,strings.bread,strings.butter)

Beware: do not define a string key as formatString!

  • getAvailableLanguages() - to get an array of the languages passed in the constructor

Examples

To force a particular language use something like this:

_onSetLanguageToItalian(){strings.setLanguage('it');this.setState({});}

Questions or suggestions?

Feel free to contact me on Twitter or open an issue.

About

Simple module to localize the React interface using the same syntax used in the ReactNativeLocalization module.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages