No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
.gitignore
README.md
package.json
tml-angular2.ts
tsconfig.json
typings.json
webpack.config.js

README.md

TML for Angular2

Build Status Coverage Status

This adds angular2 directives and services that allow you to perform seamless and advanced translations using TML from TranslationExchange.

Learn more about TML

Requirements

  • Angular2
  • TranslationExchange account

Getting started

Get it from NPM

npm install tml-angular2

Include it in your angular app

//--- main.ts ---

//import the init 
import {init} from "tml-angular2";

import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { enableProdMode } from '@angular/core';
import { AppModule } from './app.module';
if (process.env.ENV === 'production') {
    enableProdMode();
}

//init tml.js
init({
    key: "YOUR_APP_KEY",
    onLoad: function(app: any) {
        
        //bootstrap angular app after tml starts
        platformBrowserDynamic().bootstrapModule(AppModule);
    }
});

//--- app.module.ts ---

import { NgModule } from '@angular/core';
import { BrowserModule }  from '@angular/platform-browser';

//import the main module
import {TmlAngularModule} from "tml-angular2";

//add it to your module imports
@NgModule({
    imports: [
        BrowserModule,
        TmlAngularModule,
        // more modules
    ],
    declarations: [
      // ...
    ]
})

export class AppModule { }

Usage

Translation Examples:

Plain string:

<h1 tmlTr>Hello World</h1>

<h1 tmlTr="Hello World"></h1>

Variable:

// greetings: { hello: "Hello World", goodbye: "Bye now!" }
<h1 [tmlTr]="greetings.hello"></h1>

<h1 tmlTr>{{greetings.goodbye}}</h1>

With token data:

<h1 tmlTr [tmlValues]="{ user: user.name }">Welcome {user}</h1>

<div class="birthday" tmlTr [tmlValues]="{ name: user.name, age: user.age }">
  Happy birthday {name}, you're now {age} years old 
</div>

Mixed interpolation and token data:

//data:
ingredient: { quantity: 2, measurements: 'tablespoon', name: 'minced garlic' }

//template:
<h1 [tmlValues]="{ count: ingredient.quantity }" 
 tmlTr="{ count || {{ingredient.measurements}} } {{ingredient.name}}"></h1>

//translators see:
{count || tablespoon} minced garlic 

//result:
<h1>2 cups minced garlic</h1>

Phrase description

The description of a phrase is not mandatory, but it should be used in cases when the label alone is not sufficient enough to determine the meaning of the sentence being translated. As a general rule, you should always provide description to words, phrases and sentences that are only meaningful within a specific context. TML uses label and description together to create a unique key for each phrase. The description serves two purposes: it creates a unique key for each label and it also gives a hint to the translators for the context in which the label is used.

<h3 tmlTr tmlDescription="Link to invite your friends to join the site">Invite</h3>

<span tmlTr="Invite" tmlDescription="An invitation you received from your friend"></span>

Simple string translation with a pipe (for attributes, alts, titles)

<img alt="{{ 'amazing art' | trl }}" src="amazing-art.jpg" />

<input name="username" placeholder="{{ 'Enter username' | trl }}" />

Pipe with token data

<input type="number" name="age" 
 min="{{limits.minimalAge}}" 
 placeholder="{{ 'Enter your age (must be over {age})' | trl:{ age: limits.minimalAge }}" />

Pipe with token data and description

<input type="number" name="age" 
 min="{{limits.minimalAge}}" 
 placeholder="{{ 'Enter your age (must be over {age})' | trl:'Person age in years':{ age: limits.minimalAge }}" />

JS API

There is an injectable service called TranslateService which exposes some useful methods:

Current language:

currentLanguage() : Language

Change language by locale:

changeLanguage(locale: string, callback:Function<Language>)

Is the currently selected language right-to-left:

isRtl() : boolean

Translate string:

translate(label: string) : string

translate(label: string, description: string) : string

translate(label: string, description: string, values: {[key: string]: any}) : string

Language change event:

languageChanged$ : EventEmitter<Language>

//in your component
import {TranslateService} from "tml-angular2";

constructor(translateService: TranslateService) {
    
    translateService.currentLanguage();
    // { locale: 'en', native_name: 'English',  .... }
    
    translateService.isRtl();
    // false
    
    translateService.translate("Hello World");
    // Hello World
    
    translateService.changeLanguage('ru', (language) => {
      console.log(language);
      // {locale: 'ru', native_name: 'Русский', .... }
       
      translateService.translate("Hello World");
      // Привет Мир
    }
    
    translateService.languageChanged$.subscribe(language => { 
      console.log(language)
      // {locale: 'ru', native_name: 'Русский', .... }
    });

}

Links

Copyright and license

Copyright (c) 2016 Translation Exchange, Inc

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.