Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/conedevelopment/i18n

Push your Laravel translations to the front-end and use them easily with JavaScript.
https://github.com/conedevelopment/i18n

Last synced: about 2 months ago
JSON representation

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

Awesome Lists containing this project

README 

        
# I18n



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



A nice tool for SPAs and front-end heavy applications.



If you have any question how the package works, we suggest to read this post:

[Using Laravel’s Localization in JS](https://pineco.de/using-laravels-localization-js/).



## Getting started



You can install the package with composer, running the `composer require conedevelopment/i18n` command.



## Translations in view files



You can use the `@translations` blade directive.

This directive automatically wraps the translations to a `` tag.



```html

@translations



<!-- The result -->

<script>window['translations'] = { auth: {...}, validation: {...} }

```



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



```html

@translations ('myTranslations')



window['myTranslations'] = { auth: {...}, validation: {...} }

```



## Publishing and using the JavaScript library



Use the `php artisan vendor:publish` command and choose the `Pine\I18n\I18nServiceProvider` provider.

After publishing you can find your fresh copy in the `resources/js/vendor` folder.



### Using the I18n.js



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



```js

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.



```js

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.



```js

let translator = 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.



```js

Vue.prototype.$I18n = new I18n;

```



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



```html



    
{{ $I18n.trans('some.key') }}



```



```js

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.



```js

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:



```php

[

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

]

```

> [!NOTE]

> The plural and the singular versions are separated by the `|` character!



```js

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.



```php

[

    '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.



```js

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 placeholders.



```php

[

    '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`.



```js

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



// Welcome, PINE



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



// Goodbye, Pine

```



### Package translations



Thanks to the idea of [Jonathan](https://github.com/sardoj), package translations are supported by default.

You can access to the translations as in Laravel, using the predefined namespace.



```js

translator.trans('courier::messages.message');

```



## Multiple locales



Multiple locales are supported. You can change the application's locale anytime.

Behind the scenes the proper translations will be rendered, if it exists.



## Fallback locales



If there are no translations is not available in the current language,

the package will look for the fallback locale's translations.

If there is no translations available in the fallback locale, the missing translations won't appear.



## Performance



The translations are generated when the views are compiled.

It means they are cached and stored as strings in the compiled views.

It's much more performance friendly than generating them on runtime or running and AJAX request to fetch the translations.



Behind the scenes there is a switch - case that determines which translations should be present, based on the current locale.

This way only the current translations are pushed to the window object and not all of them.



> Note: On local environment the cached views are getting cleared to keep translations fresh.



## Contribute



If you found a bug or you have an idea connecting the package, feel free to open an issue.