Skip to content

Complete Turbo migration: Update Pro dummy app and docs #1908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 5, 2025
Merged

Complete Turbo migration: Update Pro dummy app and docs #1908

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5a5f27
Fix Turbo navigation by updating to Turbo-compatible script tag
justin808 Nov 5, 2025
4740d4f
Update Pro dummy app and docs to use modern Turbo syntax
justin808 Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/building-features/turbolinks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,12 +128,21 @@ This definitely can make an app perform better, even if the JavaScript and style
1. Include turbolinks via yarn as shown in the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/blob/8a6c8aa2e3b7ae5b08b0a9744fb3a63a2fe0f002/client/webpack.client.base.config.js#L22) or include the gem "turbolinks".
1. Included the proper "track" tags when you include the javascript and stylesheet:

**For Turbolinks 5.x:**

```erb
<%= 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`
**For Turbolinks 2.x (Classic):**

```erb
<%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
<%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
```

**Note:** If you're using modern Turbo (recommended), use `'data-turbo-track' => 'reload'` instead of `'data-turbolinks-track'`. See the "Using Turbo" section at the top of this document.

1. Add turbolinks to your `application.js` file:
```javascript
Expand Down
4 changes: 2 additions & 2 deletions react_on_rails_pro/spec/dummy/app/views/layouts/application.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@
</style>
<%= stylesheet_pack_tag('client-bundle',
media: 'all',
'data-turbolinks-track': true) %>
'data-turbo-track': 'reload') %>

<%# Used for testing purposes to simulate hydration failure %>
<% unless params[:skip_js_packs] == 'true' %>
<%= javascript_pack_tag('client-bundle', 'data-turbolinks-track': true, defer: false) %>
<%= javascript_pack_tag('client-bundle', 'data-turbo-track': 'reload', defer: false) %>
<% end %>
<%= csrf_meta_tags %>
</head>
Expand Down
2 changes: 1 addition & 1 deletion spec/dummy/app/views/layouts/application.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<%= yield :head %>

<!-- NOTE: Must use defer and not async to keep async scripts loading in correct order -->
<%= javascript_pack_tag('client-bundle', 'data-turbolinks-track': true) %>
<%= javascript_pack_tag('client-bundle', 'data-turbo-track': 'reload', defer: true) %>

<%= csrf_meta_tags %>
</head>
Expand Down
Loading