Skip to content

Latest commit

 

History

History
91 lines (73 loc) · 3.81 KB

turbolinks.md

File metadata and controls

91 lines (73 loc) · 3.81 KB
Raw

Turbolinks

  • See Turbolinks on Github
  • Currently support 2.5.x of Turbolinks and 5.0.0 of Turbolinks 5.
  • Turbolinks is currently included only via the Rails gem and the Rails manifest file rather than NPM. Turbolinks Issue #658 discusses this.

Why Turbolinks?

As you switch between Rails HTML controller requests, you will only load the HTML and you will not reload JavaScript and stylesheets. This definitely can make an app perform better, even if the JavaScript and stylesheets are cached by the browser, as they will still require parsing.

Install Checklist

  1. Include the gem "turbolinks".
  2. Included the proper "track" tags when you include the javascript and stylesheet:
  <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => 'reload' %>
  <%= javascript_include_tag 'application', 'data-turbolinks-track' => 'reload' %>

NOTE: for Turbolinks 2.x, use 'data-turbolinks-track' => true

  1. Add turbolinks to your application.js file: 
    //= require turbolinks

Note, in the future, we will change to installing this via npm.

Turbolinks 5

Turbolinks 5 is now being supported. React on Rails will automatically detect which version of Turbolinks you are using and use the correct event handlers.

For more information on Turbolinks 5: https://github.com/turbolinks/turbolinks

async script loading

Generally async script loading can be done like:

  <%= javascript_include_tag 'application', async: Rails.env.production? %>

If you use document.addEventListener("turbolinks:load", function() {...}); somewhere in your code, you will notice, that Turbolinks 5 does not fire turbolinks:load on initial page load. A quick workaround is to use defer instead of async:

  <%= javascript_include_tag 'application', defer: Rails.env.production? %>

More information on this issue can be found here: turbolinks/turbolinks#28

When loading your scripts asynchronously you may experience, that your Components are not registered correctly. Call ReactOnRails.reactOnRailsPageLoaded() to re-initialize like so:

  document.addEventListener("turbolinks:load", function() {
    ReactOnRails.reactOnRailsPageLoaded();
  });

Troubleshooting

To turn on tracing of Turbolinks events, put this in your registration file, where you register your components.

   ReactOnRails.setOptions({
     traceTurbolinks: true,
   });

Rather than setting the value to true, you could set it to TRACE_TURBOLINKS, and then you could place this in your webpack.client.base.config.js:

Define this const at the top of the file:

  const devBuild = process.env.NODE_ENV !== 'production';

Add this DefinePlugin option:

  plugins: [
   new webpack.DefinePlugin({
     TRACE_TURBOLINKS: devBuild,
   }),

At Webpack compile time, the value of devBuild is inserted into your file.

Once you do that, you'll see messages prefixed with TURBO: like this in the browser console:

Turbolinks Classic:

TURBO: WITH TURBOLINKS: document page:before-unload and page:change handlers installed. (program)
TURBO: reactOnRailsPageLoaded

Turbolinks 5:

TURBO: WITH TURBOLINKS 5: document turbolinks:before-cache and turbolinks:load handlers installed. (program)
TURBO: reactOnRailsPageLoaded

We've noticed that Turbolinks doesn't work if you use the ruby gem version of jQuery and jQuery ujs. Therefore we recommend using the node packages instead. See the tutorial app for how to accomplish this.

2016-02-02_10-38-07