yunye 发布的文章

https://blog.csdn.net/lovelessdream/article/details/88424029
https://blog.csdn.net/supergao222/article/details/78629965

CSV 的配置

按你的需求配置 CSV 读取器和写入器:

use Box\Spout\Reader\ReaderFactory;
use Box\Spout\Common\Type;

$reader = ReaderFactory::create(Type::CSV);
$reader->setFieldDelimiter('|');
$reader->setFieldEnclosure('@');
$reader->setEndOfLineCharacter("\r");

另外,如果你需要读取非UTF-8 文件,可以这样指定文件编码:

$reader->setEncoding('UTF-16LE');

默认地, 写入器会以 UTF-8 生成 CSV 文件,并带有BOM。不想要 BOM:

use Box\Spout\Writer\WriterFactory;
use Box\Spout\Common\Type;

$writer = WriterFactory::create(Type::CSV);
$writer->setShouldAddBOM(false);

XLSX 和 ODS 的配置

新建表

It is possible to change the behavior of the writers when the maximum number of rows (1,048,576) has been written in the current sheet. By default, a new sheet is automatically created so that writing can keep going but that may not always be preferable.

use Box\Spout\Writer\WriterFactory;
use Box\Spout\Common\Type;

$writer = WriterFactory::create(Type::ODS);
$writer->setShouldCreateNewSheetsAutomatically(true); // default value
$writer->setShouldCreateNewSheetsAutomatically(false); // will stop writing new data when limit is reached

Using custom temporary folder
Processing XLSX and ODS files requires temporary files to be created. By default, Spout will use the system default temporary folder (as returned by sys_get_temp_dir()). It is possible to override this by explicitly setting it on the reader or writer:

use BoxSpoutWriterWriterFactory;
use BoxSpoutCommonType;

$writer = WriterFactory::create(Type::XLSX);
$writer->setTempFolder($customTempFolderPath);
Strings storage (XLSX writer)
XLSX files support different ways to store the string values:

Shared strings are meant to optimize file size by separating strings from the sheet representation and ignoring strings duplicates (if a string is used three times, only one string will be stored)
Inline strings are less optimized (as duplicate strings are all stored) but is faster to process
In order to keep the memory usage really low, Spout does not de-duplicate strings when using shared strings. It is nevertheless possible to use this mode.

use BoxSpoutWriterWriterFactory;
use BoxSpoutCommonType;

$writer = WriterFactory::create(Type::XLSX);
$writer->setShouldUseInlineStrings(true); // default (and recommended) value
$writer->setShouldUseInlineStrings(false); // will use shared strings
Note on Apple Numbers and iOS support
Apple’s products (Numbers and the iOS previewer) don’t support inline strings and display empty cells instead. Therefore, if these platforms need to be supported, make sure to use shared strings!

Date/Time formatting
When reading a spreadsheet containing dates or times, Spout returns the values by default as DateTime objects. It is possible to change this behavior and have a formatted date returned instead (e.g. “2016-11-29 1:22 AM”). The format of the date corresponds to what is specified in the spreadsheet.

use BoxSpoutReaderReaderFactory;
use BoxSpoutCommonType;

$reader = ReaderFactory::create(Type::XLSX);
$reader->setShouldFormatDates(false); // default value
$reader->setShouldFormatDates(true); // will return formatted dates
Styling rows
It is possible to apply some formatting options to a row. Spout supports fonts, background, borders as well as alignment styles.

use BoxSpoutCommonType;
use BoxSpoutWriterWriterFactory;
use BoxSpoutWriterStyleStyleBuilder;
use BoxSpoutWriterStyleColor;

$style = (new StyleBuilder())

       ->setFontBold()
       ->setFontSize(15)
       ->setFontColor(Color::BLUE)
       ->setShouldWrapText()
       ->setBackgroundColor(Color::YELLOW)
       ->build();

$writer = WriterFactory::create(Type::XLSX);
$writer->openToFile($filePath);

$writer->addRowWithStyle($singleRow, $style); // style will only be applied to this row
$writer->addRow($otherSingleRow); // no style will be applied
$writer->addRowsWithStyle($multipleRows, $style); // style will be applied to all given rows

$writer->close();
Adding borders to a row requires a Border object.

use BoxSpoutCommonType;
use BoxSpoutWriterStyleBorder;
use BoxSpoutWriterStyleBorderBuilder;
use BoxSpoutWriterStyleColor;
use BoxSpoutWriterStyleStyleBuilder;
use BoxSpoutWriterWriterFactory;

$border = (new BorderBuilder())

->setBorderBottom(Color::GREEN, Border::WIDTH_THIN, Border::STYLE_DASHED)
->build();

