Turbolinks 技术文档

1. 安装指南

使用 npm 安装

在您的项目中，通过 npm 安装 Turbolinks：

npm install --save turbolinks

然后，在您的 JavaScript 文件中引入并启动 Turbolinks：

var Turbolinks = require("turbolinks");
Turbolinks.start();

使用 Ruby on Rails 安装

在 Rails 应用程序中，将 Turbolinks 添加到 Gemfile：

gem 'turbolinks', '~> 5.2.0'

运行 bundle install，然后在您的 JavaScript 清单文件中添加：

//= require turbolinks

2. 项目的使用说明

Turbolinks 通过优化页面导航来加速您的 Web 应用程序。它通过保持当前页面实例活跃并仅替换 body（或部分 body）和 head 中的标题来实现这一点。这种方法类似于 pjax，但 Turbolinks 默认替换整个 body，并允许您指定要替换的元素。

使用 Turbolinks，您需要关注以下事件：

• page:before-change：页面即将更改。
• page:fetch：即将从服务器获取新页面。
• page:receive：已从服务器获取页面，但尚未解析。
• page:before-unload：节点即将更改。
• page:change：节点已更改。
• page:update：与 page:change 和 jQuery 的 ajaxSuccess 同时触发。
• page:load：新的 body 元素已加载到 DOM 中。
• page:partial-load：新元素通过部分替换加载到 DOM 中。
• page:restore：从缓存中加载缓存的 body 元素。
• page:after-remove：从 DOM 或缓存中移除元素后触发。

3. 项目 API 使用文档

以下是一些关键的 Turbolinks API 方法：

• Turbolinks.visit(location)：导航到新位置。
• Turbolinks.replace(location)：替换当前页面而不推送新历史记录。
• Turbolinks.cacheCurrentPage()：缓存当前页面。
• Turbolinks.pagesCached()：查看或设置缓存的页面数。
• Turbolinks.enableTransitionCache()：启用过渡缓存。

4. 项目安装方式

Turbolinks 可以通过 npm 或 Ruby on Rails 的 Gemfile 安装。以下是安装方式的简要概述：

• npm 安装：使用 npm install --save turbolinks 命令，然后在 JavaScript 文件中引入并启动 Turbolinks。
• Rails 安装：将 Turbolinks 添加到 Gemfile，运行 bundle install，并在 JavaScript 清单文件中引用 Turbolinks。