voo-i18n-es5 v1.0.1

vue-i18n-es5

Forked from https://github.com/MattyRad/vue-i18n

A small package for implementing translations in Vue.js. Instead of using a dot based key to fetch a translated string, it just uses the default string itself as the key.

In short {{ $t('Hello world') }} instead of {{ $t('messages.hello_world') }}.

Better yet: {{ 'Hello world' | translate }}

There are trade-offs to doing it this way:

Pros:

• Dead simple code
• Falling back to the default locale easy, requires no extra logic
• HTML retains the full language context instead of referring back and forth to translation keys

Cons:

• Large strings are unwieldy
• Small changes (like capitalization) are not recognized
• Changing strings in the default locale will require updates in all language files (technically necessary anyway, as the copy has changed)

Installation

npm install voo-i18n-es5

var Vue = require('vue');
var i18n = require('voo-i18n-es5');

var translations = {
	'es': {
		'Hello world': 'Hola Mundo'
	},
	'fr': {
		'Hello world': 'Bonjour le monde'
	},
	'pirate': {
		'Hello world': 'Land ho!'
	}
};

Vue.use(i18n, translations)

Usage

Set a default locale in the root data of your application.

<template>
	<h1>{{ 'Hello world' | translate }}</h1>
</template>

<script>
    module.exports = {
        data: function() {
            return {
                locale: 'en'
            }
        }
    }
</script>

And then the translations will be reactive to changes in the locale value.

Override locale

You can override the root locale by passing in the locale param

<h1>{{ $t('Hello world', { locale: 'es' }) }}</h1>

Fallback locales

Localization carries the problem of different languages having different dialects. For example, french vs. canadian french. You can make distinctions as such:

exports.default = {
    'fr': {
        'Hello world': 'Bonjour le monde',
        'Goodbye': 'Au Revoir'
    },
    'fr_CA': {
        'Hello world': 'Bonjour tout le monde, du Canada'
    }
};

When the locale is set to fr_CA, {{ 'Goodbye' | translate }} still translates to 'Au Revoir'. You can also use a hyphen instead of an underscore if you prefer: fr-CA.

Variable arguments

Don't do this

<p>{{ 'You have used' | translate }} {{ count }} {{ 'out of' | translate }} {{ limit }}</p>

'es': {
	'You have used': 'Ha utilizado',
	'out of': 'fuera de'
},

Do this

<p>{{ $t('You have used {count} out of {limit}', {count, limit}) }}</p>

'es': {
	'You have used {count} out of {limit}': 'Ha utilizado {count} de los {limit}'
},

Inline HTML

It's often the case that your sentences will not form nice little compartmentalized strings like Hello world. Often you'll get HTML spliced in the middle.

Don't do this

    <p>{{ 'Please perform' | translate }} <a href="#" @click.prevent="action">{{ 'this action' | translate }}</a> {{ 'to complete the task' | translate }}</p>

'es': {
	'Please perform': 'Por favor, realice',
	'this action': 'esta acción',
	'to complete the task': 'para completar la tarea'
},

Do this

<p v-locale="$root.locale" key="Please perform |this action| to complete the task">
    <span></span>
    <a href="#" @click.prevent="action"></a>
    <span></span>
</p>

'es': {
	'Please perform |this action| to complete the task': 'Por favor, realice |esta acción| para completar la tarea'
},

Important:

The directive element only expects to have children 1 level deep. So <span v-locale="es" key="a|b"><a><b></b></a></span> will incorrectly render as <span><a>a</a></span>. I haven't found an elegant solution around this yet. The main goal of this repo is to retain lingual context in translations and logical context in components, so it's an acceptable sacrifice for the time being, but if you have a solution please notify me.

All Together Now!

<div v-locale="$root.locale" key="Thanks for signing up! Confirm |{email} is correct| to continue to the site." :replace="{ email: email }">
    <span></span>
    <a href="#" @click="confirm"></a>
    <span></span>
</div>

'es': {
	'Thanks for signing up! Confirm |{email} is correct| to continue to the site': 'Gracias por registrarte! Confirmar |{email} es correcta| para continuar al sitio'
},