jQuery-rails 使用与技术文档

1. 安装指南

在开始使用 jQuery-rails 之前，请确保您的开发环境中已经安装了 Rails。接下来，您可以通过以下步骤安装 jQuery-rails：

• 将以下代码添加到您的 Gemfile 文件中：

  gem 'jquery-rails'
  

• 运行以下命令来安装 jQuery-rails：

  bundle install
  

• 确保 app/assets/javascripts/application.js 文件中包含以下代码：

  //= require jquery
  //= require jquery_ujs
  

对于 Rails 5.1 及以上版本，如果您的 application.js 文件中已经包含了 //= require rails-ujs，那么 jquery_ujs 就不再需要了。此时，您只需添加：

//= require jquery

如果您希望使用 jQuery 2 或 jQuery 3，您可以选择性地使用以下代码：

//= require jquery2
//= require jquery_ujs

或者：

//= require jquery3
//= require jquery_ujs

2. 项目的使用说明

jQuery-rails Gem 提供了 jQuery 1、2 和 3 版本，以及 jQuery UJS 适配器和用于在 Ruby 测试中测试 jQuery 响应的 assert_select_jquery。

此 Gem 遵循以下版本准则，以便从您的 Gemfile 中更好地控制应用程序的 jQuery 版本：

• 补丁版本升级：更新 jquery-ujs、jquery-rails 以及 jQuery 的修补级别更新
• 小版本升级：对 jQuery 进行小版本更新
• 大版本升级：对 jQuery 进行大版本更新，并更新 Rails，这可能会向后不兼容

有关 jquery-rails 捆绑的 jQuery 版本详情，请查看 VERSIONS.md。

3. 项目API使用文档

此部分内容未在提供的 README 中明确说明。通常，jQuery-rails Gem 用于在 Rails 应用程序中包含 jQuery 和 jQuery UJS 适配器。您可以直接在视图和 JavaScript 文件中使用 jQuery，就像在常规的 jQuery 项目中一样。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明。以下是简要步骤：

• 将 gem 'jquery-rails' 添加到 Gemfile
• 运行 bundle install
• 在 app/assets/javascripts/application.js 中包含所需的 jQuery 文件

确保按照以上步骤操作，您就可以在 Rails 应用程序中使用 jQuery-rails Gem 了。