Developed with love by KnpLabs Hire us for your project!
44

TurbolinksBundle

by helthe

Turbolinks implementation for your Symfony2 project

Helthe Turbolinks Bundle Build Status Scrutinizer Quality Score

The HeltheTurbolinksBundle integrates the Helthe Turbolinks Component
with your Symfony2 application.

Installation

Step 1: Add package requirement in Composer

Manually

Add the following in your composer.json:

{
    "require": {
        // ...
        "helthe/turbolinks-bundle": "~1.1"
    }
}

Using the command line

$ composer require 'helthe/turbolinks-bundle=~1.1'

Step 2: Register the bundle in the kernel

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Helthe\Bundle\TurbolinksBundle\HeltheTurbolinksBundle(),
    );
}

Step 3: Add Composer scripts for automatic installation of assets

{
   "scripts": {
       "post-install-cmd": [
           "Helthe\\Bundle\\TurbolinksBundle\\Composer\\ScriptHandler::installAssets"
       ],
       "post-update-cmd": [
           "Helthe\\Bundle\\TurbolinksBundle\\Composer\\ScriptHandler::installAssets"
       ]
   }
}

Usage

To start using turbolinks, all you need to do is add the turbolinks javascript to your layout.

Both the original coffeescript version and compiled version of each script are available for use.

Inserting the javascript in your layout

Directly

<script src="{{ asset('bundles/heltheturbolinks/js/turbolinks.js') }}"></script>

Using Assetic

{% javascripts '@HeltheTurbolinksBundle/Resources/public/js/turbolinks.js' %}
    <script type="text/javascript" src="{{ asset_url }}"></script>
{% endjavascripts %}

Using jquery.turbolinks

If you need to use jquery.turbolinks, you need to add it before turbolinks.js

Compatibility

Turbolinks 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.

Additional Resources

Please refer to the turbolinks and
jquery.turbolinks projects
if you require additional information on the javascript libraries.

You will find additional documentation with the turbolinks component
documentation.

Bugs

For bugs or feature requests, please create an issue.

Copyright (c) 2014 Carl Alexander

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.