Stimulus and Turbo (Hotwire) in Ruby on Rails

Introduction

Stimulus and Turbo help you build fast, interactive web pages without writing much JavaScript. They make your app feel quick and smooth by updating parts of the page automatically.

You want to add simple interactivity like button clicks or form handling without full page reloads.

You want to update parts of a page dynamically after a user action, like submitting a form or clicking a link.

You want to speed up your Rails app by avoiding full page refreshes and loading only what changes.

You want to keep your JavaScript code organized and easy to maintain.

You want to build modern web apps with less JavaScript and more server-driven HTML.

Syntax

Ruby on Rails

import { Controller } from "@hotwired/stimulus"

export default class extends Controller {
  connect() {
    // code to run when controller connects
  }

  someAction(event) {
    // code to run on event
  }
}

Stimulus controllers are small JavaScript classes that connect to HTML elements using data attributes.

Turbo uses special HTML attributes and server responses to update page parts without full reloads.

Examples

This Stimulus controller shows an alert when the button is clicked.

Ruby on Rails

<button data-action="click->hello#greet">Click me</button>

// hello_controller.js
import { Controller } from "@hotwired/stimulus"

export default class extends Controller {
  greet() {
    alert('Hello!')
  }
}

This Turbo Frame loads the post content inside the frame without reloading the whole page.

Ruby on Rails

<a href="/posts/1" data-turbo-frame="post_frame">View Post</a>

<div id="post_frame" data-turbo-frame>
  <!-- Post content loads here -->
</div>

This form submits via Turbo, updating the page dynamically without a full reload.

Ruby on Rails

<form action="/comments" method="post" data-turbo="true">
  <input name="comment" />
  <button type="submit">Submit</button>
</form>

Sample Program

This example shows a button that triggers a Stimulus controller action to display an alert message when clicked.

Ruby on Rails

<!-- index.html.erb -->
<div data-controller="hello">
  <button data-action="click->hello#greet">Say Hello</button>
</div>

// hello_controller.js
import { Controller } from "@hotwired/stimulus"

export default class extends Controller {
  greet() {
    alert('Hello from Stimulus!')
  }
}

Important Notes

Always add data-controller to the HTML element you want Stimulus to manage.

Turbo Frames let you update only parts of the page, making apps faster and smoother.

Use data-action to connect user events like clicks to Stimulus controller methods.

Summary

Stimulus adds simple JavaScript behavior to HTML using controllers and data attributes.

Turbo speeds up page updates by replacing only parts of the page without full reloads.

Together, they help build fast, interactive Rails apps with less JavaScript code.

Practice

1. What is the main purpose of Stimulus in a Rails application using Hotwire?

easy

A. To add simple JavaScript behavior to HTML elements using controllers and data attributes

B. To replace the entire page content on every user action

C. To handle database queries efficiently

D. To style HTML elements with CSS

Solution

1. Step 1: Understand Stimulus role

   Stimulus is designed to add JavaScript behavior to HTML by connecting controllers to elements via data attributes.

2. Step 2: Compare other options

   Replacing entire page content is Turbo's job, not Stimulus. Database queries and styling are unrelated.

3. Final Answer:

   To add simple JavaScript behavior to HTML elements using controllers and data attributes -> Option A

4. Quick Check:

   Stimulus = JavaScript behavior via controllers [OK]

Hint: Stimulus controls behavior, Turbo controls page updates [OK]

Common Mistakes:

• Confusing Turbo's page update role with Stimulus
• Thinking Stimulus handles styling or database
• Assuming Stimulus reloads full pages

2. Which of the following is the correct way to connect a Stimulus controller named hello to a button element?

easy

A. Click me

B. Click me

C. Click me

D. Click me

Solution

1. Step 1: Recall Stimulus controller connection syntax

   Stimulus controllers are connected using the data-controller attribute with the controller name.

2. Step 2: Verify other attributes

   data-action defines event handlers, data-target defines targets inside controllers, data-connect is invalid.

