martinlindhe/laravel-vue-i18n-generator

Generates a vue-i18n compatible include file from your Laravel translations.

About

NO LONGER MAINTAINED, _(*1)

, _(*2)

Laravel 5 package that allows you to share your Laravel localizations with your vue front-end, using vue-i18n or vuex-i18n., _(*3)

Laravel 5.7 notice!

Configuration paths have changed in Laravel 5.7, in order for this package to function properly you need to configure correct paths for jsPath and jsFile in your config\vue-i18n-generator.php., _(*4)

Install the package

In your project: composer require martinlindhe/laravel-vue-i18n-generator --dev, _(*5)

For Laravel 5.4 and below:

For older versions of the framework:, _(*6)

Register the service provider in config/app.php, _(*7)

MartinLindhe\VueInternationalizationGenerator\GeneratorProvider::class,

Next, publish the package default config:, _(*8)

php artisan vendor:publish --provider="MartinLindhe\VueInternationalizationGenerator\GeneratorProvider"

Using vue-i18n

Next, you need to install one out of two supported VueJs i18n libraries. We support vue-i18n as default library. Beside that we also support vuex-i18n., _(*9)

When you go with the default option, you only need to install the library through your favorite package manager., _(*10)

vue-i18n

npm i --save vue-i18n

yarn add vue-i18n

Then generate the include file with, _(*11)

php artisan vue-i18n:generate

Assuming you are using a recent version of vue-i18n (>=6.x), adjust your vue app with something like:, _(*12)

import Vue from 'vue';
import VueInternationalization from 'vue-i18n';
import Locale from './vue-i18n-locales.generated';

Vue.use(VueInternationalization);

const lang = document.documentElement.lang.substr(0, 2);
// or however you determine your current app locale

const i18n = new VueInternationalization({
    locale: lang,
    messages: Locale
});

const app = new Vue({
    el: '#app',
    i18n,
    components: {
       ...
    }
}

For older vue-i18n (5.x), the initialization looks something like:, _(*13)

import Vue from 'vue';
import VueInternationalization from 'vue-i18n';
import Locales from './vue-i18n-locales.generated.js';

Vue.use(VueInternationalization);

Vue.config.lang = 'en';

Object.keys(Locales).forEach(function (lang) {
  Vue.locale(lang, Locales[lang])
});

...

Using vuex-i18n

vuex-i18n

npm i --save vuex-i18n

yarn add vuex-i18n vuex

Next, open config/vue-i18n-generator.php and do the following changes:, _(*14)

- 'i18nLib' => 'vue-i18n',
+ 'i18nLib' => 'vuex-i18n',

Then generate the include file with, _(*15)

php artisan vue-i18n:generate

Assuming you are using a recent version of vuex-i18n, adjust your vue app with something like:, _(*16)

import Vuex from 'vuex';
import vuexI18n from 'vuex-i18n';
import Locales from './vue-i18n-locales.generated.js';

const store = new Vuex.Store();

Vue.use(vuexI18n.plugin, store);

Vue.i18n.add('en', Locales.en);
Vue.i18n.add('de', Locales.de);

// set the start locale to use
Vue.i18n.set(Spark.locale);

require('./components/bootstrap');

var app = new Vue({
    store,
    mixins: [require('spark')]
});

Output Formats

You can specify the output formats from es6, umd, or json with the --format option. (defaults to es6), _(*17)

php artisan vue-i18n:generate --format {es6,umd,json}

Use case example for UMD module

php artisan vue-i18n:generate --format umd

An UMD module can be imported into the browser, build system, node and etc., _(*18)

Now you can include the generated script in the browser as a normal script and reference it with window.vuei18nLocales., _(*19)

// in your js
Vue.use(VueI18n)
Vue.config.lang = Laravel.language
Object.keys(window.vuei18nLocales).forEach(function (lang) {
  Vue.locale(lang, window.vuei18nLocales[lang])
})

You can still require/import it in your build system as stated above., _(*20)

One advantage of doing things like this is you are not obligated to do a build of your javascript each time a the translation files get changed/saved. A good example is if you have a backend that can read and write to your translation files (like Backpack). You can listen to a save event there and call vue-i18n-generator., _(*21)

Generating Multiple Files

Sometimes you may want to generate multiple files as you want to make use of lazy loading. As such, you can specify that the generator produces multiple files within the destination directory., _(*22)

There are two options: 1. One file per laravel module language file using switch --multi 2. One file per locale using switch --multi-locales, _(*23)

php artisan vue-i18n:generate --multi{-locales}

Parameters

The generator adjusts the strings in order to work with vue-i18n's named formatting, so you can reuse your Laravel translations with parameters., _(*24)

resource/lang/message.php:, _(*25)

return [
    'hello' => 'Hello :name',
];

in vue-i18n-locales.generated.js:, _(*26)

...
    "hello": "Hello {name}",
...

Blade template:, _(*27)

<div class="message">
    <p>{{ trans('message.hello', ['name' => 'visitor']) }}</p>
</div>

Vue template:, _(*28)

<div class="message">
    <p>{{ $t('message.hello', {name: 'visitor'}) }}</p>
</div>

Notices

• The generated file is an ES6 module.

The more sophisticated pluralization localization as described here is not supported since neither vue-i18n or vuex-i18n support this., _(*29)

License

Under MIT, _(*30)