Pjax is jquery plugin that leverages ajax to speed up the loading time of your pages. It works by only fetching specific html fragments from the server, and client-side updating only certain parts of the page.
The package provides a middleware that can return the reponse that the jquery plugin expects.
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
You can install the package via composer:
$ composer require spatie/laravel-pjax
Next you must add the \Spatie\Pjax\Middleware\FilterIfPjax
-middleware to the kernel.
// app/Http/Kernel.php
...
protected $middleware = [
...
\Spatie\Pjax\Middleware\FilterIfPjax::class,
];
The provided middleware provides the behaviour that the pjax plugin expects of the server:
An X-PJAX request header is set to differentiate a pjax request from normal XHR requests. In this case, if the request is pjax, we skip the layout html and just render the inner contents of the container.
When using Laravel Elixir to manage your frontend cache busting, you can use it to your advantage to bust pjax's cache. Simply include the elixir
method as the content of the x-pjax-version
meta tag:
<meta http-equiv="x-pjax-version" content="{{ elixir('css/app.css') }}">
Multiple files:
<meta http-equiv="x-pjax-version" content="{{ elixir('css/app.css') . elixir('css/app2.css') }}">
This way, anytime your frontend's cache gets busted, pjax's cache gets automatically busted as well!
Please see CHANGELOG for more information what has changed recently.
$ composer test
Please see CONTRIBUTING for details.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
The middleware in this package was originally written by Jeffrey Way for the Laracasts-lesson on pjax. His original code can be found in this repo on GitHub.
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
The MIT License (MIT). Please see License File for more information.