viliasas / laravel-vue-i18n-generator
从您的Laravel翻译中生成与vue-i18n兼容的包含文件。
Requires
- php: ^8.0.2
- ext-json: *
- ext-mbstring: *
- illuminate/console: ^9.0
- illuminate/support: ^9.0
Requires (Dev)
- phpunit/phpunit: ^9.5.8
README
此包是已不再维护的laravel-vue-i18n-generator包的更新副本。
Laravel 9包,允许您使用Laravel本地化与您的vue前端共享,使用vue-i18n或vuex-i18n。
安装包
在您的项目中: composer require viliasas/laravel-vue-i18n-generator --dev
然后,发布包默认配置
php artisan vendor:publish --provider="Viliasas\VueInternationalizationGenerator\GeneratorProvider"
使用vue-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选项指定输出格式(从es6、umd或json中选择)。(默认为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。
生成多个文件
有时您可能想生成多个文件,因为您想利用懒加载。为此,您可以在目标目录内指定生成器生成多个文件。
有两种选项
- 使用
--multi开关,每个Laravel模块语言文件一个文件 - 使用
--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