# pjax = pushState + ajax, Yii 2.0 fork with enhancements
.--.
/ \
## a a
( '._)
|'-- |
_.\___/_ ___pjax___
."\> \Y/|<'. '._.-'
/ \ \_\/ / '-' /
| --'\_/|/ | _/
|___.-' | |`'`
| | |
| / './
/__./` | |
\ | |
\ | |
; | |
/ | |
jgs |___\_.\_
`-"--'---'
## Introduction
pjax is a jQuery plugin that uses ajax and pushState to deliver a fast browsing experience with real permalinks, page titles, and a working back button.
pjax works by grabbing html from your server via ajax and replacing the content
of a container on your page with the ajax'd html. It then updates the browser's
current URL using pushState without reloading your page's layout or any
resources (JS, CSS), giving the appearance of a fast, full page load. But really
it's just ajax and pushState.
For [browsers that don't support pushState][compat] pjax fully degrades.
## Overview
pjax is not fully automatic. You'll need to setup and designate a containing element on your page that will be replaced when you navigate your site.
Consider the following page.
``` html
<!DOCTYPE html>
<html>
<head>
<!-- styles, scripts, etc -->
</head>
<body>
<h1>My Site</h1>
<div class="container" id="pjax-container">
Go to <a href="/page/2">next page</a>.
</div>
</body>
</html>
```
We want pjax to grab the URL `/page/2` then replace `#pjax-container` with
whatever it gets back. No styles or scripts will be reloaded and even the `<h1>`
can stay the same - we just want to change the `#pjax-container` element.
We do this by telling pjax to listen on `a` tags and use `#pjax-container` as the target container:
``` javascript
$(document).pjax('a', '#pjax-container')
```
Now when someone in a pjax-compatible browser clicks "next page" the content of `#pjax-container` will be replaced with the body of `/page/2`.
Magic! Almost. You still need to configure your server to look for pjax requests and send back pjax-specific content.
The pjax ajax request sends an `X-PJAX` header so in this example (and in most cases) we want to return just the content of the page without any layout for any requests with that header.
Here's what it might look like in 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][].
Also check out [RailsCasts #294: Playing with PJAX][railscasts].
## Installation
### Yii 2.0
There's no need to install library manually since it comes pre-installed with Yii 2.0.
### bower
Via [Bower][]:
```
$ bower install yii2-pjax
```
Or, add `yii2-pjax` to your app's `bower.json`.
``` json
"dependencies": {
"yii2-pjax": "latest"
}
```
### standalone
pjax can be downloaded directly into your app's public directory - just be sure you've loaded jQuery first.
```
curl -LO https://raw.github.com/yiisoft/jquery-pjax/master/jquery.pjax.js
```
**WARNING** Do not hotlink the raw script url. GitHub is not a CDN.
## Dependencies
Requires jQuery 1.8.x or higher.
## Compatibility
pjax only works with [browsers that support the `history.pushState`
API][compat]. When the API isn't supported pjax goes into fallback mode:
`$.fn.pjax` calls will be a no-op and `$.pjax` will hard load the given URL.
For debugging purposes, you can intentionally disable pjax even if the browser supports `pushState`. Just call `$.pjax.disable()`. To see if pjax is actually supports `pushState`, check `$.support.pjax`.
## Usage
### `$.fn.pjax`
Let's talk more about the most basic way to get started:
``` javascript
$(document).pjax('a', '#pjax-container')
```
This will enable pjax on all links and designate the container as `#pjax-container`.
If you are migrating an existing site you probably don't want to enable pjax everywhere just yet. Instead of using a global selector like `a` try annotating pjaxable links with `data-pjax`, then use `'a[data-pjax]'` as your selector.
Or try this selector that matches any `<a data-pjax href=>` links inside a `<div data-pjax>` container.
``` javascript
$(document).pjax('[data-pjax] a, a[data-pjax]', '#pjax-container')
```
#### 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
`pushRedirect` | false | whether to add a browser history entry upon redirect
`replaceRedirect` | true | whether to replace URL without adding a browser history entry upon redirect
`skipOuterContainers` | false | When pjax containers are nested and this option is true, the closest pjax block will handle the event. Otherwise, the top container will handle the event
`ieRedirectCompatibility` | true | Whether to add `X-Ie-Redirect-Compatibility` header for the request on IE. Fixes IE error on 302 redirect without `Location` header
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 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.
``` 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, not the link that was clicked.
<table>
<tr>
<th>event</th>
<th>cancel</th>
<th>arguments</th>
<th>notes</th>
</tr>
<tr>
<th colspan=4>event lifecycle upon following a pjaxed link</th>
</tr>
<tr>
<td><code>pjax:clic
PHP实例开发源码-极简论坛系统源码 php版.zip （1234个子文件） 
yii.bat 515B bootstrap.css 143KB bootstrap.min.css 118KB bootstrap.min.css 118KB font-awesome.min.css 30KB jquery-ui.min.css 29KB bootstrap-theme.css 26KB wbbtheme.css 25KB bootstrap-theme.min.css 23KB select2.min.css 15KB default.css 10KB smd.css 8KB lightbox.css 4KB uploadfile.css 3KB uploadfile.custom.css 3KB lightbox.min.css 3KB jquery.tagit.css 1KB authchoice.css 930B share.css 101B params.php.default 2KB db.php.default 243B plugins.php.default 141B fontawesome-webfont.eot 162KB glyphicons-halflings-regular.eot 20KB wysibbiconfont-wb.eot 4KB
loading.gif 8KB load.gif 2KB view_reference.gif 64B grey.gif 43B .gitignore 27B .gitignore 1B .htaccess 209B .htaccess 31B .htaccess 14B
demo.html 1KB index.html 0B index.html 0B index.html 0B index.html 0B index.html 0B index.html 0B favicon.ico 1KB
line.jpg 685B jquery.js 252KB jquery-ui.min.js 235KB jquery.slim.js 204KB jquery.inputmask.bundle.js 163KB inputmask.js 99KB jquery-1.12.2.min.js 95KB typeahead.bundle.js 94KB jquery-1.11.3.min.js 94KB jquery-1.11.3.min.js 94KB jquery.min.js 84KB jquery.inputmask.bundle.min.js 70KB bootstrap.js 68KB jquery.slim.min.js 67KB typeahead.jquery.js 62KB jquery.wysibb.min.js 62KB select2.min.js 61KB jquery.inputmask.bundle.min.js 57KB inputmask.min.js 42KB typeahead.bundle.min.js 39KB bootstrap.min.js 36KB bootstrap.min.js 36KB jquery.uploadfile.js 35KB jquery.inputmask.min.js 34KB bloodhound.js 32KB yii.activeForm.js 31KB inputmask.numeric.extensions.js 29KB jquery.pjax.js 28KB marked.js 27KB typeahead.jquery.min.js 26KB inputmask.date.extensions.js 24KB jquery.inputmask.date.extensions.js 22KB jquery.inputmask.numeric.extensions.js 20KB yii.js 18KB simpleforum.js 15KB yii.validation.js 15KB jquery.uploadfile.min.js 15KB punycode.js 14KB jquery.qrcode.min.js 14KB inputmask.numeric.extensions.min.js 13KB bloodhound.min.js 13KB jquery.selection.js 13KB inputmask.date.extensions.min.js 10KB jquery.inputmask.numeric.extensions.min.js 9KB jquery.inputmask.date.extensions.min.js 9KB smd.js 9KB tag-it.min.js 9KB lightbox.min.js 8KB jquery.inputmask.regex.extensions.js 8KB inputmask.regex.extensions.js 8KB yii.gridView.js 7KB jquery.inputmask.extensions.js 5KB respond.min.js 4KB jquery.lazyload.min.js 3KB inputmask.regex.extensions.min.js 3KB inputmask.extensions.js 3KB jquery.inputmask.regex.extensions.min.js 3KB punycode.min.js 3KB共 1234 条
- 1
- 2
- 3
- 4
- 5
- 6
- 13
资源评论