$style = (new StyleBuilder())

->setBorder($border)
->build();

$writer = WriterFactory::create(Type::XLSX);
$writer->openToFile($filePath);

$writer->addRowWithStyle(['Border Bottom Green Thin Dashed'], $style);

$writer->close();
Spout will use a default style for all created rows. This style can be overridden this way:

$defaultStyle = (new StyleBuilder())

            ->setFontName('Arial')
            ->setFontSize(11)
            ->build();

$writer = WriterFactory::create(Type::XLSX);
$writer->setDefaultRowStyle($defaultStyle)

   ->openToFile($filePath);

Unfortunately, Spout does not support all the possible formatting options yet. But you can find the most important ones:

Category Property API
Font Bold StyleBuilder::setFontBold()

 Italic    StyleBuilder::setFontItalic()
 Underline    StyleBuilder::setFontUnderline()
 Strikethrough    StyleBuilder::setFontStrikethrough()
 Font name    StyleBuilder::setFontName('Arial')
 Font size    StyleBuilder::setFontSize(14)
 Font color    StyleBuilder::setFontColor(Color::BLUE)

StyleBuilder::setFontColor(Color::rgb(0, 128, 255))
Alignment Wrap text StyleBuilder::setShouldWrapText(true|false)
Playing with sheets
When creating a XLSX or ODS file, it is possible to control which sheet the data will be written into. At any time, you can retrieve or set the current sheet:

$firstSheet = $writer->getCurrentSheet();
$writer->addRow($rowForSheet1); // writes the row to the first sheet

$newSheet = $writer->addNewSheetAndMakeItCurrent();
$writer->addRow($rowForSheet2); // writes the row to the new sheet

$writer->setCurrentSheet($firstSheet);
$writer->addRow($anotherRowForSheet1); // append the row to the first sheet
It is also possible to retrieve all the sheets currently created:

$sheets = $writer->getSheets();
If you rely on the sheet’s name in your application, you can access it and customize it this way:

// Accessing the sheet name when reading
foreach ($reader->getSheetIterator() as $sheet) {

$sheetName = $sheet->getName();

}

// Accessing the sheet name when writing
$sheet = $writer->getCurrentSheet();
$sheetName = $sheet->getName();

// Customizing the sheet name when writing
$sheet = $writer->getCurrentSheet();
$sheet->setName('My custom name');
Please note that Excel has some restrictions on the sheet’s name:

it must not be blank
it must not exceed 31 characters
it must not contain these characters: / ? * : [ or ]
it must not start or end with a single quote
it must be unique
Handling these restrictions is the developer’s responsibility. Spout does not try to automatically change the sheet’s name, as one may rely on this name to be exactly what was passed in.

Finally, it is possible to know which sheet was active when the spreadsheet was last saved. This can be useful if you are only interested in processing the one sheet that was last focused.

foreach ($reader->getSheetIterator() as $sheet) {

// only process data for the active sheet
if ($sheet->isActive()) {
    // do something...
}

}
Fluent interface
Because fluent interfaces are great, you can use them with Spout:

use BoxSpoutWriterWriterFactory;
use BoxSpoutCommonType;

$writer = WriterFactory::create(Type::XLSX);
$writer->setTempFolder($customTempFolderPath)

   ->setShouldUseInlineStrings(true)
   ->openToFile($filePath)
   ->addRow($headerRow)
   ->addRows($dataRows)
   ->close();

官方文档:http://opensource.box.com/spout/

支持的电子表格类型

Spout 支持三种类型的电子表格:XLSX、ODS 和 CSV。
Spout 提供简单而统一的 API 来读取或创建不同类型的电子表格。电子表格类型的转换也是令人惊异的简单。

快速,可扩展

读取小型 CSV 文件?没问题!
读取大型 XLSX 文件?无需额外的代码!
写入百万级 ODS 文件?Spout 可以立即实现!

为何使用 Spout ?

  • Spout 能胜任处理任意尺寸文件的任务
  • Spout 仅需 3MB 内存即能处理任意文件
  • Spout 的流机制使其难以置信地快
  • Spout 的 API 面向开发者非常友好

开始使用

本指南用于指导你安装和使用 Spout。

环境要求

  • PHP 5.4.0 以上
  • PHP 扩展 php_zip
  • PHP 扩展 php_xmlreader

安装

Composer (推荐)

$ composer require box/spout

手动安装

首先确保你的系统符合前文提到的环境要求
  • 从 Releases 页面下载源代码
  • 将下载的内容解压到你的项目中
  • 将下面的代码添加到顶级控制器(例如 index.php)或者任意适当位置:

    // don't forget to change the path!
    require_once '[PATH/TO]/src/Spout/Autoloader/autoload.php';

