Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4877bac2ae | ||
|
|
afe0ddb6b9 | ||
|
|
a5d36d28f8 | ||
|
|
7a4056fd77 | ||
|
|
ba6ef126c0 |
@@ -1,3 +1,9 @@
|
||||
# 0.2.3 - 2016-03-24
|
||||
|
||||
- Fixed: ``currentUrlFullReload`` option now works
|
||||
- Fixed: ``this.reload`` is now a Function
|
||||
([#65](https://github.com/MoOx/pjax/issues/65))
|
||||
|
||||
# 0.2.2 - 2016-03-12
|
||||
|
||||
- Fixed: added back standalone version in `./pjax.js`
|
||||
|
||||
41
README.md
41
README.md
@@ -1,7 +1,6 @@
|
||||
# Pjax [](https://travis-ci.org/MoOx/pjax)
|
||||
# Pjax
|
||||
|
||||
|
||||
[](https://ci.testling.com/MoOx/pjax)
|
||||
[](https://travis-ci.org/MoOx/pjax) [@todo fix CI](https://github.com/MoOx/pjax/issues/63).
|
||||
|
||||
> Easily enable fast Ajax navigation on any website (using pushState + xhr)
|
||||
|
||||
@@ -16,9 +15,6 @@ Especially for user that have low bandwidth connection._
|
||||
|
||||
**No more full page reload. No more lots of HTTP request.**
|
||||
|
||||
# Note: current master is WIP.
|
||||
|
||||
Checkout [v0.1.4](https://github.com/MoOx/pjax/tree/a17a6b90bebefd8f5209e6a6f7d8c5d59296232a) for latest "stable" (no tests so kind of funny to call that stable).
|
||||
|
||||
## Demo
|
||||
|
||||
@@ -394,25 +390,6 @@ Useful to debug page layout differences.
|
||||
|
||||
When set to true, clicking on a link that point the current url trigger a full page reload.
|
||||
|
||||
#### Extend Pjax
|
||||
|
||||
Pjax prototype & utilities methods can be used & changed so you can patch or hack
|
||||
Pjax behavior, as you wish.
|
||||
|
||||
Here is a summary of functions:
|
||||
|
||||
- `Pjax.prototype.log` (`function()`): console.log function that is enable/disabled by `debug` option
|
||||
- `Pjax.prototype.getElements` (`function(el)`): retrieve elements to attach Pjax behavior
|
||||
- `Pjax.prototype.parseDOM` (`function(el)`): parse DOM to attach behavior using `Pjax.prototype.getElements` & `Pjax.prototype.attachLink`
|
||||
- `Pjax.prototype.attachLink` (`function(el)`): attach Pjax behavior to a link
|
||||
- `Pjax.prototype.forEachSelectors` (`function(cb, context, DOMcontext)`): call a function for each selectors defined
|
||||
- `Pjax.prototype.switchSelectors` (`function(selectors, fromEl, toEl, options)`): loop on selectors to switch elements
|
||||
- `Pjax.prototype.latestChance` (`function(href)`): when everything is fucked up, it's our only hope (just call `window.location = href`)
|
||||
- `Pjax.prototype.onSwitch` (`function()`): callback triggered when elements are switched, for now it's just trigger a window resize event (lots of lib are listening to this event to draw stuff)
|
||||
- `Pjax.prototype.loadContent` (`function(html, options)`): switch elements for each selectors
|
||||
- `Pjax.prototype.doRequest` (`function(location, callback)`): make the ajax request to grab page from the server
|
||||
- `Pjax.prototype.loadUrl` (`function(href, options)`): do the ajax request, handle html results & eventually handle browser history, analytics & scroll.
|
||||
|
||||
### Events
|
||||
|
||||
Pjax fires a number of events regardless of how its invoked.
|
||||
@@ -543,15 +520,13 @@ Clone this repository and run `npm run example`, then open `http://localhost:300
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
## CONTRIBUTING
|
||||
|
||||
Work on a branch, install dev-dependencies, respect coding style & run tests before submitting a bug fix or a feature.
|
||||
* ⇄ Pull requests and ★ Stars are always welcome.
|
||||
* For bugs and feature requests, please create an issue.
|
||||
* Pull requests must be accompanied by passing automated tests (`$ npm test`).
|
||||
|
||||
$ git clone https://github.com/MoOx/pjax.git
|
||||
$ git checkout -b patch-1
|
||||
$ npm install
|
||||
$ npm test
|
||||
## [CHANGELOG](CHANGELOG.md)
|
||||
|
||||
## [Changelog](CHANGELOG.md)
|
||||
## [LICENSE](LICENSE)
|
||||
|
||||
## [License](LICENSE)
|
||||
|
||||
@@ -19,8 +19,8 @@ document.addEventListener("pjax:success", function() {
|
||||
|
||||
document.addEventListener("DOMContentLoaded", function() {
|
||||
var pjax = new Pjax({
|
||||
selectors: [".body"]
|
||||
selectors: [".body"],
|
||||
// currentUrlFullReload: true,
|
||||
})
|
||||
console.log("Pjax initialized.", pjax)
|
||||
})
|
||||
|
||||
|
||||
@@ -9,7 +9,9 @@
|
||||
<body>
|
||||
<div class='body'>
|
||||
<h1>Index</h1>
|
||||
hello. Go to <a href='page2.html'>Page 2</a> and view your console to see Pjax events.
|
||||
Hello.
|
||||
Go to <a href='page2.html'>Page 2</a> and view your console to see Pjax events.
|
||||
Clicking on <a href='index.html'>this page</a> will just reload the page entierly.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
2
index.js
2
index.js
@@ -51,6 +51,8 @@ Pjax.prototype = {
|
||||
|
||||
refresh: require("./lib/proto/refresh.js"),
|
||||
|
||||
reload: require("./lib/reload.js"),
|
||||
|
||||
attachLink: require("./lib/proto/attach-link.js"),
|
||||
|
||||
forEachSelectors: function(cb, context, DOMcontext) {
|
||||
|
||||
@@ -43,7 +43,10 @@ var linkAction = function(el, event) {
|
||||
event.preventDefault()
|
||||
|
||||
// don’t do "nothing" if user try to reload the page by clicking the same link twice
|
||||
if (el.href === window.location.href.split("#")[0]) {
|
||||
if (
|
||||
this.options.currentUrlFullReload &&
|
||||
el.href === window.location.href.split("#")[0]
|
||||
) {
|
||||
el.setAttribute(attrClick, "reload")
|
||||
this.reload()
|
||||
return
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "pjax",
|
||||
"version": "0.2.2",
|
||||
"version": "0.2.3",
|
||||
"description": "Easily enable fast Ajax navigation on any website (using pushState + xhr)",
|
||||
"keywords": [
|
||||
"pjax",
|
||||
@@ -25,6 +25,7 @@
|
||||
"coverify": "^1.0.6",
|
||||
"jscs": "^1.6.2",
|
||||
"jshint": "^2.5.6",
|
||||
"npmpub": "^3.1.0",
|
||||
"serve": "1.4.0",
|
||||
"tape": "^3.0.0",
|
||||
"testling": "^1.6.1"
|
||||
@@ -37,7 +38,8 @@
|
||||
"test--html": "testling --html > tests/scripts/index.html",
|
||||
"coverage": "browserify -t coverify tests/**/*.js | testling | coverify",
|
||||
"example": "echo '\n==> Open http://localhost:3000/example in your browser.'; serve .",
|
||||
"prepublish": "npm run standalone"
|
||||
"prepublish": "npm run standalone",
|
||||
"release": "npm test && npmpub --skip-test"
|
||||
},
|
||||
"testling": {
|
||||
"files": "tests/**/*.js",
|
||||
|
||||
Reference in New Issue
Block a user