itopplus-ngx-translate-multi-http-loader
v16.0.0
Published
Downloads
25
Maintainers
Readme
@ngx-translate/multi-http-loader
A loader for ngx-translate that loads translations using http.
Angular 14 example: https://stackblitz.com/edit/ngx-translate-multi-http-loader-sample-2clau3?file=src/app/app.module.ts
Angular 6 example: https://stackblitz.com/edit/ngx-translate-multi-http-loader-sample
Get the complete changelog here: https://github.com/rbalet/ngx-translate-multi-http-loader/releases
breaking change: v9.0.0
- This library is now using
httpBackend
instead of thehttpClient
, to avoid being delayed by interceptor, which was creating errors while loading. - From the v9, the library will only be using a list of
string[]
soprefix
&suffix
aren't needed anymore and.json
gonna be the default suffix.
Installation
We assume that you already installed ngx-translate.
Now you need to install the npm module for MultiTranslateHttpLoader
:
npm install ngx-translate-multi-http-loader --save
Choose the version corresponding to your Angular version:
| Angular | @ngx-translate/core | ngx-translate-multi-http-loader | | ------- | ------------------- | ------------------------------- | | 14 | 14.x+ | 8.x+ | | 13 | 14.x+ | 7.x+ | | 6 | 10.x+ | 1.x+ |
Usage
The MultiTranslateHttpLoader
uses HttpBackend to load translations, therefore :
- Create and export a new
HttpLoaderFactory
function - Import the
HttpClientModule
from@angular/common/http
- Setup the
TranslateModule
to use theMultiTranslateHttpLoader
import {NgModule} from '@angular/core';
import {BrowserModule} from '@angular/platform-browser';
import {HttpClientModule, HttpBackend} from '@angular/common/http';
import {TranslateModule, TranslateLoader} from '@ngx-translate/core';
import {MultiTranslateHttpLoader} from 'ngx-translate-multi-http-loader';
import {AppComponent} from './app';
// AoT requires an exported function for factories
export function HttpLoaderFactory(_httpBackend: HttpBackend) {
return new MultiTranslateHttpLoader(_httpBackend, ['/assets/i18n/core/', '/assets/i18n/vendors/']);
}
@NgModule({
imports: [
BrowserModule,
HttpClientModule,
TranslateModule.forRoot({
loader: {
provide: TranslateLoader,
useFactory: HttpLoaderFactory,
deps: [HttpBackend]
}
})
],
bootstrap: [AppComponent]
})
export class AppModule { }
The MultiTranslateHttpLoader
takes a list of string[]
or ITranslationResource[]
.
String[]
For example ['/assets/i18n/core/', '/assets/i18n/vendors/']
,
will load your translations files for the lang "en" from : /assets/i18n/core/en.json
and /assets/i18n/vendors/en.json
Custom suffix
For now this loader only support the json
format.
Instead of an array of string[]
,
you may pass a list of parameters:
prefix: string = '/assets/i18n/'
suffix: string = '.json'
optional: boolean = true
export function HttpLoaderFactory(_httpBackend: HttpBackend) {
return new MultiTranslateHttpLoader(_httpBackend, [
{prefix: './assets/i18n/core/', suffix: '.json'},
{prefix: './assets/i18n/vendors/'}, // , "suffix: '.json'" being the default value
{prefix: './assets/i18n/non-existent/', optional: true}, // Wont create any log
]);
}
The loader will merge all translation files from the server using deepmerge-ts.
Authors and acknowledgment
- maintainer Raphaël Balet
- Former maintainer Dennis Keil