基础用法

读取

不管什么文件类型,读取文件的接口都是一样的:

use Box\Spout\Reader\ReaderFactory;
use Box\Spout\Common\Type;

$reader = ReaderFactory::create(Type::XLSX); // for XLSX files
//$reader = ReaderFactory::create(Type::CSV); // for CSV files
//$reader = ReaderFactory::create(Type::ODS); // for ODS files

$reader->open($filePath);

foreach ($reader->getSheetIterator() as $sheet) {
    foreach ($sheet->getRowIterator() as $row) {
        // do stuff with the row
    }
}

$reader->close();

如果文件里存在多个表,读取器会循序地读取全部表。

写入

类似读取器,将数据写入文件也有通用的接口:

use Box\Spout\Writer\WriterFactory;
use Box\Spout\Common\Type;

$writer = WriterFactory::create(Type::XLSX); // for XLSX files
//$writer = WriterFactory::create(Type::CSV); // for CSV files
//$writer = WriterFactory::create(Type::ODS); // for ODS files

$writer->openToFile($filePath); // write data to a file or to a PHP stream
//$writer->openToBrowser($fileName); // stream data directly to the browser

$writer->addRow($singleRow); // add a row at a time
$writer->addRows($multipleRows); // add multiple rows at a time

$writer->close();

对于 XLSX 和 ODS 文件,每个表的行数上线是 1,048,576。默认地,一旦达到限制行数,写入器会自动创建一个新表再继续写入数据。

高级用法

你可以使用 Spout 做更多事情!查看完整文档了解全部功能。

Turbolinks® 让你的 web 应用导航更快。 无需使用任何复杂的客户端 JavaScript 框架,即能获得单页应用一般的性能。在服务端使用 HTML 渲染视图,用超级链接将页面链接起来,就像你熟知的那样。在你点击链接时,Turbolinks 会自动地获取页面,替换它的 <body>,合并 <head>,这些操作都不会存在整页加载所需的额外花销。

turbolinks.gif

特点

  • 自动优化导航 无须注解链接;无须指定页面上需要改变的部分。
  • 无须后端协作 直接出来整个 HTML 页面,不需要将页面切成片段或者返回 JSON 数据。
  • 符合 web 规范 前进、后退按钮依然如你期望地工作。搜索引擎友好。
  • 支持移动端应用 适配 iOSAndroid,创建混合应用时可以使用原生导航控件。

浏览器支持

Turbolinks 支持所有桌面和移动浏览器。它依赖于 HTML5 History APIWindow.requestAnimationFrame。在不支持的浏览器上,Turbolinks 优雅降级为标准导航。

安装

在应用程序的 JavaScript bundle 中引入 dist/turbolinks.js

Turbolinks automatically initializes itself when loaded via a standalone <script> tag or a traditional concatenated JavaScript bundle. If you load Turbolinks as a CommonJS or AMD module, first require the module, then call the provided start() function.

使用 Ruby on Rails 安装

Your Ruby on Rails application can use the turbolinks RubyGem to install Turbolinks. This gem contains a Rails engine which integrates seamlessly with the Rails asset pipeline.

  1. Add the turbolinks gem, version 5, to your Gemfile: gem 'turbolinks', '~> 5.2.0'
  2. Run bundle install.
  3. Add //= require turbolinks to your JavaScript manifest file (usually found at app/assets/javascripts/application.js).

The gem also provides server-side support for Turbolinks redirection, which can be used without the asset pipeline.

使用 npm 安装

Your application can use the turbolinks npm package to install Turbolinks as a module for build tools like webpack.

  1. Add the turbolinks package to your application: npm install --save turbolinks.
  2. Require and start Turbolinks in your JavaScript bundle:

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

The npm package alone does not provide server-side support for Turbolinks redirection. See Following Redirects for details on adding support.

内容目录

Navigating with Turbolinks

  • Each Navigation is a Visit
  • Application Visits
  • Restoration Visits
  • Canceling Visits Before They Start
  • Disabling Turbolinks on Specific Links

Building Your Turbolinks Application

  • Working with Script Elements

    • Loading Your Application’s JavaScript Bundle
  • Understanding Caching

    • Preparing the Page to be Cached
    • Detecting When a Preview is Visible
    • Opting Out of Caching
  • Installing JavaScript Behavior

    • Observing Navigation Events
    • Attaching Behavior With Stimulus
  • Making Transformations Idempotent
  • Persisting Elements Across Page Loads

Advanced Usage

  • Displaying Progress
  • Reloading When Assets Change
  • Ensuring Specific Pages Trigger a Full Reload
  • Setting a Root Location
  • Following Redirects
  • Redirecting After a Form Submission
  • Setting Custom HTTP Headers

