grajewsky/laravel-i18n

JavaScript translations provider

v2.0.1 2019-02-28 17:00 UTC

README

Push your Laravel translations to the front-end and use them easily with JavaScript.

The JSON based translations are not supported!

Getting started

You can install the package with composer, running the composer require grajewsky/laravel-i18n command.

Laravel 5.4 and below

You have to register the service provider manually. Go to the config/app.php file and add the Grajewsky\Laravel\I18n\Providers\I18nServiceProvider::class to the providers array.

Laravel 5.5 and up

Package is auto-discover

Configuration

> php artisan vendor:publish

You can add your own i18n paths providers only what u must to do is implements Grajewsky\Laravel\I18n\Interfaces\I18nProvider

  • getI18nPath(): string
  • getLocale(): string;
  • getNamespace(): string;

and add I18nProvider into config/i18n.php Fullnamespace\MyI18nProvider::class

Translations in view files

You can use the @translations blade directive. This directive automatically wrap the translations to a <script> tag.

@translations

<!-- The result -->
<script>window['translations'] = { auth: {...}, validation: {...} }</script>

You may override the default key for the translations. You can do that by passing a string to the blade directive.

@translations ('myTranslations')

<!-- The result -->
<script>window['myTranslations'] = { auth: {...}, validation: {...} }</script>

Publishing and using the JavaScript library

Use the php artisan vendor:publish command and choose the Grajewsky\Laravel\I18n\Providers\I18nServiceProvider::class provider. After publishing you can find your fresh copy in the resources/assets/js/vendor folder.

Using the I18n.js

Then you can import the I18n class and assign it to the window object.

import I18n from './vendor/I18n';
window.I18n = I18n;

Initializing a translation instance

From this point you can initialize the translation service anywhere from your application.

let translator = new I18n;

By default, it uses the translations key in the window object. If you want to use the custom one you set in the blade directive, pass the same key to the constructor.

let traslator = new I18n('myTranslations');

Using it as a Vue service

If you want to use it from Vue templates directly you can extend Vue with this easily.

Vue.prototype.$I18n = new I18n;

You can call it from your template or the script part of your component like below:

<template>
    <div>{{ $I18n.trans('some.key') }}</div>
</template>
computed: {
    translations: {
        something: this.$I18n.trans('some.key')
    }
}

Methods

The package comes with two methods on JS side. The trans() and the trans_choice().

trans()

The trans method accepts the key of the translation and the attributes what we want to replace, but it's optional.

translator.trans('auth.failed');

// These credentials do not match our records.

translator.trans('auth.throttle', { seconds: 60 });

// Too many login attempts. Please try again in 60 seconds.

trans_choice()

The trans_choice method determines if the translation should be pluralized or nor by the given cout. Also, it accepts the attributes we want to replace.

Let's say we have the following translation line:

[
    'attempts' => 'Be careful, you have :attempts attempt left.|You still have :attempts attempts left.',
]

Note, the plural and the singular verions are separated with the | character!

translator.trans_choice('auth.attempts', 1, { attempts: 'only one' });

// Be careful, you have only one attempt left.

translator.trans_choice('auth.attempts', 4, { attempts: 'less than five' });

// You still have less than five attempts left.

Like in Laravel, you have the ability to set ranges for the pluralization. Also, you can replace placeholders like before.

[
    'apples' => '{0} There are none|[1,19] There are some (:number)|[20,*] There are many (:number)',
]

You can separate more than two choices with the | character.

translator.trans_choice('messages.apples', 0);

// There are none

translator.trans_choice('auth.attempts', 8, { number: 8 });

// There are some (8)

translator.trans_choice('auth.attempts', 25, { number: 25 });

// There are many (25)

Transforming replacement parameters

Like in Laravel's functionality, you can transform your parameters to upper case, or convert only the first character to capital letter. All you need to do, to modify your translations.

[
    'welcome' => 'Welcome, :NAME',
    'goodbye' => 'Goodbye, :Name',
]

If you want, you can pass the same parameter with different modifiers in one line as well, like :NAME, :name or :Name.

translator.trans('messages.welcome', { name: 'pine' });

// Welcome, PINE

translator.trans('messages.goodbye', { name: 'pine' });

// Goodbye, Pine