mehrsprachig v1.0.1

mehrsprachig

The simplest way to make your app speak several languages. 🗣

"Mehrsprachig" is the German word for multilingual. So as you might've already guessed, this package allows you to add several localizations to your app or website in just the blink of an eye. It will make your creation mehrsprachig, so to speak.

Installation

Install it via yarn add mehrsprachig or npm i mehrsprachig and use it as follows:

import mehrsprachig from 'mehrsprachig';

mehrsprachig();

<button data-mehrsprachig-trigger="de" data-mehrsprachig="german">
  Wechsel auf Deutsch
</button>

<button data-mehrsprachig-trigger="en" data-mehrsprachig="english">
  Switch to English
</button>

If that whole module bundling stuff is not your thing, don't worry! Add <script src="https://unpkg.com/mehrsprachig"></script> at the end of your document body instead.

Configuration

mehrsprachig accepts an options parameter, an object, containing the following (optional) props:

selector

Type: string (CSS selector) Default: '[data-mehrsprachig]'

Is used to identify all the nodes that should be translated.

trigger

Type: string (CSS selector) Default: '[data-mehrsprachig-trigger]'

The nodes matching this selector will be attached a click event listener, triggering the change of the current language to whatever the attribute value of the selector is.

fallback

Type: string Default: 'en'

The language that gets fetched if no localStorage item has been found. Schould match one of the keys of sources.

sources

Type: object Default: {}

An object containing key-value pairs pointing to the endpoints (URLs) of where the localizations can be consumed from.

Localizations

By "localization" I mean an object containing all of your translated texts in one specific language. Heres an example config for German, de, and English, en:

mehrsprachig({
  sources: {
    de: 'https://domain.io/api/de',
    en: 'https://domain.io/api/en'
  }
});

// https://domain.io/api/de
{
  "greeting": "Hallo, Welt!",
  "question": "How are you?"
}

// https://domain.io/api/en
{
  "greeting": "Hello, world!",
  "question": "How are you?"
}

You'll need to structure all your localizations the same way, so that mehrsprachig can easily and efficiently search through them.

Can it manipulate attributes?

You betcha! If you want mehrsprachig to localize the content attribute of some meta tag in the document head, for example, you totally can!

<meta name="description" data-mehrsprachig="content=meta.description">

What if i need to use HTML?

mehrsprachig's got you covered! If you have a <p> with an <strong> inside it, you might find it's a bit complicated to translate everything separately. So just write HTML as you would normally! But make sure to add prefix your localization key with html:. This will look like so:

<p data-mehrsprachig="html:footer.paragraphWithAnchor"></p>

{
  "footer": {
    "paragraphWithAnchor": "I contain <strong>HTML</strong>, yo!"
  }
}

Events

mehrsprachig emits a mehrsprachigTranslated event on the element it just translated. It contains localeKey, element, propertyToLocalize, localizedPropertyValue in its detail prop.

document.addEventListener('mehrsprachigTranslated', event => {
  console.log(`the language has been switched to ${event.detail.localeKey}!`);
});

License

MIT