devmatic/laravel-instantclick

An InstantClick middleware for Laravel 5

An InstantClick middleware for Laravel 5

, _(*1)

InstantClick is a plugin that makes following links in your website instant by leverages ajax to speed up the loading time of your pages., _(*2)

InstantClick uses pushState and Ajax (a combo known as pjax), replacing only the body and the title in the head., _(*3)

Devmatic is a web development company aims to make developers life easier. You’ll find an overview of all our projects on our website., _(*4)

Ajax brings two nice benefits in and of itself:

• Your browser doesn’t have to throw and recompile scripts and styles on each page change anymore.
• You don’t get a white flash while your browser is waiting for a page to display, making your website feel faster.

This package provides a middleware that can return the response that this plugin expects., _(*5)

Video Tutorial & Overview

, _(*6)

Installation & Usage

• You can install the package via composer: ``` bash $ composer require devmatic/laravel-instantclick

- Next you must add the `\Devmatic\InstantClick\Middleware\FilterIfInstantClick`-middleware to the kernel.
```php
// app/Http/Kernel.php

...
protected $middleware = [
    ...
    \Devmatic\InstantClick\Middleware\FilterIfInstantClick::class,
];

• Copy the included instantclick.js to your proper public asset folder then include it at your layout file like this:

    
    <script data-no-instant>InstantClick.init();</script>

• Please refer to InstantClient documentation to know more about InstantClient options and how it works.

Important Note

please use the included instantclick.js file because I modify it by adding $xhr.setRequestHeader(‘X-INSTANTCLICK’, true) to give the middleware the ability to identify InstantClient requests and give the proper response to it., _(*7)

How it Works

The provided middleware provides the behaviour that the Instant Click plugin expects of the server:, _(*8)

An X-INSTANTCLICK request header is set to differentiate a InstantClick request from normal XHR requests. In this case, if the request is InstantClick, we skip the layout html and just render the inner contents of the body., _(*9)

Change log

Please see CHANGELOG for more information what has changed recently., _(*10)

Testing

bash $ composer test, _(*11)

Contributing

Please see CONTRIBUTING for details., _(*12)

Credits

• Diaa Fares
• All Contributors

The middleware in this package was originally written by Freek Van der Herten for return the response that Pjax jquery plugin expects, I edit his middleware and InstantClick plugin to make it work for Laravel. His original code can be found in this repo on GitHub., _(*13)

License

The MIT License (MIT). Please see License File for more information., _(*14)