API Reference

  • Turbolinks.visit
  • Turbolinks.clearCache
  • Turbolinks.setProgressBarDelay
  • Turbolinks.supported
  • Full List of Events

Contributing to Turbolinks

  • Building From Source
  • Running Tests

Navigating with Turbolinks

Turbolinks intercepts all clicks on <a href> links to the same domain. When you click an eligible link, Turbolinks prevents the browser from following it. Instead, Turbolinks changes the browser’s URL using the History API, requests the new page using XMLHttpRequest, and then renders the HTML response.

During rendering, Turbolinks replaces the current <body> element outright and merges the contents of the <head> element. The JavaScript window and document objects, and the HTML <html> element, persist from one rendering to the next.

Each Navigation is a Visit

Turbolinks models navigation as a visit to a location (URL) with an action.

Visits represent the entire navigation lifecycle from click to render. That includes changing browser history, issuing the network request, restoring a copy of the page from cache, rendering the final response, and updating the scroll position.

There are two types of visit: an application visit_, which has an action of _advance or _replace_, and a _restoration visit_, which has an action of _restore_.

Application Visits

Application visits are initiated by clicking a Turbolinks-enabled link, or programmatically by calling Turbolinks.visit(location).

An application visit always issues a network request. When the response arrives, Turbolinks renders its HTML and completes the visit.

If possible, Turbolinks will render a preview of the page from cache immediately after the visit starts. This improves the perceived speed of frequent navigation between the same pages.

If the visit’s location includes an anchor, Turbolinks will attempt to scroll to the anchored element. Otherwise, it will scroll to the top of the page.

Application visits result in a change to the browser’s history; the visit’s action determines how.

Advance visit action

The default visit action is _advance_. During an advance visit, Turbolinks pushes a new entry onto the browser’s history stack using history.pushState.

Applications using the Turbolinks iOS adapter typically handle advance visits by pushing a new view controller onto the navigation stack. Similarly, applications using the Android adapter typically push a new activity onto the back stack.

Replace visit action

You may wish to visit a location without pushing a new history entry onto the stack. The replace visit action uses history.replaceState to discard the topmost history entry and replace it with the new location.

To specify that following a link should trigger a replace visit, annotate the link with data-turbolinks-action="replace":

<a href="/edit" data-turbolinks-action="replace">Edit</a>

To programmatically visit a location with the replace action, pass the action: "replace" option to Turbolinks.visit:

Turbolinks.visit("/edit", { action: "replace" })

Applications using the Turbolinks iOS adapter typically handle replace visits by dismissing the topmost view controller and pushing a new view controller onto the navigation stack without animation.

Restoration Visits

Turbolinks automatically initiates a restoration visit when you navigate with the browser’s Back or Forward buttons. Applications using the iOS or Android adapters initiate a restoration visit when moving backward in the navigation stack.

Restore visit action

If possible, Turbolinks will render a copy of the page from cache without making a request. Otherwise, it will retrieve a fresh copy of the page over the network. See Understanding Caching for more details.

Turbolinks saves the scroll position of each page before navigating away and automatically returns to this saved position on restoration visits.

Restoration visits have an action of restore and Turbolinks reserves them for internal use. You should not attempt to annotate links or invoke Turbolinks.visit with an action of restore.

Canceling Visits Before They Start

Application visits can be canceled before they start, regardless of whether they were initiated by a link click or a call to Turbolinks.visit.

Listen for the turbolinks:before-visit event to be notified when a visit is about to start, and use event.data.url (or $event.originalEvent.data.url, when using jQuery) to check the visit’s location. Then cancel the visit by calling event.preventDefault().

Restoration visits cannot be canceled and do not fire turbolinks:before-visit. Turbolinks issues restoration visits in response to history navigation that has already taken place, typically via the browser’s Back or Forward buttons.

Disabling Turbolinks on Specific Links

Turbolinks can be disabled on a per-link basis by annotating a link or any of its ancestors with data-turbolinks="false".

<a href="/" data-turbolinks="false">Disabled</a>

<div data-turbolinks="false">
  <a href="/">Disabled</a>
</div>

To reenable when an ancestor has opted out, use data-turbolinks="true":

<div data-turbolinks="false">
  <a href="/" data-turbolinks="true">Enabled</a>
</div>

Links with Turbolinks disabled will be handled normally by the browser.

Building Your Turbolinks Application

Turbolinks is fast because it doesn’t reload the page when you follow a link. Instead, your application becomes a persistent, long-running process in the browser. This requires you to rethink the way you structure your JavaScript.

