@flix-tech/stencil-i18n
npm i @flix-tech/stencil-i18n

@flix-tech/stencil-i18n

static translations for stenciljs

by flix-tech

0.0.7 (see all)License:MITTypeScript:Not Found
npm i @flix-tech/stencil-i18n
Readme

Build Status

Static translations (Stencil plugin)

Generating staticly translated bundles.

Getting started

npm i @flix-tech/stencil-i18n

configure it in stencil.config.js

const { i18n } = require('@flix-tech/stencil-i18n');

...

plugins: [
    ...,
    i18n({
      functionName: 'i18n', // default value is i18n
      dictionaryPath: 'src/i18n',
      srcPath: 'src' // default value is src
    })
  ]

Create the dummy function inside src folder to satisfy typescript and have a fallback.

export function i18n(key: string, params?: { [index: string]: string | number }): string {
  return key;
}

Put the translation files messages.${locale}.json into the dictionaryPath like specified in the stencil config. Configure the build task in your package.json similar to the following.

"build": "for lang in en de; do i18n_locale=$lang stencil build && mkdir -p dist-build/$lang && mv dist/* dist-build/$lang; done && mv dist-build/* dist/ && rm -R dist-build"

Be sure to put the i18n_locale environment variable containing the same as messages.${locale}.json locale. Use the function you defined in functionName to translate. Import the dummy function defined before.

const param3 = 'bye';
...
i18n('TRANSLATION.KEY', {
    param1: 1234,
    param2: 'hello',
    param3
});

Angular

To include the resulting components into your angular project do a dynamic import in the app component to have the components in the whole project but be able to also access the LOCALE_ID. YOUR_COMPONENT_NAME can be the npm name @scope/package.

import { Component, Inject, LOCALE_ID } from '@angular/core';

@Component({
  selector: 'app',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.scss'],
})
export class AppComponent {
  constructor(@Inject(LOCALE_ID) locale: string) {
    import(`<YOUR_COMPONENT_NAME>/dist/${locale}/loader`).then((webcomponent) => {
      webcomponent.defineCustomElements(window);
    });
  }
}

Downloads/wk

26

GitHub Stars

16

LAST COMMIT

2yrs ago

MAINTAINERS

4

CONTRIBUTORS

3

OPEN ISSUES

2

OPEN PRs

6
VersionTagPublished
0.0.7
latest
2yrs ago
No alternatives found
No tutorials found
Add a tutorial