| Package Data | |
|---|---|
| Maintainer Username: | reinink |
| Maintainer Contact: | jonathan@reinink.ca (Jonathan Reinink) |
| Package Create Date: | 2019-03-07 |
| Package Last Update: | 2024-03-19 |
| Home Page: | https://inertiajs.com |
| Language: | PHP |
| License: | MIT |
| Last Refreshed: | 2024-05-03 15:23:09 |
| Package Statistics | |
|---|---|
| Total Downloads: | 16,476,772 |
| Monthly Downloads: | 885,293 |
| Daily Downloads: | 38,925 |
| Total Stars: | 1,921 |
| Total Watchers: | 46 |
| Total Forks: | 216 |
| Total Open Issues: | 44 |
To use Inertia.js you need both a server-side adapter (like this one) as well as a client-side adapter, such as inertia-vue. Be sure to also follow the installation instructions for the client-side adapter you choose. This documentation will only cover the Laravel adapter setup.
Install using Composer:
composer require inertiajs/inertia-laravel
The first step to using Inertia is creating a root template. We recommend using app.blade.php. This template should include your assets, as well as the @inertia directive.
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0">
<link href="{{ mix('/css/app.css') }}" rel="stylesheet">
<script src="{{ mix('/js/app.js') }}" defer></script>
</head>
<body>
@inertia
</body>
</html>
The @inertia directive is simply a helper for creating our base div. It includes a data-page attribute which contains the inital page information. Here's what that looks like.
<div id="app" data-page="{{ json_encode($page) }}"></div>
If you'd like to use a different root view, you can change it using Inertia::setRootView().
Inertia\Inertia::setRootView('name');
Next, add the Inertia\Middleware middleware to your web middleware group, found in the /app/Http/Kernel.php file. This middleware monitors for asset changes, and also fixes an edge case with 302 redirects.
protected $middlewareGroups = [
'web' => [
\Inertia\Middleware::class,
// ...
]
];
To make an Inertia response, use Inertia::render(). This function takes two arguments, the component name, and the component data (props).
use Inertia\Inertia;
class EventsController extends Controller
{
public function show(Event $event)
{
return Inertia::render('Event', [
'event' => $event->only('id', 'title', 'start_date', 'description'),
]);
}
}
When making a non-GET Inertia request, via <inertia-link> or manually, be sure to still respond with a proper Inertia response. For example, if you're creating a new user, have your "store" endpoint return a redirect back to a standard GET endpoint, such as your user index page. Inertia will automatically follow this redirect and update the page accordingly. Here's a simplified example.
class UsersController extends Controller
{
public function index()
{
return Inertia::render('Users/Index', ['users' => User::all()]);
}
public function store()
{
User::create(
Request::validate([
'first_name' => ['required', 'max:50'],
'last_name' => ['required', 'max:50'],
'email' => ['required', 'max:50', 'email'],
])
);
return Redirect::route('users');
}
}
Note, when redirecting after a PUT, PATCH or DELETE request you must use a 303 response code, otherwise the subsequent request will not be treated as a GET request. A 303 redirect is the same as a 302 except that the follow-up request is explicitly changed to a GET request.
To share data with all your components, use Inertia::share($data). This can be done both synchronously and lazily.
// Synchronously
Inertia::share('app.name', Config::get('app.name'));
// Lazily
Inertia::share('auth.user', function () {
if (Auth::user()) {
return [
'id' => Auth::user()->id,
'first_name' => Auth::user()->first_name,
'last_name' => Auth::user()->last_name,
];
}
});
There are situations where you may want to access your prop data in your root Blade template. For example, you may want to add a meta description tag, Twitter card meta tags, or Facebook Open Graph meta tags. To do this, use the Inertia::get() helper.
<meta name="twitter:title" content="{{ Inertia::get('event.title') }}">
Sometimes you may even want to provide data that will not be sent to your JavaScript component. You can do this using the with() view helper, since Inertia::render() returns a View instance.
return Inertia::render('Event', ['event' => $event])
->with(['meta_description' => $event->meta_description]);
You can then access this variable like a regular Blade variable.
<meta name="description" content="{{ $meta_description }}">
One common challenge with single-page apps is refreshing site assets when they've been changed. Inertia makes this easy by optionally tracking the current version of your site assets. In the event that an asset changes, Inertia will automatically make a hard page visit instead of a normal ajax visit on the next request.
To enable automatic asset refreshing, first call the Inertia::version($version) method with your current asset version. We recommend putting this in a service provider.
Inertia::version($version);
If you're using Laravel Mix, you can use the mix-manifest.json for this. Here's an example of that using lazy evaluation.
Inertia::version(function () {
return md5_file(public_path('mix-manifest.json'));
});
Finally, make sure you have versioning setup in your webpack.mix.js to enable asset cache busting.