jQuery 无侵入脚本适配器技术文档

安装指南

使用 jquery-rails gem 安装

在 Rails 项目中，可以通过 jquery-rails gem 进行自动化安装。首先，在 Gemfile 中添加以下内容：

gem 'jquery-rails'

然后运行以下命令：

$ bundle install

在 application.js 文件中引入 jquery 和 jquery_ujs：

//= require jquery
//= require jquery_ujs

使用 npm 安装

通过 npm 安装 jquery-ujs 包：

$ npm install --save jquery-ujs

使用 Rails 和 Webpacker 安装

如果你使用的是 Rails 5.1 及以上版本，并且通过 Webpacker 管理 JavaScript 资源，可以使用 yarn 安装 jquery-ujs 包：

$ yarn add jquery-ujs

然后在你的 JavaScript 文件中引入 jquery-ujs：

import {} from 'jquery-ujs'

使用 Bower 安装

通过 Bower 安装 jquery-ujs 包：

$ bower install jquery-ujs --save

项目的使用说明

引入 jquery 和 jquery-ujs

无论你使用哪种安装方式，都需要在项目中引入 jquery 和 jquery-ujs。在 application.js 文件中添加以下内容：

//= require jquery
//= require jquery-ujs

功能说明

jquery-ujs 提供了以下功能：

• 确认对话框：通过添加特定的 data 属性，强制用户在执行某些操作前进行确认。
• 非 GET 请求：允许通过超链接发起非 GET 请求。
• Ajax 提交：使表单或超链接通过 Ajax 异步提交数据。
• 防止重复点击：在表单提交时自动禁用提交按钮，防止用户重复点击。

这些功能通过在 HTML 标记中添加特定的 data 属性来实现。在 Rails 中，这些属性通常由框架的模板助手自动添加。

项目 API 使用文档

数据属性

jquery-ujs 通过 data 属性来实现其功能。以下是一些常用的 data 属性：

• data-confirm：在执行操作前弹出确认对话框。
• data-method：指定请求的 HTTP 方法（如 POST、PUT、DELETE）。
• data-disable-with：在表单提交时禁用提交按钮，并显示指定的文本。

示例

确认对话框

<a href="/delete" data-confirm="确定要删除吗？">删除</a>

非 GET 请求

<a href="/update" data-method="put">更新</a>

Ajax 提交

<form action="/submit" data-remote="true">
  <input type="submit" value="提交">
</form>

防止重复点击

<form action="/submit">
  <input type="submit" value="提交" data-disable-with="提交中...">
</form>

项目安装方式

依赖要求

• jQuery 1.8.x 或更高版本
• HTML5 文档类型（可选）

如果你不使用 HTML5，添加 data 属性可能会导致 HTML4 或 XHTML 页面在 W3C 验证中失败，但这不会影响浏览器或其他用户代理的正常使用。

安装步骤

1. 根据项目需求选择合适的安装方式（如 jquery-rails、npm、Webpacker 或 Bower）。
2. 在项目中引入 jquery 和 jquery_ujs。
3. 根据需要添加 data 属性以启用 jquery-ujs 的功能。

通过以上步骤，你可以在项目中成功安装并使用 jquery-ujs，实现无侵入的脚本适配功能。