Skip to content

Latest commit

 

History

History
119 lines (68 loc) · 2.83 KB

README.md

File metadata and controls

119 lines (68 loc) · 2.83 KB
Raw

Laravel JS Localization

Laravel Localization in JavaScript.

This is a simple package that convert all your localization messages of your Laravel app to JavaScript, and provides a small JavaScript library to interact with those messages.

Installation

Add the following line to you composer.json file under require.

"dpgover/laravel-js-localization": "1.0.*"

Run:

composer update

In your Laravel app go to app/config/app.php and add the following service provider:

'providers' => array(
    ...
    'Mariuzzo\LaravelJsLocalization\LaravelJsLocalizationServiceProvider'
    ...
)

Run:

php artisan config:publish --path=vendor/dpgover/laravel-js-localization/config dpgover/js-localization

That's it!

Usage

This project comes with a command that generate the JavaScript version of all the translation keys specified in the configuration file, taking all the files in app/lang directory. The resulting JavaScript file will have the whole bunch of messages and a thin library similar to Laravel's Lang class.

Generating JS messages

php artisan lang:js

Specifying a custom target

php artisan lang:js public/assets/dist/lang.dist.js

Compressing the JS file

php artisan lang:js -c

Documentation

This is the documentation regarding the thin JavaScript library. The library highly inspired on Laravel's Lang class.

Getting a message

Lang.get('messages.home');

Getting a message with replacements

Lang.get('messages.welcome', { name: 'Joe' });

Changing the locale

Lang.setLocale('es');

Checking if a message key exists

Lang.has('messages.foo');

Support for singular and plural message based on a count

Lang.choice('messages.apples', 10);

Calling the choice method with replacements

Lang.choice('messages.apples', 10, { name: 'Joe' });

For more detailed information, take a look at the source: Lang.js.

Want to contribute?

  1. Fork this repository and clone it.
  2. Create a branch from develop: git checkout -b feature-foo.
  3. Push your commits and create a pull request.

Setting up development environment

Prerequisites:

You need to have installed the following softwares.

  • Composer.
  • NodeJS.
  • NPM.
  • PHP 5.4+.

After getting all the required softwares you may run the following commands to get everything ready:

  1. Install PHP dependencies:

    composer install

  2. Install NPM dependences:

    npm install

Now you are good to go! Happy coding!

Unit testing

This project use Node-Jasmine as the test runner. All tests are stored at tests/spec directory.

To run all tests type in you terminal:

npm test