codiant/laravel-js-routes

Create Laravel routes for JS files

dev-main 2021-06-07 07:38 UTC

Requires

• laravel/framework: >= 6.20.14 |>= 7.30.4|>= 8.40.0

MIT

• Mahendra Gurjar

README

Command for use Laravel routes in JS Files. With this package you can use laravel routes with laravel mix js.

Usage:

composer require codiant/laravel-js-routes

Execute artisan command

php artisan route:js

Add variable in header layout file

var APP_PATH = "{{ url('/') }}";

Add resource to webpack.mix.js:

mix.js("resources/js/routes.js", "public/js/routes.js");

And run below command.
npm run develoment
npm run prod
npm run watch

Add js file in your footer links file

<script src="{{asset('public/js/routes.js')}}"></script>

Important Notes

When you update your route file don't forgot to run below commands.
php artisan route:js
npm run (prod, develoment, watch)

Now you have the route function. First parameter of route function is the route name (same as in laravel). Second is an array of parameters or an object of parameters. Third is if you want to use absolute paths, by default true.

Example Uses

In laravel route file.
Route::post('/user', /*......*/)->name('user');

In js file
route('user');

Use with parameters
Route::post('/user/{id}', /*......*/)->name('user');

In js file
route('user', [1]);
route('user', {1});

Use parameter with name
Route::post('/user/{user_id}/post/{post_id}', /*......*/)->name('user');

In js file
route('user', [1, 2]);
route('user', {1, 2});
route('user', {'user_id': 1, 'post_id': 2});

Contributing

Pull requests and issues are welcome.