You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<p>The <code>auto-pjax.js</code> is a jQuery plugin that uses ajax, <code>pushState</code> and automatically detects links and forms, for configure page you need use <code>id="pjax-container"</code> in all pages, example:</p>
1018
+
<p>The <code>Pjax.js</code> is <s>a jQuery plugin</s> script that uses ajax, <code>pushState</code> and automatically detects links and forms, for configure page you need use <code>id="pjax-container"</code> in all pages, example:</p>
Copy file name to clipboardexpand all lines: README.md
+15-14
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
## Automatic Pjax
2
2
3
-
The `auto-pjax.js` is a jQuery plugin that uses ajax, `pushState` and automatically detects links and forms, for configure page you need use `id="pjax-container"` in all pages, example:
3
+
The `Pjax.js` is <s>a jQuery plugin</s> script that uses ajax, `pushState` and automatically detects links and forms, for configure page you need use `id="pjax-container"` in all pages, example:
4
4
5
5
```html
6
6
<divid="pjax-container">
@@ -32,13 +32,13 @@ Requirements:
32
32
For use:
33
33
34
34
```js
35
-
$.autoPjax();
35
+
Pjax.start();
36
36
```
37
37
38
38
For change configs use like this:
39
39
40
40
```js
41
-
$.autoPjax({
41
+
Pjax.start({
42
42
containers: [ "#my-container" ], //Change container element
43
43
scrollLeft:-1, //Disable autoscroll
44
44
scrollTop:-1//Disable autoscroll
@@ -50,6 +50,7 @@ $.autoPjax({
50
50
Property | type | default | Description
51
51
--- | --- | --- | ---
52
52
`containers:` | `array` | `[ "#pjax-container" ]` | Informs which elements to update on the page
53
+
`updatecurrent:` | `bool` | `false` |
53
54
`updatehead:` | `bool` | `true` | The "autopjax" has an intelligent update system that helps avoid the "blink" effect, because instead of updating everything it only updates what has been changed, however if you are sure that nothing will change as you page, you can set it to false ", The only one that will continue to be updated will be the `<title>` tag.
54
55
`scrollLeft:` | `number` | `0` | After loading a page via PJAX you can define where scrollLeft should scroll.
55
56
`scrollTop:` | `number` | `0` | After loading a page via PJAX you can define where scrollTop should scroll.
@@ -77,7 +78,7 @@ You can change the element you want to update or even add more elements, eg.:
77
78
...
78
79
</div>
79
80
<script>
80
-
$.autoPjax({
81
+
Pjax.start({
81
82
containers: [ "#navbar", "#my-container" ] //Change containers element
82
83
});
83
84
</script>
@@ -87,11 +88,11 @@ $.autoPjax({
87
88
88
89
Method | Description
89
90
--- | ---
90
-
`$.autoPjax("remove");` | Remove PJAX requests and events
91
-
`$(document).on("pjax.initiate", function(event, url, config) {...});` | Trigged when clicked in a link or submit a form
92
-
`$(document).on("pjax.done", function(event, url) {...});` | Trigged when page loaded using `$.jax`
93
-
`$(document).on("pjax.fail", function(event, url, status, error) {...});` | Trigged when page failed to load, `status` return HTTP code and `error` return message error
94
-
`$(document).on("pjax.then", function(event, url) {...});` | Executes every time a request is completed, even if it fails or succeeds.
91
+
`Pjax.remove("remove");` | Remove PJAX requests and events
92
+
`Pjax.on("initiate", function(event, url, config) {...});` | Trigged when clicked in a link or submit a form
93
+
`Pjax.on("done", function(event, url) {...});` | Trigged when page loaded using `$.jax`
94
+
`Pjax.on("fail", function(event, url, status, error) {...});` | Trigged when page failed to load, `status` return HTTP code and `error` return message error
95
+
`Pjax.on("then", function(event, url) {...});` | Executes every time a request is completed, even if it fails or succeeds.
95
96
96
97
You can change configs in `pjax.initiate` event, example:
97
98
@@ -107,9 +108,9 @@ You can change configs in `pjax.initiate` event, example:
107
108
</div>
108
109
</div>
109
110
<script>
110
-
$.autoPjax();
111
+
Pjax.start();
111
112
112
-
$(document).on("pjax.initiate", function (e, url, configs) {
113
+
Pjax.on("initiate", function (e, url, configs) {
113
114
if (url.indexOf("/search/") ===0&&window.location.href.indexOf("/search/") ===0) {
114
115
configs.containers= [ "#search-container" ];
115
116
}
@@ -151,19 +152,19 @@ You can custom CSS, example change color and size, put in new CSS file or `<styl
151
152
If you need custom "more", first remove default loader:
152
153
153
154
```javascript
154
-
$.autoPjax({
155
+
Pjax.start({
155
156
"loader":false
156
157
});
157
158
```
158
159
159
160
And after use `pjax.initiate` and `pjax.then` events:
0 commit comments