# 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的G2EX微社区 php版.zip
版权申诉
197 浏览量
2023-07-20
07:56:45
上传
评论
收藏 6.02MB ZIP 举报
基于PHP的G2EX微社区 php版.zip （2085个子文件） 
yii.bat 515B bootstrap.css 143KB bootstrap.min.css 118KB bootstrap.min.css 118KB font-awesome.min.css 30KB jquery-ui.min.css 29KB style.css 27KB bootstrap-theme.css 26KB wbbtheme.css 25KB bootstrap-datepicker3.standalone.css 23KB bootstrap-theme.min.css 23KB bootstrap-datepicker3.css 22KB bootstrap-datepicker3.standalone.min.css 21KB bootstrap-datepicker3.min.css 21KB bootstrap-datepicker.standalone.css 18KB bootstrap-datepicker.css 17KB bootstrap-datepicker.standalone.min.css 16KB bootstrap-datepicker.min.css 15KB select2.min.css 14KB mobile.css 9KB smd.css 8KB desktop.css 8KB lightbox.css 4KB uploadfile.custom.css 3KB lightbox.min.css 3KB monokai_sublime.min.css 2KB iconfont.css 2KB jquery.tagit.css 1KB uploadfile.css 1KB authchoice.css 930B authchoice.css 930B authchoice.css 930B bootstrap-daterangepicker.css 624B share.css 99B mask_177_6.dat 441B mask_173_6.dat 429B mask_177_7.dat 407B frame_40.dat 406B mask_173_7.dat 405B frame_39.dat 404B mask_165_6.dat 400B mask_161_6.dat 399B mask_169_6.dat 391B mask_169_7.dat 383B frame_37.dat 376B mask_161_7.dat 376B mask_165_7.dat 375B frame_36.dat 370B mask_149_6.dat 370B mask_177_5.dat 369B mask_153_6.dat 367B mask_173_5.dat 362B frame_38.dat 358B mask_141_6.dat 357B mask_145_6.dat 357B mask_137_6.dat 355B mask_149_7.dat 351B mask_153_7.dat 351B mask_145_7.dat 349B frame_33.dat 343B frame_35.dat 342B mask_169_5.dat 336B mask_165_5.dat 332B frame_34.dat 331B mask_157_6.dat 331B mask_137_7.dat 331B mask_141_7.dat 330B frame_32.dat 329B frame_31.dat 328B mask_161_5.dat 328B frame_30.dat 324B frame_28.dat 318B mask_157_7.dat 316B mask_177_3.dat 312B mask_129_6.dat 310B frame_29.dat 309B mask_121_6.dat 309B mask_153_5.dat 307B mask_173_3.dat 307B mask_149_5.dat 306B mask_125_6.dat 305B mask_113_6.dat 303B mask_121_7.dat 301B mask_117_6.dat 300B mask_145_5.dat 300B mask_177_4.dat 300B mask_173_4.dat 299B mask_141_5.dat 297B mask_169_4.dat 297B mask_133_6.dat 296B frame_26.dat 296B mask_137_5.dat 292B mask_161_4.dat 292B mask_165_4.dat 292B mask_125_7.dat 288B frame_24.dat 287B mask_169_3.dat 286B frame_27.dat 284B mask_113_7.dat 283B mask_129_7.dat 282B共 2085 条
- 1
- 2
- 3
- 4
- 5
- 6
- 21
资源评论
