Stimulus Rails 教程

项目介绍

Stimulus Rails 是一个用于 Ruby on Rails 应用的 JavaScript 框架，旨在为现有的 HTML 添加交互性。它与 Hotwire 结合使用，提供了一种快速、高效的方式来增强网页的动态功能，而不需要完全重写前端。

项目快速启动

安装

首先，确保你已经有一个 Rails 7+ 的项目。如果你使用的是 Rails 6，可以按照以下步骤安装 Stimulus Rails。

1. 在 Gemfile 中添加以下内容：

   gem 'stimulus-rails'
   

2. 运行以下命令安装 gem 并初始化 Stimulus：

   bundle install
   rails stimulus:install
   

创建控制器

使用以下命令创建一个新的 Stimulus 控制器：

rails generate stimulus hello

编辑控制器

编辑生成的 app/javascript/controllers/hello_controller.js 文件：

import { Controller } from "@hotwired/stimulus"

export default class extends Controller {
  static targets = ["name", "output"]

  greet() {
    this.outputTarget.textContent = `Hello, ${this.nameTarget.value}!`
  }
}

添加 HTML

在你的视图中添加以下 HTML 代码：

<div data-controller="hello">
  <input data-hello-target="name" type="text">
  <button data-action="click->hello#greet">Greet</button>
  <span data-hello-target="output"></span>
</div>

应用案例和最佳实践

案例：表单验证

Stimulus 可以用于表单验证，提供实时的用户反馈。例如，你可以创建一个 validation_controller.js 来检查输入的有效性。

import { Controller } from "@hotwired/stimulus"

export default class extends Controller {
  static targets = ["field"]

  validate(event) {
    if (event.target.value.length < 3) {
      event.target.classList.add("invalid")
    } else {
      event.target.classList.remove("invalid")
    }
  }
}

最佳实践

• 保持简单：Stimulus 的设计理念是保持简单和专注，不要试图用它来构建复杂的单页应用。
• 模块化：将功能分解为多个小控制器，每个控制器负责一个特定的任务。
• 使用数据属性：利用 data-controller、data-target 和 data-action 属性来连接 HTML 和 JavaScript。

典型生态项目

Turbo

Turbo 是 Hotwire 的核心组件之一，与 Stimulus 配合使用，提供快速、无缝的页面导航和表单提交体验。

Stimulus Components

Stimulus Components 是一个社区驱动的项目，提供了许多预构建的 Stimulus 控制器，可以快速集成到你的应用中，如日期选择器、模态框等。

通过这些模块的介绍和实践，你可以快速上手并有效地使用 Stimulus Rails 来增强你的 Ruby on Rails 应用的交互性。