` container:
``` javascript
$(document).pjax('[data-pjax] a, a[data-pjax]', '#pjax-container')
```
#### Server-side configuration
Ideally, your server should detect pjax requests by looking at the special
`X-PJAX` HTTP header, and render only the HTML meant to replace the contents of
the container element (`#pjax-container` in our example) without the rest of
the page layout. Here is an example of how this might be done in Ruby on Rails:
``` ruby
def index
if request.headers['X-PJAX']
render :layout => false
end
end
```
If you'd like a more automatic solution than pjax for Rails check out [Turbolinks][].
[Check if there is a pjax plugin][plugins] for your favorite server framework.
Also check out [RailsCasts #294: Playing with PJAX][railscasts].
#### Arguments
The synopsis for the `$.fn.pjax` function is:
``` javascript
$(document).pjax(selector, [container], options)
```
1. `selector` is a string to be used for click [event delegation][$.fn.on].
2. `container` is a string selector that uniquely identifies the pjax container.
3. `options` is an object with keys described below.
##### pjax options
key | default | description
----|---------|------------
`timeout` | 650 | ajax timeout in milliseconds after which a full refresh is forced
`push` | true | use [pushState][] to add a browser history entry upon navigation
`replace` | false | replace URL without adding browser history entry
`maxCacheLength` | 20 | maximum cache size for previous container contents
`version` | | a string or function returning the current pjax version
`scrollTo` | 0 | vertical position to scroll to after navigation. To avoid changing scroll position, pass `false`.
`type` | `"GET"` | see [$.ajax][]
`dataType` | `"html"` | see [$.ajax][]
`container` | | CSS selector for the element where content should be replaced
`url` | link.href | a string or function that returns the URL for the ajax request
`target` | link | eventually the `relatedTarget` value for [pjax events](#events)
`fragment` | | CSS selector for the fragment to extract from ajax response
You can change the defaults globally by writing to the `$.pjax.defaults` object:
``` javascript
$.pjax.defaults.timeout = 1200
```
### `$.pjax.click`
This is a lower level function used by `$.fn.pjax` itself. It allows you to get a little more control over the pjax event handling.
This example uses the current click context to set an ancestor element as the container:
``` javascript
if ($.support.pjax) {
$(document).on('click', 'a[data-pjax]', function(event) {
var container = $(this).closest('[data-pjax-container]')
var containerSelector = '#' + container.id
$.pjax.click(event, {container: containerSelector})
})
}
```
**NOTE** Use the explicit `$.support.pjax` guard. We aren't using `$.fn.pjax` so we should avoid binding this event handler unless the browser is actually going to use pjax.
### `$.pjax.submit`
Submits a form via pjax.
``` javascript
$(document).on('submit', 'form[data-pjax]', function(event) {
$.pjax.submit(event, '#pjax-container')
})
```
### `$.pjax.reload`
Initiates a request for the current URL to the server using pjax mechanism and replaces the container with the response. Does not add a browser history entry.
``` javascript
$.pjax.reload('#pjax-container', options)
```
### `$.pjax`
Manual pjax invocation. Used mainly when you want to start a pjax request in a handler that didn't originate from a click. If you can get access to a click `event`, consider `$.pjax.click(event)` instead.
``` javascript
function applyFilters() {
var url = urlForFilters()
$.pjax({url: url, container: '#pjax-container'})
}
```
## Events
All pjax events except `pjax:click` & `pjax:clicked` are fired from the pjax
container element.
| event |
cancel |
arguments |
notes |
| event lifecycle upon following a pjaxed link |
pjax:click |
✔︎ |
options |
fires from a link that got activated; cancel to prevent pjax |
pjax:beforeSend |
✔︎ |
xhr, options |
can set XHR headers |
pjax:start |
|
xhr, options |
|
pjax:send |
|
xhr, options |
|
pjax:clicked |
|
options |
fires after pjax has started from a link that got clicked |
pjax:beforeReplace |
|
contents, options |
before replacing HTML with content loaded from the server |
pjax:success |
|
data, status, xhr, options |
after replacing HTML content loaded from the server |
pjax:timeout |
✔︎ |
xhr, options |
fires after options.timeout; will hard refresh unless canceled |
pjax:error |
✔︎ |
xhr, textStatus, error, options |
on ajax error; will hard refresh unless canceled |
pjax:complete |
|
xhr, textStatus, options |
always fires after ajax, regardless of result |
pjax:end |
|
xhr, options |
|
| event lifecycle on browser Back/Forward navigation |
pjax:popstate |
|
|
event direction property: "back"/"forward" |
pjax:start |
|
null, options |
before replacing content |
pjax:beforeReplace |
|
contents, options |
right before replacing HTML with content from cache |
pjax:end |
|
null, options |
after replacing content |
`pjax:send` & `pjax:complete` are a good pair of events to use if you are implementing a
loading indicator. They'll only be triggered if an actual XHR request is made,
not if the content is loaded from cache:
``` javascript
$(document).on('pjax:send', function() {
$('#loading').show()
})
$(document).on('pjax:complete', function() {
$('#loading').hide()
})
```
An example of canceling a `pjax:timeout` event would be to disable the fallback
timeout behavior if a spinner is being shown:
``` javascript
$(document).on('pjax:timeout', function(event) {
// Prevent default timeout redirection behavior
event.preventDefault()
})
```
## Advanced configuration
### Reinitializing plugins/widget on new page content
The whole point of pjax is that it fetches and inserts new content _without_
refreshing the page. However, other jQuery plugins or libraries that are set to
react on page loaded event (such as `DOMContentLoaded`) will not pick up on
these changes. Therefore, it's usually a good idea to configure these plugins to
reinitialize in the scope of the updated page content. This can be done like so:
``` js
$(document).on('ready pjax:end', function(event) {
$(event.target).initializeMyPlugin()
})
```
This will make `$.fn.initializeMyPlugin()` be called at the document level on
normal page load, and on the container level after any pjax navigation (either
after clicking on a link or going Back in the browser).
### Response types that force a reload
By default, pjax will force a full reload of the page if it receives one of the
following responses from the server:
* Page content that includes `` when `fragment` selector wasn't explicitly
configured. Pjax presumes that the server's response hasn't been properly
configured for pjax. If `fragment` pjax option is given, pjax will extract the
content based on that selector.
* Page content that is blank. Pjax assumes that the server is unable to deliver
proper pjax contents.
* HTTP response code that is 4xx or 5xx, indicating some server error.
### Affecting the browser URL
If the server needs to affect the URL which will appear in the browser URL after
pjax navigation (like HTTP redirects work for normal requests), it can set the
`X-PJAX-URL` header:
``` ruby
def index
request.headers['X-PJAX-URL'] = "http://example.com/hello"
end
```
### Layout Reloading
Layouts can be forced to do a hard reload when assets or html changes.
First set the initial layout version in your header with a custom meta tag.
``` html
```
Then from the server side, set the `X-PJAX-Version` header to the same.
``` ruby
if request.headers['X-PJAX']
response.headers['X-PJAX-Version'] = "v123"
end
```
Deploying a deploy, bumping the version constant to force clients to do a full reload the next request getting the new layout and assets.
```javascript
/**
* @author JuniorRay
* @date 2020年2月19日
* @description 修改pjax源码添加xhr请求头配置便于个性化操作xhrRequestHead="hasSubMenu"
* **/
$.pjax({
url: url
, container: container
,xhrRequestHead : xhrRequestHead
});
```
通过xhrRequestHead通过ssr服务端渲染不同的布局，在pjax的基础上精细操作
示范：
```javascript
$(function(){
console.error("页面被刷新，请检查代码（如果是浏览器刷新动作请忽略该信息）")
// pjax 绑定菜单点击事件
$("#menu").on("click","li a",function(event){
// debugger;
var that= $(this);
clickMenu(event,$(that));
})
$("#pjax-container").on("click",".subMenu li div",function(event){
// debugger;
var that= $(this);
clickMenu(event,$(that));
})
});
/**
* 点击菜单
*/
function clickMenu(event,that) {
event.preventDefault(); // 取代 return false 防止页面跳转
var $this = $(that);
var url = $this.attr("href");
if(Utils.isBlank(url)){
url = $this.attr("href")
}
// debugger
if(!Utils.isBlank(url)){
if(url.indexOf("http")==-1){
url="http://"+window.location.hostname+":"+window.location.port+url;
}
}
var isFilterMenu=false;
if(url.indexOf("/trace")!=-1){
var filterList=["car","road","store","carManage","waterlogging"];//过滤正在开发中的路由菜单
for(var i in filterList){
if(url.indexOf(filterList[i])!=-1){
isFilterMenu=true;
break;
}
}
}
//显示正在开发中的操作
if(isFilterMenu){
alert("功能正在开发中");
event.preventDefault();//阻止a标签的默认事件
return false;
}
/***hasSubMenu代表是否有子菜单，Junior修改了pjax源码，会发送一个请求头XHR.request请求头到服务器**/
var hasSubMenu=$this.parents("li").attr("hasSubMenu");
// alert('hasSubMenu=='+hasSubMenu);
// debugger
if(hasSubMenu=='false'){//没有子菜单走这个
// alert('没有二级菜单')
sendPjax(url, "#pjax-container");
}else{//有子菜单则会发一个XHR请求头hasSubMenu到服务器
// alert('有二级菜单')
sendPjax(url, "#pjax-container",xhrRequestHead="hasSubMenu");
}
}
/**
* 发送 pjax
* url：后台 action
* container：承载响应内容的容器
* extData：扩展数据，可以在 pajx 事件回调方法中通过 options.extData 获取
* 例如：$(document).on('pjax:success', function(event, data, status, xhr, options)
*/
function sendPjax(url, container, xhrRequestHead) {
// Disable pushState behavior.
// This is the case when a browser doesn't support pushState. It is
// sometimes useful to disable pushState for debugging on a modern
// browser.
// $.pjax.disable();//禁用前进后退记录
/***
* @author JuniorRay
* @date 2020年2月19日
* @description 修改pjax源码添加xhr请求头配置便于个性化操作xhrRequestHead="hasSubMenu"
* **/
$.pjax({
url: url
, container: container
,xhrRequestHead : xhrRequestHead
});
}
```
[$.fn.on]: http://api.jquery.com/on/
[$.ajax]: http://api.jquery.com/jQuery.ajax/
[pushState]: https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Manipulating_the_browser_history#Adding_and_modifying_history_entries
[plugins]: https://gist.github.com/4283721
[turbolinks]: https://github.com/rails/turbolinks
[railscasts]: http://railscasts.com/episodes/294-playing-with-pjax