pushState 是一組可以操作 history 的 API,關於它的介紹與用法可參考 pushState 的相關文章。目前 GitHub、Google+ 等網站都已經在用了。
pjax 則是 ajax + pushState 的封裝,讓你能很輕鬆地把 pushState 技術接進專案。它同時支援快取與本地儲存,下次造訪時直接讀本地資料,不必再打一次後端;呈現方式也支援動畫,可以沿用內建效果,也可以自訂。
簡單說,pjax 讓你只刷新頁面上真正需要更新的那一塊,告別整頁重載帶來的閃屏。以前我看過 pjax 並寫過 demo,也留了筆記,但 jQuery 1.9 把 live() 移除之後,新版 pjax 改用 on() 實作,最近專案剛好用到,就順手更新一份筆記。
下面的寫法監控所有 class 為 pjaxlink 的連結,把目標頁面中 id 為 ToInsert 的容器內容抓回來,更新到本頁 id 為 Content 的容器;若抓取時間超過 5 秒則直接跳轉。
程式碼如下:
$(document).pjax('a.pjaxlink', '#Content', {fragment:'#ToInsert', timeout:5000});
原本頁面的翻頁是靠整頁跳轉。我在完全不改動後端輸出的前提下,用 pjax 攔截所有翻頁連結,只更新列表區域——前提是列表容器必須是分頁容器的父節點。
程式碼如下:
if ($.support.pjax) {
//遍歷所有分頁容器
$('.pagercontainer').each(function(){
//取得列表容器
$listcontainer=$(this).parent();
//取得列表容器的 ID
var listcontainerid=$listcontainer.attr('id');
//用 pjax 監控所有分頁連結並定義更新範圍
$(document).pjax('#'+listcontainerid+' .pagercontainer a', '#'+listcontainerid, {fragment:'#'+listcontainerid, timeout:5000});
});
$(document).on('pjax:send', function() {
//請求送出時顯示 loading 動畫層
$('#loading').show();
});
$(document).on('pjax:complete', function() {
//處理完成後隱藏 loading 動畫層
//速度太快會讓 loading 層閃爍,反而影響體驗,所以加上 500 毫秒延遲
setTimeout(function(){$('#loading').hide()},500);
});
}
實作時有幾點值得注意:$.support.pjax 這個判斷能避免在不支援 pushState 的環境下白做工;pjax:send 與 pjax:complete 是一對很好用的生命週期鉤子,拿來控制 loading 動畫剛剛好;而那個 500 毫秒的延遲看似多此一舉,實際上正好解決了「太快完成導致提示閃一下」的尷尬。