vue-j7i18n v1.1.2

J7i18n

Vue i18n Plugin by Jera7

Yet another simple i18n plugin for VueJS with no complications

Why another i18n plugin for VueJS?

J7i18n is not the most powerfull and complete i18n solution out there and it is not the goal of it. This plugin tries to achieve just a simple solution for simple translations.

The plugin is to be used with Vue Components

Features

• Small footprint
• Simple install and configuration
• Component scoped translations
• Common/global translations
• Same usage for common and scoped translations
• Single Directive
• Simple methods:
  • Current language computed property
  • changeLanguage()
  • createTranslations()
• 0 dependencies
• Browser local storage for user language preference

New in version 1.1.x

• Translated text modifiers (like VueJS filters)
• Event Bus for global current language state

Installation

npm install vue-j7i18n --save

OR

Download it and put somewhere inside your src folder

yourAppFolder / src / plugins / Vue-J7i18n / index.js

Register Plugin

// Import it in your Main.js
import J7i18n from 'vue-j7i18n'
// OR
import J7i18n from './plugins/Vue-J7i18n'

Vue.use(J7i18n)

Configuration

Common/Global translations

Just pass an object as the second param with the common/global translations accessible by all components

// Main.js

Vue.use(J7i18n, {
  company: {
    en: 'Company Name',
    pt: 'Nome da Empresa'
    fr: '...'
  }
})

Scoped translations

Create translations on component Created Hook. Use the createTranslations() method passing an object

// myComponent.js or Component.vue

export default {
  name: 'myComponent',
  created () {
    this.createTranslations({
      title: {
        en: 'Title',
        pt: 'Título',
        fr: '...'
      },
      description: {
        en: 'A simple description',
        pt: 'Uma descrição simples',
        fr: '...'
      }
    })
  }
}

Usage

Define the container

Can be component's root element or any other element container. This just creates the necessary reactivity when we change the language. For that we use the .language modifier passing the expression: currentLanguage to i18n directive

<template>
  <!-- Use the i18n directive with modifier language -->
  <div id="myComponent-container" v-i18n.language="currentLanguage">

  </div>
</template>

Define elements to be translated

We can define elements to be translated using i18n directive passing the key as an argument. Common/global translations or scoped translations are used exacly the same way.

<template>
  <!-- Use the i18n directive with modifier language -->
  <div id="myComponent-container" v-i18n.language="currentLanguage">
    <!-- Common/global key -->
    <h1 v-i18n:company></h1>
    <!-- Scoped key -->
    <h2 v-i18n:title></h2>
    <p v-i18n:description></p>

  </div>
</template>

Change Language

The initial language is the client/browser default language. After that, the plugin stores the user preference in browser's local storage

<template>
  <!-- Use the i18n directive with modifier language -->
  <div id="myComponent-container" v-i18n.language="currentLanguage">
    <!-- Common/global key -->
    (...)
    <!-- Scoped key -->
    (...)
    <button @changeLanguage('en')>EN</button>
    <button @changeLanguage('pt')>PT</button>
    <button @changeLanguage('fr')>FR</button>

  </div>
</template>

FILTERS

New in version 1.1.0

If you use VueJS filters for simple text transformation inside your html elements like this:

  <p>{{my text | toUpperCaseFilter}}</p>

and want to use J7i18n, just keep reading...

Since J7i18n substitutes element´s inner html, you can't use VueJS filters the classic way.

BUT FEAR NOT

Because in version 1.1.x, J7i18n, has builtin the most common text transformations that you can use as a directive modifier.

The valid modifiers you can use for text transformation are:

• lowercase

  my translation text

• uppercase

  MY TRANSLATION TEXT

• capitalize

  My translation text

• titlecase

  My Translation Text

Using filters

<template>

  <div id="myComponent-container" v-i18n.language="currentLanguage">

    <!-- Use the modifiers after translation Key argument -->

    <h1 v-i18n:title.titlecase></h1>      <!-- My Translation Text -->
    <h2 v-i18n:subTitle.capitalize></h2>  <!-- My translation text -->
    <p v-i18n:description.lowercase></p>  <!-- my translation text -->
    <h4 v-i18n:important.uppercase></h4>  <!-- MY TRANSLATION TEXT -->

  </div>
</template>

Extra Notes

Since J7i18n substitutes element's inner HTML, you can put html tags inside your translation string like this: en: '<strong>Bold</strong> people go far. See them <a href="link_to_bold_people_list"><strong>HERE</strong></a>' It just works!!! J7i18n uses an event bus to communicate current language state between components. This way we can put the changeLanguage() logic inside a, let's say, MainMenu component, and it will update all other components instantly.

Thank you for using and testing J7i18n

Found a Bug? Or a problem...

Please, feel free to open an issue!