jquery.urianchor
Advanced tools
Comparing version 1.3.4 to 1.3.5
{ "name": "jquery.urianchor", | ||
"version": "1.3.4", | ||
"version": "1.3.5", | ||
"description": "uriAnchor jQuery plugin - SPA URI routing made simple. Use this plugin to provide sophisticated routing to your SPA. Used in many commercial SPAs and featured in a best-selling book.", | ||
@@ -4,0 +4,0 @@ "main": "jquery.uriAnchor.js", |
# uriAnchor | ||
## Use libraries, not frameworks | ||
@@ -9,15 +8,15 @@ This is a library that strives to be best-in-class. | ||
## Overview | ||
A jQuery plugin for management of the URI hash component. | ||
Make your application bookmarks, browser history, the back button, | ||
and the forward button act just as the user expects while enabling you | ||
to update only the part of the page that has changed. This jQuery | ||
plugin helps you do this by making the URI Anchor (or hash fragment, | ||
as others call it) your application state API. | ||
Use this plugin to manage dependent and independent variables in the hash | ||
fragment of the URI. It has been designed and updated over five commercial | ||
SPA projects and is featured in the book | ||
[Single page web applications, JavaScript end-to-end][1] | ||
It provides the capability to make the URI fragment your application state | ||
API. Bookmarks, browser history, the back button, and the forward button | ||
can all be made to act as the user expects while enabling you to update | ||
only the part of the page that has changed. | ||
SPA projects and is featured in the book book | ||
**Single Page Web Applications - JavaScript end-to-end** | ||
which is available from [Amazon][1] and directly from [Manning][2]. | ||
## Preferred listener | ||
The preferred listener to use with URI Anchor is `hashchange`, like so: | ||
@@ -32,3 +31,2 @@ | ||
## Example implementation | ||
See a full example, clone the [SPA listings](10), | ||
@@ -45,7 +43,4 @@ dereference a copy of the 6.5 listings, and then open the web page. Like so: | ||
## Methods | ||
### $.uriAnchor.setAnchor | ||
#### Purpose | ||
Sets Anchor component of the URI from a Map. | ||
@@ -55,3 +50,2 @@ The Anchor component is also known as the 'hash fragment' or 'bookmark component'. | ||
#### Arguments | ||
Arguments are positional: | ||
@@ -64,19 +58,14 @@ | ||
#### Environment | ||
Expects the document.location browser object | ||
#### Settings | ||
none | ||
#### Returns | ||
boolean: true on success, false on failure | ||
#### Throws | ||
none | ||
#### Details | ||
The first positional argument, `anchor_map`, may be a simple map: | ||
@@ -178,25 +167,18 @@ | ||
### $.uriAnchor.makeAnchorMap | ||
#### Purpose | ||
Parses URI anchor and returns as map | ||
#### Arguments | ||
none | ||
#### Environment | ||
Expects the document.location browser object | ||
#### Settings | ||
none | ||
#### Returns | ||
Map | ||
#### Throws | ||
none | ||
@@ -206,3 +188,2 @@ | ||
#### Details | ||
Parses the browser URI anchor into a map using the same | ||
@@ -212,3 +193,3 @@ rules used to set the anchor in the method setAnchor | ||
This method creates an additional key type, `_s_<indendent_arg>` | ||
This method creates an additional key type, `_s_<independent_arg>` | ||
for each independent argument with dependent arguments. | ||
@@ -224,3 +205,2 @@ | ||
#### Example | ||
If the browser URI Anchor looks like this: | ||
@@ -227,0 +207,0 @@ |
47563
251