In particular, you can no longer depend on a full page load to reset your environment every time you navigate. The JavaScript window and document objects retain their state across page changes, and any other objects you leave in memory will stay in memory.

With awareness and a little extra care, you can design your application to gracefully handle this constraint without tightly coupling it to Turbolinks.

Working with Script Elements

Your browser automatically loads and evaluates any <script> elements present on the initial page load.

When you navigate to a new page, Turbolinks looks for any <script> elements in the new page’s <head> which aren’t present on the current page. Then it appends them to the current <head> where they’re loaded and evaluated by the browser. You can use this to load additional JavaScript files on-demand.

Turbolinks evaluates <script> elements in a page’s <body> each time it renders the page. You can use inline body scripts to set up per-page JavaScript state or bootstrap client-side models. To install behavior, or to perform more complex operations when the page changes, avoid script elements and use the turbolinks:load event instead.

Annotate <script> elements with data-turbolinks-eval="false" if you do not want Turbolinks to evaluate them after rendering. Note that this annotation will not prevent your browser from evaluating scripts on the initial page load.

Loading Your Application’s JavaScript Bundle

Always make sure to load your application’s JavaScript bundle using <script> elements in the <head> of your document. Otherwise, Turbolinks will reload the bundle with every page change.

<head>
  ...
  <script src="/application-cbd3cd4.js" defer></script>
</head>

If you have traditionally placed application scripts at the end of <body> for performance reasons, consider using the <script defer> attribute instead. It has widespread browser support and allows you to keep your scripts in <head> for Turbolinks compatibility.

You should also consider configuring your asset packaging system to fingerprint each script so it has a new URL when its contents change. Then you can use the data-turbolinks-track attribute to force a full page reload when you deploy a new JavaScript bundle. See Reloading When Assets Change for information.

Understanding Caching

Turbolinks maintains a cache of recently visited pages. This cache serves two purposes: to display pages without accessing the network during restoration visits, and to improve perceived performance by showing temporary previews during application visits.

When navigating by history (via Restoration Visits), Turbolinks will restore the page from cache without loading a fresh copy from the network, if possible.

Otherwise, during standard navigation (via Application Visits), Turbolinks will immediately restore the page from cache and display it as a preview while simultaneously loading a fresh copy from the network. This gives the illusion of instantaneous page loads for frequently accessed locations.

Turbolinks saves a copy of the current page to its cache just before rendering a new page. Note that Turbolinks copies the page using cloneNode(true), which means any attached event listeners and associated data are discarded.

Preparing the Page to be Cached

Listen for the turbolinks:before-cache event if you need to prepare the document before Turbolinks caches it. You can use this event to reset forms, collapse expanded UI elements, or tear down any third-party widgets so the page is ready to be displayed again.

document.addEventListener("turbolinks:before-cache", function() {
  // ...
})

Detecting When a Preview is Visible

Turbolinks adds a data-turbolinks-preview attribute to the <html> element when it displays a preview from cache. You can check for the presence of this attribute to selectively enable or disable behavior when a preview is visible.

if (document.documentElement.hasAttribute("data-turbolinks-preview")) {
  // Turbolinks is displaying a preview
}

Opting Out of Caching

You can control caching behavior on a per-page basis by including a <meta name="turbolinks-cache-control"> element in your page’s <head> and declaring a caching directive.

Use the no-preview directive to specify that a cached version of the page should not be shown as a preview during an application visit. Pages marked no-preview will only be used for restoration visits.

To specify that a page should not be cached at all, use the no-cache directive. Pages marked no-cache will always be fetched over the network, including during restoration visits.

<head>
  ...
  <meta name="turbolinks-cache-control" content="no-cache">
</head>

To completely disable caching in your application, ensure every page contains a no-cache directive.

Installing JavaScript Behavior

You may be used to installing JavaScript behavior in response to the window.onload, DOMContentLoaded, or jQuery ready events. With Turbolinks, these events will fire only in response to the initial page load, not after any subsequent page changes. We compare two strategies for connecting JavaScript behavior to the DOM below.

Observing Navigation Events

Turbolinks triggers a series of events during navigation. The most significant of these is the turbolinks:load event, which fires once on the initial page load, and again after every Turbolinks visit.

You can observe the turbolinks:load event in place of DOMContentLoaded to set up JavaScript behavior after every page change:

document.addEventListener("turbolinks:load", function() {
  // ...
})

Keep in mind that your application will not always be in a pristine state when this event is fired, and you may need to clean up behavior installed for the previous page.

Also note that Turbolinks navigation may not be the only source of page updates in your application, so you may wish to move your initialization code into a separate function which you can call from turbolinks:load and anywhere else you may change the DOM.

