The Helthe Turbolinks is a direct port of the rails turbolinks gem and the jquery.turbolinks gem for projects using the Symfony HttpFoundation Component.
Current versions of the following gems are used:
- turbolinks: v2.2.0
- jquery.turbolinks: v2.0.1
Turbolinks makes following links in your web application faster. Instead of letting the browser recompile the JavaScript and CSS between each page change, it keeps the current page instance alive and replaces only the body and the title in the head.
Performance improvements will vary depending on the amount of CSS and Javascript you are using. You can get up to a 2X increase when using a lot of Javascript and CSS. You can find the rails benchmarks here.
Add the following in your componser.json:
{
"require": {
// ...
"helthe/turbolinks": "~1.2"
}
}$ composer require 'helthe/turbolinks=~1.2'Using turbolinks requires both the usage of the javascript library and modifying the PHP response so that it can be properly processed by turbolinks.
There are multiple ways to decorate the PHP response for turbolinks.
You can manually decorate the response with the Turbolinksobject.
<?php
use Helthe\Component\Turbolinks\Turbolinks;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
// ...
$turbolinks = new Turbolinks();
$turbolinks->decorateResponse($request, $response);You can add an event listener to the dispatcher that is passed to the HttpKernel.
<?php
use Helthe\Component\Turbolinks\EventListener\TurbolinksListener;
use Helthe\Component\Turbolinks\Turbolinks;
// ...
// Symfony\Component\EventDispatcher\EventDispatcherInterface
$dispatcher->addSubscriber(new TurbolinksListener(new Turbolinks()));You can decorate the response using the supplied Stack middleware.
<?php
use Helthe\Component\Turbolinks\StackTurbolinks;
use Helthe\Component\Turbolinks\Turbolinks;
// ...
$app = new StackTurbolinks($app, new Turbolinks());Both the original coffeescript version and compiled version of each script are available for use.
To enable turbolinks, all you need to do is add the compiled turbolinks javascript to your layout in the <head>section.
If you need to use jquery.turbolinks, you need to add it before turbolinks.js.
The turbolinks javascript is designed to work with any browser that fully supports pushState and all the related APIs. This includes Safari 6.0+ (but not Safari 5.1.x!), IE10, and latest Chromes and Firefoxes.
Do note that existing JavaScript libraries may not all be compatible with Turbolinks out of the box due to the change in instantiation cycle. You might very well have to modify them to work with Turbolinks' new set of events. For help with this, check out the Turbolinks Compatibility project.
Please refer to the turbolinks and jquery.turbolinks projects if you require additional information on the javascript libraries and their usage.
For bugs or feature requests, please create an issue.