moshagency/laravel-vue-i18n-generator

从您的Laravel翻译生成一个与vue-i18n兼容的包含文件。

0.1.48 2023-06-26 09:12 UTC

README

这是一个分支
这是 martinlindhe/laravel-vue-i18n-generator 的分支

Laravel 8 包,允许您使用 Laravel 本地化 与您的 vue 前端共享,使用 vue-i18nvuex-i18n

Laravel 5.7 注意!

Laravel 5.7 中配置路径已更改,为了使此包正常工作,您需要配置 config\vue-i18n-generator.php 中的正确路径 jsPath 和 jsFile。

安装包

在您的项目中: composer require moshagency/laravel-vue-i18n-generator --dev

对于Laravel 5.4及以下版本

对于框架的旧版本

config/app.php 中注册服务提供者

MartinLindhe\VueInternationalizationGenerator\GeneratorProvider::class,

接下来,发布包默认配置

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

使用vue-i18n

接下来,您需要安装两个支持的VueJs i18n库中的一个。我们默认支持 vue-i18n。除此之外,我们还支持 vuex-i18n

如果您选择默认选项,您只需要通过您喜欢的包管理器安装库。

vue-i18n

npm i --save vue-i18n
yarn add vue-i18n

然后使用以下命令生成包含文件

php artisan vue-i18n:generate

假设您正在使用较新版本的vue-i18n(>=6.x),调整您的vue应用程序,例如

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: {
       ...
    }
}

对于较老的vue-i18n(5.x),初始化看起来像这样

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])
});

...

使用vuex-i18n

vuex-i18n

npm i --save vuex-i18n
yarn add vuex-i18n vuex

接下来,打开 config/vue-i18n-generator.php 并进行以下更改

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

然后使用以下命令生成包含文件

php artisan vue-i18n:generate

假设您正在使用较新版本的vuex-i18n,调整您的vue应用程序,例如

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")]
});

输出格式

您可以使用 --format 选项指定输出格式为 es6umdjson。默认为 es6

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

UMD模块的使用案例

php artisan vue-i18n:generate --format umd

UMD模块可以导入浏览器、构建系统、node等。

现在,您可以将生成的脚本作为正常脚本包含在浏览器中,并通过 window.vuei18nLocales 引用它。

<script src="{{ asset('js/vue-i18n-locales.generated.js') }}"></script>

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

您还可以像上面所说的那样在构建系统中require/import它。

这样做的一个优点是,您不必每次翻译文件更改/保存时都进行javascript构建。一个很好的例子是,如果您有一个可以读取和写入翻译文件的后端(如Backpack)。您可以在那里监听保存事件并调用vue-i18n-generator。

生成多个文件

有时您可能想要生成多个文件,因为您想利用懒加载。因此,您可以在目标目录内指定生成器产生多个文件。

有两种选项

  1. 使用切换 --multi 为每个laravel模块语言文件生成一个文件
  2. 使用切换 --multi-locales 为每个区域设置生成一个文件
php artisan vue-i18n:generate --multi{-locales}

参数

生成器会调整字符串以便与vue-i18n的命名格式化一起使用,因此您可以使用参数重用Laravel翻译。

resource/lang/message.php

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

在vue-i18n-locales.generated.js中

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

Blade模板

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

Vue模板

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

注意事项

  • 生成的文件是一个ES6模块。

如在此处所述的更复杂的复数本地化(链接),由于vue-i18n或vuex-i18n都不支持此功能,因此不被支持。

许可证

MIT许可证下。