angular-i18n-module

An easy to use, optimized, and solid library to internationalize your AngularJS frontend

Added by: Sam Deering

GitHub

Repository

loicortola/angular-i18n-module

Stats

Stars: 4

Watchers: 4

Forks: 2

Module Description

Angular i18n module

=================================================

A simple to use and effective AngularJS library to translate your app

This repo is for distribution on bower. Please file issues and pull requests against that repo.

Install


Install with bower:

bower install angular-i18n-module

Add a <script> to your index.html:

<script src="/bower_components/angular-i18n-module/angular-i18n-module.js"></script>

Add i18n as a dependency for your app (in the app module declaration line) in your main Angular app.js, and configure your locale resources: NB: You need to put at least one resource named "default"

var app = angular.module('app', ['myModule1', 'myModule2 ', 'myModule3', 'i18n']);

var i18n = angular.module('i18n');
  i18n.config(['i18nServiceProvider', function(i18nServiceProvider) {
      //Set Locales for service
      i18nServiceProvider.setLocales({
        'default': '../../i18n/resources-locale_en_US.json',
        'en': '../../i18n/resources-locale_en_US.json',
        'fr': '../../i18n/resources-locale_fr.json',
        'es': '../../i18n/resources-locale_es.json'
    }, true);
  }]);

Simply inject the angular i18nService in any of your Angular controllers:

app.controller('MainCtrl', ['$scope', 'i18nService', function MainCtrl($scope, i18nService) {
    //Your controller code here
}]);

Documentation


Features

  • Translate keywords with any number of parameters
  • Handle plural/singular values
  • Handle conditional messages
  • Handle multi parameter messages
  • Handle messages with html content
  • Only load the current language
  • Easy asynchronous locale load
  • Directive to enable any element to change the locale

API

###i18nService

####getString( key , args )

| Parameter | Description | |:-----------------------|:----------------------------------------------------------------------------------------------| | key | String representing the key of the locale string you are looking for | | args | Could be none, one, multiple values or JSON objects supplied as arguments of the string chain |

returns The locale resource if the resource exists, the key string otherwise

Example var myString = getString('label.hello.world'); var myString2 = getString('message.game.over',36532,'Loic');

####isLocaleEmpty()

returns true if the locale has been set previously, false otherwise

####selectLanguage( language )

| Parameter | Description | |:-------------|:----------------------------------------------------------------------------------------------------| | language | String representing the desired language. Should match the format of the RFC 3066 specification |

If there is a locale resource with a name matching the parameter (ex: example_locale_XX.json or other_example_XX_YY.json), the matching locale will be loaded asynchronously, and will recompute the entries in a $digest(). Otherwise, the fallback will be to load the locale with the key 'default' N.B.: The selectLanguage method returns a promise allowing you to add custom behaviours in case of success, error, or after the operation has returned. Example selectLanguage('en_US'); selectLanguage('en_US').then(function(locale) {console.log('locale ' + locale + 'was loaded successfully');})};

####setLocales( locales , select )

| Parameter | Description | |:------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | locales | A JSON object with 'key': 'value' pairs. key being the RFC 3066 string representing the language (or default), and value the path of the json resource file | | select | Boolean (optional) |

Sets the custom locales into the i18n module. If the second argument is set and is true, it triggers the selectLanguage() method with the default environment language of the user (browsers language).
This method should not be called by anything else than the Service Provider. Example

setLocales({
      'default': '../i18n/resources-locale_en_US.json',
      'en': '../i18n/resources-locale_en_US.json',
      'fr': '../i18n/resources-locale_fr.json',
      'es': '../i18n/resources-locale_es.json'
    }
  });

Usage, concrete overview

###A. Sample JSON

Consider the following json files

resources_locale_en_US.json

{
  "label.hello.world": "Hello world!",
  "label.users.connected": {
    "one": "You currently have one (that means only {}) user connected",
    "zero": "You have no users connected",
    "default": "You have {} users connected"
  },
  "message.story.beginning": "This is the story of {firstCharacter} who called his friend {secondCharacter} to tell him if he could give {thirdCharacter} a ride to the airport. Problem is, {secondCharacter}'s phone was on voicemail, and {firstCharacter} did not have a car.",
  "message.story.end": "So {1} told {3} that he would have to drive there by himself, and apologized on behalf of {2}",
  "message.feedback": {
    "true": "We are glad you liked the story",
    "false": "So sorry to hear you did not like the story!"
  },
  "message.with.html": "I <b>LOVE</b> \"rock & roll\" so <i>(put the rest here...)</i>"
}

