最近在开发一款 hexo 主题 3-hexo,其中使用了 pjax 大大提高了用户体验和加载速度,在此简单介绍一下 pjax 的用法 github 链接

# pjax 是什么

pjax 是一款 jQuery 插件,使用了 ajax 和 pushState 的技术,在保留真正永久链接,网页标题和可用的返回功能的情况下,带来一种快速的浏览体验。 -- 官方介绍

用人话说 ,就是当跳转过去的网页和当前网页的一部分是一样的,这时可以通过 pjax 只取回你想要的(不同的那部分),而不必取回
整个页面。

这样做的优势:

  1. 由于从服务器取回的数据量变少,加载速度将会提升。
  2. 并且采用异步刷新页面中的那部分不一样的地方,用户体验也是满满的。
  3. 保留了浏览器回退的功能(解决了 ajax 的尴尬)

好了,开始操作。

# Demo

第一步:引入 jQuery 和 jQuery.pjax

<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery.pjax/1.9.6/jquery.pjax.min.js"></script>

第二步:将指定的 a 的链接,转为 pjax 风格

/* 将 #menu 中的 a 的链接的页面,只取回 class=pjax 元素中的内容,替换掉当前页面 class=pjax 元素中的内容 */
$(document).pjax('.#menu a', '.pjax', {fragment:'.pjax', timeout:8000});

第三步:如果需要在请求的过程中做一些自定义的事件,可以使用下面的方法

$(document).on({
  'pjax:click': function() {
    // 点击链接时,需要触发的事件写到这里
  },
  'pjax:start': function() {
    // 当开始获取请求时,需要触发的事件写在这里
  },
  'pjax:end': function() {
    // 当请求完成后,需要触发的事件写在这里
  }
});

结束。

# 详细文档

翻译于官方

# 参数

$(document).pjax(selector, [container], options)
  1. selector 触发点击事件的选择器,String 类型
  2. container 一个选择器,为唯一的 pjax 容器
  3. options 一个可以包含下面这些选项的对象

# pjax options

keydefaultdescription
timeout650ajax 超时时间,单位毫秒,超时后将请求整个页面进行刷新
pushtrue使用 pushState 添加一个浏览器历史导航条目
replacefalse替换 URL,而不添加浏览器历史条目
maxCacheLength20历史内容 cache 的最大 size
versionstring : 当前 pjax 版本
scrollTo0垂直位置滚动,为了避免改变滚动条位置
type"GET"可以查看 jQuery.ajax ()
dataType"html"可以查看 jQuery.ajax ()
containercss 选择器,此元素内容将被替换
urllink.hrefstring: ajax 请求的 URL
targetlinkeventually the relatedTarget value for pjax events
fragment从 ajax 响应的页面中抽取的‘片段’

# Events

除了 pjax:clickpjax:clicked 外的所有 pjax 事件从 pjax 容器中触发,是不需要点击链接的。
所有事件的生命周期在通过 pjax 请求链接的过程中

eventcancelargumentsnotes
pjax:click✔︎options在一个链接被激活(点击)时触发此事件,可以在此取消阻止 pjax
pjax:beforeSend✔︎xhr, options可以设置 XHR 头
pjax:startxhr, options
pjax:sendxhr, options
pjax:clickedoptions当链接被点击,并且已经开始 pjax 请求后触发
pjax:beforeReplacecontents, options从服务器已经加载到 HTML 内容,在替换 HTML 内容之前触发
pjax:successdata, status, xhr, options从服务器已经加载到 HTML 内容,在替换 HTML 内容之后触发
pjax:timeout✔︎xhr, options页面将会在 options.timeout 之后直接发起请求刷新页面,除非取消 pjax
pjax:error✔︎xhr, textStatus, error, optionsajax 错误,将会请求刷新页面,除非取消 pjax
pjax:completexhr, textStatus, options不管结果是什么,在 ajax 后,都触发
pjax:endxhr, options

生命周期在浏览器返回或前进时触发

eventcancelargumentsnotes
pjax:popstate事件方向 (前进,后退) 属性: "back"/"forward"
pjax:startnull, options替换内容前
pjax:beforeReplacecontents, options从 cache 中读取内容后,替换 html 前
pjax:endnull, options替换内容后