3. Final Answer:

   <button data-controller="hello">Click me</button> -> Option B

4. Quick Check:

   Controller connection uses data-controller [OK]

Hint: Use data-controller to link Stimulus controllers [OK]

Common Mistakes:

• Using data-action instead of data-controller to connect controller
• Confusing data-target with controller connection
• Using non-existent data-connect attribute

3. Given this Stimulus controller code:

export default class extends Controller {
  static targets = ["output"]
  greet() {
    this.outputTarget.textContent = "Hello, Stimulus!"
  }
}

and this HTML:

<div data-controller="greeting">
  <button data-action="click->greeting#greet">Say Hello</button>
  <span data-greeting-target="output"></span>
</div>

What happens when the button is clicked?

medium

A. The span text changes to 'Hello, Stimulus!'

B. Nothing happens because the controller name is wrong

C. The page reloads

D. An error is thrown because outputTarget is undefined

Solution

1. Step 1: Match controller and targets

   The controller is named 'greeting' and defines an output target. The HTML uses data-controller="greeting" and data-greeting-target="output" correctly.

2. Step 2: Understand the greet method and action

   The button triggers greet on click, which sets the outputTarget's textContent to 'Hello, Stimulus!'.

3. Final Answer:

   The span text changes to 'Hello, Stimulus!' -> Option A

4. Quick Check:

   Correct controller and target update text [OK]

Hint: Check controller name matches data-controller and targets [OK]

Common Mistakes:

• Mismatching controller name and data-controller attribute
• Forgetting to define static targets array
• Expecting page reload instead of DOM update

4. Identify the error in this Turbo Frame usage:

<turbo-frame id="messages">
  <%= render @messages %>
</turbo-frame>

When a new message is created, the frame does not update automatically. What is the likely cause?

medium

A. The frame id should be messages_frame instead of messages

B. Turbo Frames cannot render collections

C. The render call is missing a partial

D. The server response does not include a turbo-frame with matching id

Solution

1. Step 1: Understand Turbo Frame update mechanism

   Turbo Frames update only if the server response includes a turbo-frame element with the same id as the frame on the page.

2. Step 2: Identify the problem

   If the server response lacks a matching turbo-frame wrapper, Turbo cannot replace the frame content automatically.

3. Final Answer:

   The server response does not include a <turbo-frame> with matching id -> Option D

4. Quick Check:

   Matching turbo-frame id in response is required [OK]

Hint: Ensure server response wraps content in matching turbo-frame id [OK]

Common Mistakes:

• Changing frame id arbitrarily
• Assuming Turbo Frames can't render collections
• Forgetting to wrap response in turbo-frame tag

5. You want to create a live search feature using Turbo and Stimulus. Which approach correctly combines both to update search results as the user types without full page reload?

hard

A. Use Stimulus to reload the whole page manually on input change

B. Use Turbo Frames alone to reload the entire page on every keystroke

C. Use a Stimulus controller to listen for input events, send fetch requests to the server, and update a Turbo Frame with the results

D. Use Turbo Streams to replace the entire page content on input

Solution

1. Step 1: Understand live search requirements

   Live search updates results dynamically as the user types without full reload.

2. Step 2: Combine Stimulus and Turbo correctly

   Stimulus listens to input events and sends fetch requests. Turbo Frame updates only the results part of the page.

3. Step 3: Evaluate other options

   Reloading entire page on every keystroke is inefficient. Turbo Streams replace parts but need server push. Stimulus alone can't reload page efficiently.

4. Final Answer:

   Use a Stimulus controller to listen for input events, send fetch requests to the server, and update a Turbo Frame with the results -> Option C

5. Quick Check:

   Stimulus + Turbo Frame = dynamic partial updates [OK]

Hint: Stimulus handles events, Turbo Frame updates partial content [OK]

Common Mistakes:

• Reloading full page on every input
• Using Turbo Frames without Stimulus for input events
• Misusing Turbo Streams for full page replacement