KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

TurbolinksBundle

★ 38 Open GitHub ↗

Turbolinks implementation for your Symfony project

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Helthe Turbolinks Bundle [![Build Status](https://secure.travis-ci.org/helthe/TurbolinksBundle.png?branch=master)](http://travis-ci.org/helthe/TurbolinksBundle) [![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/helthe/TurbolinksBundle/badges/quality-score.png?s=eda15114a686b73f8de2e2d4a8beee6ce2af5bbf)](https://scrutinizer-ci.com/g/helthe/TurbolinksBundle/)

The HeltheTurbolinksBundle integrates the [Helthe Turbolinks Component](https://github.com/helthe/Turbolinks)
with your Symfony application.

## Installation

### Step 1: Add package requirement in Composer

#### Manually

Add the following in your `composer.json`:

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

#### Using the command line

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

### Step 2: Register the bundle in the kernel

```php
<?php
// app/AppKernel.php

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

### Step 3: Add Composer scripts for automatic installation of assets

```json
{
   "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

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

#### Using Assetic

```jinja
{% 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](http://reed.github.io/turbolinks-compatibility).

## Additional Resources

Please refer to the [turbolinks](https://github.com/rails/turbolinks) and
[jquery.turbolinks](https://github.com/kossnocorp/jquery.turbolinks) projects
if you require additional information on the javascript libraries.

You will find additional documentation with the turbolinks component
[documentation](https://github.com/helthe/Turbolinks).

## Bugs

For bugs or feature requests, please [create an issue](https://github.com/helthe/TurbolinksBundle/issues/new).

TurbolinksBundle

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README