《前端實戰總結》之使用pace.js為你的網站新增載入進度條

徐小夕發表於2019-11-16

前言

最近做網站體驗優化的時候突然發現一個好東西，pace.js(載入進度條外掛)，gzip之後只有幾kb，簡單好用，特地分享出來，也作為自己的一個學習總結。

pace.js介紹

pace.js是一個自動載入頁面進度欄的小外掛,它可以自動監視您的Ajax請求，事件迴圈滯後，文件就緒狀態以及頁面上的元素來確定進度。在ajax導航上，它也能進行監聽,同時他也可以很方便的整合到Wordpress中,例如:

<head>
  <script src="/pace/pace.js"></script>
  <link href="/pace/themes/pace-theme-barber-shop.css" rel="stylesheet" />
</head>
複製程式碼

官網地址: pace.js

下面來展示幾個pace提供的幾個例子,當然我們也可以很方便的基於它去修改成更加定製化的載入進度樣式.

由於官網文件是用全英文寫的,所以我在接下的介紹中會盡量用自己的額語言來向大家介紹其使用過程.

1.配置介紹

Pace是全自動的，無需進行配置即可上手。

如果我們想進行一些調整，請按以下步驟操作：

我們可以window.paceOptions在匯入檔案之前進行設定：

paceOptions = {
  // 禁用元素源
  elements: false,

  // 只在常規下和ajax導航下展示進度條
  // not every request
  restartOnRequestAfter: false
}
複製程式碼

您還可以在指令碼標籤上放置選項：

<script data-pace-options='{ "ajax": false }' src='pace.js'></script>
複製程式碼

如果你使用的是AMD或Browserify，則可以將選項傳遞給start：

define(['pace'], function(pace){
  pace.start({
    document: false
  });
});
複製程式碼

2.主題

Pace包含許多主題，可幫助我們入門。只要包括適當的css檔案。關於如何修改css樣式,我在這裡給大家舉個例子,其實也很方便,如果我們下載了某個主題的css:

.pace {
  -webkit-pointer-events: none;
  pointer-events: none;

  -webkit-user-select: none;
  -moz-user-select: none;
  user-select: none;
}

.pace-inactive {
  display: none;
}

.pace .pace-progress {
  background: #29d;
  position: fixed;
  z-index: 2000;
  top: 0;
  right: 100%;
  width: 100%;
  height: 2px;
}

複製程式碼

我們就可以直接修改它,包括進度條的樣式,形狀等等.

3.收集器

收集器是收集進度資訊的程式碼位。Pace包括四個預設收集器：

ajax 監視頁面上的所有ajax請求
element 檢查頁面上是否存在特定元素
Document 檢查檔案readyState
Event Lag 檢查事件迴圈滯後訊號，表明正在執行javascript

可以通過相同名稱的配置選項分別配置或禁用它們。

paceOptions = {
  ajax: false, // disabled
  document: false, // disabled
  eventLag: false, // disabled
  elements: {
    selectors: ['.my-page']
  }
};
複製程式碼

新增自己的類paceOptions.extraSources以新增更多源。每個源都應該具有一個.progress屬性，或者.elements是具有.progress屬性的物件列表的屬性。Pace將自動處理所有縮放，以使進度更改對使用者而言看起來很平滑。

4.元素

呈現到螢幕上的元素是我們確定頁面呈現的一種方法。如果我們想使用該資訊源（根本不需要），請指定一個或多個選擇器。我們可以使用逗號分隔選擇器，以正確處理錯誤狀態（進度條應消失在錯誤狀態），但我們尋找的元素可能永遠不會出現：

paceOptions = {
  elements: {
    selectors: ['.timeline,.timeline-error', '.user-profile,.profile-error']
  }
}
複製程式碼

當每個選擇器匹配某項時，Pace都會認為元素測試成功。對於此示例，當.timeline或.timeline-error存在時以及.user-profile 或.profile-error存在時。

5.重新啟動規則

大多數使用者希望進度欄在pushState事件發生時自動重新啟動（通常表示正在進行ajax導航）。我們可以禁用此功能：

paceOptions = {
  restartOnPushState: false
}
複製程式碼

我們還可以對持續時間超過x ms的每個ajax請求重新啟動步速。如果我們發出使用者不需要知道的ajax請求（例如預快取），則需要禁用此功能：

paceOptions = {
  restartOnRequestAfter: false
}
複製程式碼

我們隨時可以通過以下方式手動觸發重新啟動

Pace.restart()
複製程式碼

6.API

Pace公開以下方法：

Pace.start：顯示進度條並開始更新。如果您不使用AMD或CommonJS，則會自動呼叫。
Pace.restart：顯示進度條（如果已隱藏），然後從頭開始報告進度。每當pushState或replaceState預設情況下被自動呼叫。
Pace.stop：隱藏進度條並停止對其進行更新。
Pace.track：明確跟蹤一個或多個請求，請參閱下面的跟蹤
Pace.ignore：明確忽略一個或多個請求，請參見下面的跟蹤

在網站中的應用

這裡舉個我自己使用的例子,比如我們在自己的腳手架中的ejs模板中匯入:

<% if(context.env === 'production') { %>
    <script src="<%= context.config.publicPath %>pace.min.js"></script>
<% } else {%>
    <script src="https://cdn.bootcss.com/pace/1.0.2/pace.min.js"></script>
<% } %>
複製程式碼

然後我們再在專案中引入自己的css,這樣我們就能安心的在我們的react/vue專案中使用了.

最後

如果想了解更多webpack，node，gulp，css3，javascript，nodeJS，canvas等前端知識和實戰，歡迎在公眾號《趣談前端》加入我們一起學習討論，共同探索前端的邊界。