npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ngx-locutus

v1.0.1

Published

The alternative internationalization (i18n) library for Angular

Downloads

19

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

For a quick demo, please have a look at the GitHub repository: https://github.com/HaasStefan/ngx-locutus 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:

<ng-container *locutus="let t of 'scope1'">
  {{t.title}}
</ng-container>

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');