helthe/turbolinks-bundle

Turbolinks bundle for Symfony

1.3.1 2019-01-02 21:33 UTC

Requires

• php: >=5.3.3
• helthe/turbolinks: ~1.2|~2.0
• symfony/framework-bundle: ~2.3|~3.0|~4.0

Requires (Dev)

• phpunit/phpunit: ~4.8|~5.7

MIT

• Carl Alexander

• turbolinks
• jquery.turbolinks

README

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

Installation

Step 1: Add package requirement in Composer

Manually

Add the following in your composer.json:

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

Using the command line

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

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.