When possible, avoid using the turbolinks:load event to add other event listeners directly to elements on the page body. Instead, consider using event delegation to register event listeners once on document or window.

See the Full List of Events for more information.

Attaching Behavior With Stimulus

New DOM elements can appear on the page at any time by way of Ajax request handlers, WebSocket handlers, or client-side rendering operations, and these elements often need to be initialized as if they came from a fresh page load.

You can handle all of these updates, including updates from Turbolinks page loads, in a single place with the conventions and lifecycle callbacks provided by Turbolinks’ sister framework, Stimulus.

Stimulus lets you annotate your HTML with controller, action, and target attributes:

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

Implement a compatible controller and Stimulus connects it automatically:

// hello_controller.js
import { Controller } from "stimulus"

export default class extends Controller {
  greet() {
    console.log(`Hello, ${this.name}!`)
  }

  get name() {
    return this.targets.find("name").value
  }
}

Stimulus connects and disconnects these controllers and their associated event handlers whenever the document changes using the MutationObserver API. As a result, it handles Turbolinks page changes the same way it handles any other type of DOM update.

See the Stimulus repository on GitHub for more information.

Making Transformations Idempotent

Often you’ll want to perform client-side transformations to HTML received from the server. For example, you might want to use the browser’s knowledge of the user’s current time zone to group a collection of elements by date.

Suppose you have annotated a set of elements with data-timestamp attributes indicating the elements’ creation times in UTC. You have a JavaScript function that queries the document for all such elements, converts the timestamps to local time, and inserts date headers before each element that occurs on a new day.

Consider what happens if you’ve configured this function to run on turbolinks:load. When you navigate to the page, your function inserts date headers. Navigate away, and Turbolinks saves a copy of the transformed page to its cache. Now press the Back button—Turbolinks restores the page, fires turbolinks:load again, and your function inserts a second set of date headers.

To avoid this problem, make your transformation function _idempotent_. An idempotent transformation is safe to apply multiple times without changing the result beyond its initial application.

One technique for making a transformation idempotent is to keep track of whether you’ve already performed it by setting a data attribute on each processed element. When Turbolinks restores your page from cache, these attributes will still be present. Detect these attributes in your transformation function to determine which elements have already been processed.

A more robust technique is simply to detect the transformation itself. In the date grouping example above, that means checking for the presence of a date divider before inserting a new one. This approach gracefully handles newly inserted elements that weren’t processed by the original transformation.

Persisting Elements Across Page Loads

Turbolinks allows you to mark certain elements as _permanent_. Permanent elements persist across page loads, so that any changes you make to those elements do not need to be reapplied after navigation.

Consider a Turbolinks application with a shopping cart. At the top of each page is an icon with the number of items currently in the cart. This counter is updated dynamically with JavaScript as items are added and removed.

Now imagine a user who has navigated to several pages in this application. She adds an item to her cart, then presses the Back button in her browser. Upon navigation, Turbolinks restores the previous page’s state from cache, and the cart item count erroneously changes from 1 to 0.

You can avoid this problem by marking the counter element as permanent. Designate permanent elements by giving them an HTML id and annotating them with data-turbolinks-permanent.

<div id="cart-counter" data-turbolinks-permanent>1 item</div>

Before each render, Turbolinks matches all permanent elements by id and transfers them from the original page to the new page, preserving their data and event listeners.

Advanced Usage

Displaying Progress

During Turbolinks navigation, the browser will not display its native progress indicator. Turbolinks installs a CSS-based progress bar to provide feedback while issuing a request.

The progress bar is enabled by default. It appears automatically for any page that takes longer than 500ms to load. (You can change this delay with the Turbolinks.setProgressBarDelay method.)

The progress bar is a <div> element with the class name turbolinks-progress-bar. Its default styles appear first in the document and can be overridden by rules that come later.

For example, the following CSS will result in a thick green progress bar:

.turbolinks-progress-bar {
  height: 5px;
  background-color: green;
}

To disable the progress bar entirely, set its visibility style to hidden:

.turbolinks-progress-bar {
  visibility: hidden;
}

Reloading When Assets Change

Turbolinks can track the URLs of asset elements in <head> from one page to the next and automatically issue a full reload if they change. This ensures that users always have the latest versions of your application’s scripts and styles.

Annotate asset elements with data-turbolinks-track="reload" and include a version identifier in your asset URLs. The identifier could be a number, a last-modified timestamp, or better, a digest of the asset’s contents, as in the following example.

<head>
  ...
  <link rel="stylesheet" href="/application-258e88d.css" data-turbolinks-track="reload">
  <script src="/application-cbd3cd4.js" data-turbolinks-track="reload"></script>
</head>