resources_locale_fr.json

{
  "label.hello.world": "Salut le monde!",
  "label.users.connected": {
    "one": "Vous n'avez actuellement qu'un utilisateur connecté (et {} seul)",
    "zero": "Personne n'est connecté",
    "default": "Vous avez {} utilisateurs connectés"
  },
  "message.story.beginning": "C'est l'histoire de {firstCharacter} qui appelle son ami {secondCharacter} pour lui demander s'il peut emmener {thirdCharacter} à l'aéroport. Le problème, c'est que le téléphone de {secondCharacter} est sur messagerie, et que {firstCharacter} n'a pa de voiture.",
  "message.story.end": "Finalement {1} a du dire à {3} qu'il devrait y aller par ses propres moyens, et s'excusa de la part de {2}",
  "message.feedback": {
    "true": "Content que vous ayiez aimé l'histoire",
    "false": "Dommage que vous n'ayiez pas aimé l'histoire!"
  }
}

###B. Use in html views

####1. With angular {{ }} statements

Basic call

{{'label.hello.world' | i18n}}

==> Hello world!

Count call

{{'label.users.connected' | i18n:1}}

==> You currently have one (that means only 1) user connected

{{'label.users.connected' | i18n:12}}

==> You have 12 users connected

{{'label.users.connected' | i18n:0}}

==> You have no users connected

Named parameter call

{{'message.story.beginning' | i18n:{'firstCharacter':'John', 'secondCharacter':'Paul', 'thirdCharacter':'Matthew'} }}

==> This is the story of John who called his friend Paul to tell him if he could give Matthew a ride to the airport. Problem is, Paul's phone was on voicemail, and John did not have a car.

Generic parameter call

{{ 'message.story.end' | i18n:'John':'Paul':'Matthew' }}

==> So John told Matthew that he would have to drive there by himself, and apologized on behalf of Paul

Conditional call

{{'message.feedback' | i18n:true }}

==> We are glad you liked the story

{{'message.feedback' | i18n:false }}

==> So sorry to hear you did not like the story!

Call to non existing entry returns the key

{{'this.doesnt.exist' | i18n }}

==> this.doesnt.exist

WARNING: HTML tags cannot be processed the same way as regular strings! See section 2. below

{{'message.with.html' | i18n }}

==> I <b>LOVE</b> "rock & roll" so <i>(put the rest here...)</i>

####2. With ng-bind-html directive (for resources with HTML content)

<span ng-bind-html="'message.with.html' | i18n"></span>

==> I LOVE "rock & roll" so (put the rest here...)

###C. Use in js files

NB: First, you need to inject the i18nService into your angular controller, or service, or filter etc... Then a simple call to getString() will give you what you need

var myStoryBeginning = i18nService.getString(
    'message.story.beginning',
    {
        'firstCharacter':'John',
        'secondCharacter':'Paul',
        'thirdCharacter':'Matthew'
    });
var myStoryEnd = i18nService.getString('message.story.end','John','Paul','Matthew');
var outputMessage = i18nService.getString('message.feedback',true);

Warning: The previous statement is computing a VALUE, therefore no watch is being made in case you decide to change the language.

###D. Add locale-switching buttons

Simply call the directive as a parameter for any element of your html template.

<div i18n-language-selector="'fr'">Click to switch to french</div>
<button i18n-language-selector="'en'">Click to switch to english</button>

###E. OnLocaleLoaded event

To create your own hooks after a locale is successfully loaded, simply listen to the event named 'i18nService.onLocaleLoaded', which is fired on the rootScope.

License


Copyright 2015 Loïc Ortola

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Module stats last updated: 2015-05-28 10:24:41

Disclaimer: Some data on this page may have been gathered from the authors GitHub respository. If you see any mistakes or outdated information please let us know. Thanks!