https://github.com/haasstefan/ngx-locutus

The alternative internationalization (i18n) library for Angular
https://github.com/haasstefan/ngx-locutus

angular i18n translation

Last synced: 8 days ago
JSON representation

The alternative internationalization (i18n) library for Angular

• Host: GitHub
• URL: https://github.com/haasstefan/ngx-locutus
• Owner: HaasStefan
• License: mit
• Created: 2022-05-21T08:15:22.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-05-24T08:16:27.000Z (over 2 years ago)
• Last Synced: 2024-10-07T17:17:38.136Z (about 1 month ago)
• Topics: angular, i18n, translation
• Language: TypeScript
• Homepage:
• Size: 289 KB
• Stars: 9
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# NGX Locutus

- The alternative **Angular Translation Library** used for large scale microfrontend translations. 

- No more worrying about shared translation assets.

- Truly independent translations. 

- Lazy loaded translations.

- Scopes by default.

## Demo

A project named demo is inside the projects folder which should explain the most basic concepts.

## Installation

    npm install ngx-locutus --save

## Usage

### Translation files

Locutus uses Typescript constants as translation files. It is suggested to create an interface definition for each translation and let the explicit translation constant be of the interface type. 

Suggested file structure:

|--assets

|----i18n

|------scope1

|--------en.ts

|--------de.ts

|--------scope1.ts

scope1.ts includes the interface definition for the translation object and also defines an array of TranslationLoaders. It is of big importance that the loaders do reference the translation files in a hardcoded manner such that the files will not be tree-shaken. 

    export const Scope1Loaders: TranslationLoader[] = [

      { de: () => from(import('./de').then(t => t.DE)) },

      { en: () => from(import('./en').then(t => t.EN)) }

    ];

### Import LocutusModule

Call forRoot() in your AppModule and forChild in each feature module. 

- **forRoot** needs an array of TranslationConfiguration consisting of the scope-name, translation-loaders and the active language

- **forChild** needs an array of TranslationConfiguration consisting of the scope-name, translation-loaders 

AppModule Import:

     LocutusModule.forRoot([{

      loaders: Scope1Loaders,

      scope: 'scope1',

      language: 'de'

    }])

Feature Module Import:

    LocutusModule.forChild([{

      scope: 'picard',

      loaders: PicardLoaders

    }])

### Translation API

Use the locutus **directive** to make translations in your template:

    

      {{t.title}}

    

Or use the **pipe**:

    {{ 'title' | locutus:'scope1' | async }}

To interpolate a translation:

    {{ 'title' | locutus:'scope1':'test' | async }}

or: 

    {{ 'title' | locutus:'scope1' | interpolate:'test' | async }}

Or in the **code** using the LocutusService:

To retrieve a specific key in a scope:

    this.title$ = this.locutus.translate('scope1', 'title');

To retrieve an entire scope:

    this.scope1$ = this.locutus.getTranslations('scope1');