Ensuring Specific Pages Trigger a Full Reload

You can ensure visits to a certain page will always trigger a full reload by including a <meta name="turbolinks-visit-control"> element in the page’s <head>.

<head>
  ...
  <meta name="turbolinks-visit-control" content="reload">
</head>

This setting may be useful as a workaround for third-party JavaScript libraries that don’t interact well with Turbolinks page changes.

Setting a Root Location

By default, Turbolinks only loads URLs with the same origin—i.e. the same protocol, domain name, and port—as the current document. A visit to any other URL falls back to a full page load.

In some cases, you may want to further scope Turbolinks to a path on the same origin. For example, if your Turbolinks application lives at /app, and the non-Turbolinks help site lives at /help, links from the app to the help site shouldn’t use Turbolinks.

Include a <meta name="turbolinks-root"> element in your pages’ <head> to scope Turbolinks to a particular root location. Turbolinks will only load same-origin URLs that are prefixed with this path.

<head>
  ...
  <meta name="turbolinks-root" content="/app">
</head>

Following Redirects

When you visit location /one and the server redirects you to location /two, you expect the browser’s address bar to display the redirected URL.

However, Turbolinks makes requests using XMLHttpRequest, which transparently follows redirects. There’s no way for Turbolinks to tell whether a request resulted in a redirect without additional cooperation from the server.

To work around this problem, send the Turbolinks-Location header in the final response to a visit that was redirected, and Turbolinks will replace the browser’s topmost history entry with the value you provide.

The Turbolinks Rails engine sets Turbolinks-Location automatically when using redirect_to in response to a Turbolinks visit.

Redirecting After a Form Submission

Submitting an HTML form to the server and redirecting in response is a common pattern in web applications. Standard form submission is similar to navigation, resulting in a full page load. Using Turbolinks you can improve the performance of form submission without complicating your server-side code.

Instead of submitting forms normally, submit them with XHR. In response to an XHR submit on the server, return JavaScript that performs a Turbolinks.visit to be evaluated by the browser.

If form submission results in a state change on the server that affects cached pages, consider clearing Turbolinks’ cache with Turbolinks.clearCache().

The Turbolinks Rails engine performs this optimization automatically for non-GET XHR requests that redirect with the redirect_to helper.

Setting Custom HTTP Headers

You can observe the turbolinks:request-start event to set custom headers on Turbolinks requests. Access the request’s XMLHttpRequest object via event.data.xhr, then call the setRequestHeader method as many times as you wish.

For example, you might want to include a request ID with every Turbolinks link click and programmatic visit.

document.addEventListener("turbolinks:request-start", function(event) {
  var xhr = event.data.xhr
  xhr.setRequestHeader("X-Request-Id", "123...")
})

API Reference

Turbolinks.visit

Usage:

Turbolinks.visit(location)
Turbolinks.visit(location, { action: action })

Performs an Application Visit to the given location (a string containing a URL or path) with the specified action (a string, either "advance" or "replace").

If location is a cross-origin URL, or falls outside of the specified root (see Setting a Root Location), or if the value of Turbolinks.supported is false, Turbolinks performs a full page load by setting window.location.

If action is unspecified, Turbolinks assumes a value of "advance".

Before performing the visit, Turbolinks fires a turbolinks:before-visit event on document. Your application can listen for this event and cancel the visit with event.preventDefault() (see Canceling Visits Before They Start).

Turbolinks.clearCache

Usage:

Turbolinks.clearCache()

Removes all entries from the Turbolinks page cache. Call this when state has changed on the server that may affect cached pages.

Turbolinks.setProgressBarDelay

Usage:

Turbolinks.setProgressBarDelay(delayInMilliseconds)

Sets the delay after which the progress bar will appear during navigation, in milliseconds. The progress bar appears after 500ms by default.

Note that this method has no effect when used with the iOS or Android adapters.

Turbolinks.supported

Usage:

if (Turbolinks.supported) {
  // ...
}

Detects whether Turbolinks is supported in the current browser (see Supported Browsers).

Full List of Events

Turbolinks emits events that allow you to track the navigation lifecycle and respond to page loading. Except where noted, Turbolinks fires events on the document object.

  • turbolinks:click fires when you click a Turbolinks-enabled link. The clicked element is the event target. Access the requested location with event.data.url. Cancel this event to let the click fall through to the browser as normal navigation.
  • turbolinks:before-visit fires before visiting a location, except when navigating by history. Access the requested location with event.data.url. Cancel this event to prevent navigation.
  • turbolinks:visit fires immediately after a visit starts.
  • turbolinks:request-start fires before Turbolinks issues a network request to fetch the page. Access the XMLHttpRequest object with event.data.xhr.
  • turbolinks:request-end fires after the network request completes. Access the XMLHttpRequest object with event.data.xhr.
  • turbolinks:before-cache fires before Turbolinks saves the current page to cache.
  • turbolinks:before-render fires before rendering the page. Access the new <body> element with event.data.newBody.
  • turbolinks:render fires after Turbolinks renders the page. This event fires twice during an application visit to a cached location: once after rendering the cached version, and again after rendering the fresh version.
  • turbolinks:load fires once after the initial page load, and again after every Turbolinks visit. Access visit timing metrics with the event.data.timing object.

