jQuery Turbolinks 使用教程

jQuery Turbolinks 使用教程

jquery.turbolinks 💀 Deprecated ⚠️ jQuery plugin for drop-in fix binded events problem caused by Turbolinks 项目地址: https://gitcode.com/gh_mirrors/jq/jquery.turbolinks

---

1. 项目目录结构及介绍

本项目是 jQuery Turbolinks 的一个存档版本，用于解决早期 Turbolinks 使用中绑定事件的问题。以下为项目的主要目录结构及其简要介绍：

• master：主要分支，但因项目已归档，此分支为只读状态。
• CONTRIBUTING.md：贡献指南，指导开发者如何参与项目贡献。
• Gemfile：Rubygem 的依赖描述文件，适用于需要将此库作为 Ruby 库使用的场景。
• Guardfile：用于自动化测试或监视文件变动的配置文件。
• LICENSE.md：项目采用的 MIT 开源许可证文件。
• README.md：项目的说明文档，包含了安装步骤、使用方法和注意事项等关键信息。
• Rakefile：Ruby 任务管理文件，定义了一系列可以执行的任务。
• jquery-turbolinks.gemspec：Rubygem 规范文件，描述了 gem 的元数据和依赖。
• spec：存放项目单元测试和规范测试的目录。
• vendor：
  • assets：
    • javascripts：存放与 jQuery Turbolinks 相关的 JavaScript 文件，核心功能实现所在。
      • jquery.turbolinks.js：主要的 JavaScript 实现文件。

目录结构较为简单，侧重于提供一个简单的解决方案来桥接旧版 Turbolinks 和 jQuery 绑定事件的兼容性问题。

---

2. 项目的启动文件介绍

在 jQuery Turbolinks 这样的库中，并没有传统意义上的“启动文件”。它的集成通常发生在客户端（浏览器端）应用初始化阶段。你不会直接运行一个脚本来“启动”这个项目，而是将其添加到你的 Web 应用的 JavaScript 执行链中，确保在 Turbolinks 和其他依赖之前加载 jquery.turbolinks.js 文件。

典型的使用场景是在 Rails 项目中的资产管道里加入这行代码到你的 application.js 或者对应的 JavaScript 打包文件中：

//= require jquery
//= require jquery.turbolinks
//= require jquery_ujs
//= require turbolinks
// 其他你的 JavaScript 脚本放在这之后

这段引入顺序保证了 jQuery 首先加载，接着是 jquery.turbolinks 来处理由于 Turbolinks 导致的事件绑定问题，然后才是 Turbolinks 本身和其他可能的脚本。

---

3. 项目的配置文件介绍

直接相关于前端使用的配置并不体现在单独的配置文件中。但是，可以通过修改应用程序中的引入顺序或者使用 $.turbo.use() 方法来自定义绑定的事件，达到某种程度上的“配置”目的。

例如，如果你想让 jQuery Turbolinks 响应不同的事件而非默认的 page:load 和 page:fetch，可以在你的 JavaScript 中添加如下定制：

$(document).ready(function() {
  $.turbo.use('pjax:start', 'pjax:end');
});

此外，对于 Rails 项目来说，其配置更多地是在 Gemfile 中添加宝石（gem 'jquery-turbolinks'），以及在 asset pipeline 的配置（上述的 JavaScript 引入顺序）中体现，这些环境配置间接控制了该插件的行为。

总结而言，此项目的核心在于正确集成与配置其JavaScript文件到你的Web应用中，而不是通过传统配置文件的方式进行个性化设置。

jquery.turbolinks 💀 Deprecated ⚠️ jQuery plugin for drop-in fix binded events problem caused by Turbolinks 项目地址: https://gitcode.com/gh_mirrors/jq/jquery.turbolinks