README

DEPRECATED

This package is no longer maintained. Please use https://github.com/aaronlord/laroute or any other alternative you may find!

Why?

We love the Laravel routing system and we often use named routes like route('users.show', ['id' => 1]) to generate http://domain.tld/users/1. With the amazing uprising of Javascript frameworks (AngularJS, EmberJS, Backbone, etc.) it's hard to track changes on your routes between the backend and the REST calls from your Javascript. The goal of this library is to expose those named routes to your frontend so you can do: Router.route('users.show', {id: 1}) and get the same result.

Installation

Begin by installing this package through Composer.

composer require laravelba/laravel-js-routes

To use this package, add its service provider to your config/app.php providers array.

    'providers' => [
        // ... 
        LaravelBA\LaravelJsRoutes\LaravelJsRoutesServiceProvider::class,
    ],

Usage

The ServiceProvider will add a new command routes:javascript to your artisan commands. By default, this command will generate a routes.js file on your resources/assets/js folder. This contains all named routes in your app. That's it! You're all set to go.

$ php artisan routes:javascript

Lazy Tip If you use elixir (or any js task manager), set up a watcher that runs this command whenever your php routes change.

Arguments

Name	Default	Description
name	routes.js	Output filename

Options

Name	Default	Description
path	resources/assets/js	Where to save the generated filename, relative to the base path. (ie. "public/assets" folder if you don't plan to mix it.)
middleware	null	If you want only some routes to be available on JS, you can use a middleware (like js-routable) to select only those
object	Router	If you want to choose your own global JS object (to avoid collision)
prefix	null	If you want to a path to prefix to all your routes

Javascript usage

By default, the command will generate a routes.js file on your resources/assets/js folder, so you can use elixir:

elixir(function(mix){
    mix.scripts([
        'routes.js',
        'app.js'
    ]);
});

You may generate the routes file in your public folder instead...

php artisan routes:javascript --path public/js

...then include it in your views:

<script src="/js/routes.js" type="text/javascript">

In any case, you'll have a Routes object on your global scope.

Examples:

// Usage: Router.route(route_name, params)
Router.route('users.show', {id: 1}) // returns http://dommain.tld/users/1

// If you assign parameters that are not present on the URI, they will get appended as a query string:
Router.route('users.show', {id: 1, name: 'John', order: 'asc'}) // returns http://dommain.tld/users/1?name=John&order=asc

Contributing

This project uses phpunit for php testing and jasmine for JS testing. Check available grunt tasks in the Gruntfile.js file.

Found a bug?

Please, let us know! Send a pull request (better) or create an issue. Questions? Ask! We will respond to all issues.

Inspiration

Although no code was copied, this package is greatly inspired by FOSJsRoutingBundle for Symfony.

License

This package is open-sourced software licensed under the MIT license

laravelba / laravel-js-routes

Maintainers

Details