` links inside a `` container.
``` javascript
$(document).pjax('[data-pjax] a, a[data-pjax]', '#pjax-container')
```
When invoking `$.fn.pjax` there are a few different argument styles you can use:
1. `$(document).pjax(delegation selector, options object)`
2. `$(document).pjax(delegation selector, container selector, options object)`
In other words:
1. The first argument must always be a `String` selector used for delegation.
2. The second argument can either be a `String` container selector or an options object.
3. If there are three arguments the second must be the `String` container selector and the third must be the options object.
### `$.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 as the container:
``` javascript
if ($.support.pjax) {
$(document).on('click', 'a[data-pjax]', function(event) {
var container = $(this).closest('[data-pjax-container]')
$.pjax.click(event, {container: container})
})
}
```
**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. This function is experimental but GitHub uses it on [Gist][gist] so give it a shot!
``` javascript
$(document).on('submit', 'form[data-pjax]', function(event) {
$.pjax.submit(event, '#pjax-container')
})
```
### `$.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
pjax fires a number of events regardless of how its invoked.
All events are fired from the container, not the link was clicked.
#### start and end
* `pjax:start` - Fired when pjaxing begins.
* `pjax:end` - Fired when pjaxing ends.
* `pjax:click` - Fired when pjaxified link is clicked.
This pair events fire anytime a pjax request starts and finishes. This includes pjaxing on `popstate` and when pages are loaded from cache instead of making a request.
#### ajax related
* `pjax:beforeSend` - Fired before the pjax request begins. Returning false will abort the request.
* `pjax:send` - Fired after the pjax request begins.
* `pjax:complete` - Fired after the pjax request finishes.
* `pjax:success` - Fired after the pjax request succeeds.
* `pjax:error` - Fired after the pjax request fails. Returning false will prevent the the fallback redirect.
* `pjax:timeout` - Fired if after timeout is reached. Returning false will disable the fallback and will wait indefinitely until the response returns.
`send` and `complete` are a good pair of events to use if you are implementing a loading indicator. They'll only be triggered if an actual request is made, not if it's loaded from cache.
``` javascript
$(document).on('pjax:send', function() {
$('#loading').show()
})
$(document).on('pjax:complete', function() {
$('#loading').hide()
})
```
Another protip: 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()
})
```
### Server side
Server configuration will vary between languages and frameworks. The following example shows how you might configure Rails.
``` ruby
def index
if request.headers['X-PJAX']
render :layout => false
end
end
```
An `X-PJAX` request header is set to differentiate a pjax request from normal XHR requests. In this case, if the request is pjax, we skip the layout html and just render the inner contents of the container.
Check if your favorite server framework supports pjax here: https://gist.github.com/4283721
#### Layout Reloading
Layouts can be forced to do a hard reload 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.
### Legacy API
Pre 1.0 versions used an older style syntax that was analogous to the now deprecated `$.fn.live` api. The current api is based off `$.fn.on`.
``` javascript
$('a[data-pjax]').pjax('#pjax-container')
```
Expanded to
``` javascript
$('a[data-pjax]').live('click', function(event) {
$.pjax.click(event, '#pjax-container')
})
```
The new api
``` javascript
$(document).pjax('a[data-pjax]', '#pjax-container')
```
Which is roughly the same as
``` javascript
$(document).on('click', 'a[data-pjax]', function(event) {
$.pjax.click(event, '#pjax-container')
})
```
**NOTE** The new api gives you control over the delegated element container. `$.fn.live` always bound to `document`. This is what you still want to do most of the time.
## Contributing
```
$ git clone https://github.com/defunkt/jquery-pjax.git
$ cd jquery-pjax/
```
To run the test suite locally, start up the Sinatra test application.
```
$ ruby test/app.rb
== Sinatra/1.3.2 has taken the stage on 4567 for development with backup from WEBrick
$ open http://localhost:4567/
```
[compat]: http://caniuse.com/#search=pushstate
[gist]: https://gist.github.com/