Contributing to Turbolinks

Turbolinks is open-source software, freely distributable under the terms of an MIT-style license. The source code is hosted on GitHub.
Development is sponsored by Basecamp.

We welcome contributions in the form of bug reports, pull requests, or thoughtful discussions in the GitHub issue tracker.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Building From Source

Turbolinks is written in CoffeeScript and compiled to JavaScript with Blade. To build from source you’ll need a recent version of Ruby. From the root of your Turbolinks directory, issue the following commands to build the distributable files in dist/:

$ gem install bundler
$ bundle install
$ bin/blade build

Running Tests

The Turbolinks test suite is written in TypeScript with the Intern testing library.

To run the tests, first make sure you have the Yarn package manager installed. Follow the instructions for Building From Source above, then run the following commands:

$ cd test
$ yarn install
$ yarn test

If you are testing changes to the Turbolinks source, remember to run bin/blade build before each test run.


© 2018 Basecamp, LLC.

在应用程序中安装 Stimulus,需要用到 stimulus npm 包。或者,在 <script> 标签中加载stimulus.umd.js

使用 webpack

Stimulus 集成了 webpack 资源打包器,可以从应用程序文件夹中自动加载控制器文件。

调用 webpack 的 require.context 助手函数,带上 Stimulus 控制器的目录路径。然后,使用 definitionsFromContext 助手函数将产生的上下文传递到 Application#load 方法:

// src/application.js
import { Application } from "stimulus"
import { definitionsFromContext } from "stimulus/webpack-helpers"

const application = Application.start()
const context = require.context("./controllers", true, /\.js$/)
application.load(definitionsFromContext(context))

Controller Filenames Map to Identifiers

将控制器文件命名为 [identifier]_controller.js,这里的 identifier 对应 HTML 中的每个 data-controller 标识符。

Stimulus 通常使用下划线连接文件名的多个单词。每个下划线在其标识符里都会被翻译为连字符。

还可以使用子文件夹作为命名空间。每个斜线都会在标识符里变成两个连字符。

如果元素,你可以在控制器文件内任意位置使用连字符替换下划线。

控制器如果命名为它的标识符将会是
clipboard_controller.jsclipboard
date_picker_controller.jsdate-picker
users/list_item_controller.jsusers--list-item
local-time-controller.jslocal-time

使用其他构建系统

Stimulus 也能用于其他构建系统,但不再支持自动加载了。你必须在应用程序实例中显式地加载和注册控制器文件:

// src/application.js
import { Application } from "stimulus"

import HelloController from "./controllers/hello_controller"
import ClipboardController from "./controllers/clipboard_controller"

const application = Application.start()
application.register("hello", HelloController)
application.register("clipboard", ClipboardController)

使用 Babel

如果在构建系统中使用 Babel ,你需要安装@babel/plugin-proposal-class-properties 并添加至配置中:

// .babelrc
{
  "presets": ["@babel/preset-env"],
  "plugins": ["@babel/plugin-proposal-class-properties"]
}

不使用任何构建系统

如果不喜欢使用构建系统,可以在 <script> 标签中加载 Stimulus,它可以通过 window.Stimulus 对象全局可用。

定义目标时,使用 static get targets() 方法替换 static targets = […] 类属性,因为它不再元素支持

<!doctype html>
<html>
<head>
  <meta charset="utf-8">
  <script src="https://unpkg.com/stimulus/dist/stimulus.umd.js"></script>
  <script>
    (() => {
      const application = Stimulus.Application.start()

      application.register("hello", class extends Stimulus.Controller {
        static get targets() {
          return [ "name" ]
        }

        // …
      })
    })()
  </script>
<head>
<body>
  <div data-controller="hello">
    <input data-target="hello.name" type="text">
    …
  </div>
</body>
</html>

浏览器支持

Stimulus 支持所有现代浏览器,包括桌面浏览器和手机浏览器。

如果需要支持 IE11 之类的旧版浏览器,需要在加载 Stimulus 前引入 @stimulus/polyfills 包。

import "@stimulus/polyfills"
import { Application } from "stimulus"

const application = Application.start()
// …