Path.map()
.Path.listen({hashbang:false})
.Path.to(path)
to forward path.Path.listen()
method add optional parameter: {hashbang: true|false}
.Path.history.listen()
method use new optional parameter: {hashbang: true|false, fallback: true|false}
.this.params
supported parse QueryString parameters.PathJS is a lightweight, client-side routing library that allows you to create "single page" applications using Hashbangs and/or HTML5 pushState.
./tests
directory)function clearPanel(){
// You can put some code in here to do fancy DOM transitions, such as fade-out or slide-in.
}
Path.map("/users").to(function(){
alert("Users!");
});
Path.map("/comments").to(function(){
alert("Comments!");
}).enter(clearPanel);
Path.map("/posts").to(function(){
alert("Posts!");
}).enter(clearPanel);
Path.root("/posts");
Path.listen();
The hashtag("#") is the original method of using PathJS. It is compatible with all modern browsers, and even some that are not-so-modern. To get started, all you need to do is define a route. A route can be any string prepended with a hash, such as:
#/my/first/route
#!/hashbang
#kittens
PathJS provides the Path object. This is the root of the library, and is your gateway into route-defining heaven. You can define your routes like so:
// Use an anonymous function
Path.map("/my/first/route").to(function(){
alert("Hello, World!");
});
// Or define one and use it
function hello_world(){
alert("Hello, World!");
}
Path.map("/kittens").to(hello_world);
In addition to defining methods that will be executed when a route is activated, you can define methods that will be called before a route is activated, and after a route is left. This can be done via the enter and exit methods, respectively. They work exactly the same as the to method:
//Let's add an 'enter' method to one of our routes
Path.map("/my/first/route").enter(function(){
alert("Enter, minions!");
});
// You can also chain the methods together
Path.map("/hashbang/route").enter(fade_in).to(function(){
alert("Method chaining is great!");
}).exit(fade_out);
In some cases, you may want to perform multiple actions before an action is taken, and depending on their results, cancel the action altogether. For this reason, PathJS supports multiple 'enter' actions, which can be assigned individually or as an array:
Path.map("/my/first/route").enter(function(){
alert("First one!");
}).enter([
function(){
alert("Second!");
return false;
},
function(){
alert("And third!");
}
]);
Path.map("/my/first/route").to(function(){
alert("Action!")
});
The methods are executed first-in-first-out, and if any of them returns false, the execution chain is immediately halted. In the example above, the third 'enter' method, as well as the actual action, will never get called, because the second one explicitly returns false.
What good would a routing system be if it didn't allow you to use parameters? If you provide a route that contains a :token, that token will match anything, as long as the rest of the route matches as well. You can access the parameters inside your methods via the this.params object:
Path.map("/users/:name").to(function(){
alert("Username: " + this.params['name']);
});
The above route will match any of the following hrefs:
#!/users/mike
#!/users/27
You can define a route that has optional components by wrapping the non-mandatory components in parentheses. Inside your bound method(s), any params that were not provided will come back as undefined.
Path.map("/users/:user_id?").to(function(){
var user_id = this.params["user_id"] || "Set a default here!";
});
The above route will match both of the following:
#!/users // Your "user_id" parameter will be undefined.
#!/users/7 // Your "user_id" parameter will be set to "7".
/users // Static rule: Path.map('/users')
//
/users/:id // Named route parameter: Path.map('/users/:id')
// --> this.params['id']
/users/:id(\\d+) // Parameter muse be digits: Path.map('/users/:id(\\d+)')
// --> this.params['id']
/users/:id? // Parameter is optional: Path.map('/users/:id?')
// --> this.params['id'] || 'undefined'
/users/:id/:action // Path.map('/users/:id/:action')
// --> this.params['id'], this.params['action']
/users/(\\d+) // Regexp route parameter: Path.map('/users/(\\d+)')
// --> this.params[0]
/users/(\\d+)/(\\w+) // Path.map('/users/(\\d+)/(\\w+)')
// --> this.params[0], this.params[1]
/users/:id/(\\w+) // Named parameter and regexp parameter mixed use: Path.map('/users/:id/(\\w+)')
// --> this.params['id'], this.params[0]
/users/* // Wildcard parameter: Path.map('/users/*')
// --> this.params[0] || 'undefined'
['/A', '/B', '/C'] // Array multi route, can matched any one given: Path.map(['/A', '/B', '/C'])
//
/^#\/comments\/(\d+)$/ // Regexp route: Path.map(/^#\/comments\/(\d+)$/)
//
Other:
/users_:id_:action // /users_2_edit
/get.:id..comments\\?p=:page(\\d+) // get.1202..comments?page=1
/... as define yourself...
If a user were to land on your page without a route defined, you can force them to use a root route. This route will be automatically selected on page load:
Path.root("/home");
If a route somehow ended up in your system without being properly bound to an action, you can specify a "rescue" method that will be called. This lets you provide instant user feedback if they click an undefined route:
Path.rescue(function(){
alert("404: Route Not Found");
});
If a user gets to your page with an already defined route (for example, the click a referral link with the href of "www.yoursite.com/media#download"), PathJS will automatically find and execute the appropriate route methods.
You can define routes all day long, but if you don't tell us to listen for them, nothing's going to happen. Once you've got your routes defined, start the listener up by simply typing:
Path.listen({hashbang:true|false});
You should always wrap your Path.listen()
statements in some form of "Document Ready" method. This prevents errors when users come to your site with a predefined route. Without knowing the DOM is completely done loading, that route will be executed, and may try to perform operations it won't yet have the ability to do.
As of version 0.7, PathJS officially supports the HTML5 History API via pushState. Before reading this page, please make sure you've read the wiki page about Getting Started. The HTML5 History API is only supported by some modern browsers.
Path.listen()
method, you now call the Path.history.listen()
methodPath.history.pushState
method, rather than the history.pushState
method.You define the routes the same as usual, except you omit the Hashtag from your route:
Path.map("/html5/rocks").to(function(){
alert("Hello, World!");
});
Much like the regular HTML5 History API, to add a new history item to the global history object, you need to call the pushState
method. When you want to use the PathJS Route Dispatcher, you need to call the PathJS pushState method.
Path.history.pushState(state, title, path);
The Path.history.pushState
method is analogous to the standard history.pushState
method, but wraps calls to the PathJS dispatcher. You can access the history state information the same as if you had manually set the state via history.pushState
.
As mentioned above, you now need to call the Path.history.listen()
method instead of the standard Path.listen()
method. Unlike the standard Path.listen()
method, this method accepts a single boolean parameter, which tells the PathJS library whether or not it should fallback to hashtag support if HTML5 is not supported.
Path.history.listen({'hashbang': true|false, 'fallback': true}); // Yes, please fall back to hashtags if HTML5 is not supported.
Path.history.listen({'fallback': false}); // No, do not fall back to hashtags.
Path.history.listen(); // This is the same as passing "false".
This new method does several things:
Path.history.supported
attribute accordinglyPath.history.listen()
method will wrap a call to Path.listen()
if you want gracefull degredation to Hashtags. There is no need for you to call it yourself in this case.To run the tests, simply navigate to the ./tests
folder and open the HTML file in your browser. Please note that the HTML5 History API is not compatible with the
file://
protocol, and to run the tests in the tests/pushstate
folder, you will need to run them through a webserver such as nginx or Apache.
To make a pull request, please do the following:
Path.version
in a debugger consolePath.version
attribute. I will modify that manually when merging the requestThis code is provided with no warranty. While I strive to maintain backwards compatibility, the code is still under active development. As this is the case, some revisions may break break compatibility with earlier versions of the library. Please keep this in mind when using PathJS.
Copyright (c) 2015 Wangyongshan, Mike Trpcic released under the MIT license.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型