jquery.urianchor
Advanced tools
Comparing version 1.3.3 to 1.3.4
{ "name": "jquery.urianchor", | ||
"version": "1.3.3", | ||
"version": "1.3.4", | ||
"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", |
102
README.md
@@ -1,5 +0,9 @@ | ||
# uriAnchor # | ||
# uriAnchor | ||
## Summary ## | ||
## Use libraries, not frameworks | ||
This is a library that strives to be best-in-class. | ||
If you are considering using an SPA framework, please read [Do you | ||
really want an SPA framework?][0] first. | ||
## Overview | ||
A jQuery plugin for management of the URI hash component. | ||
@@ -16,3 +20,3 @@ | ||
## Preferred listener ## | ||
## Preferred listener | ||
@@ -27,3 +31,3 @@ The preferred listener to use with URI Anchor is `hashchange`, like so: | ||
## Example implementation ## | ||
## Example implementation | ||
@@ -40,7 +44,7 @@ See a full example, clone the [SPA listings](10), | ||
## Methods ## | ||
## Methods | ||
### $.uriAnchor.setAnchor ## | ||
### $.uriAnchor.setAnchor | ||
#### Purpose #### | ||
#### Purpose | ||
@@ -50,3 +54,3 @@ Sets Anchor component of the URI from a Map. | ||
#### Arguments #### | ||
#### Arguments | ||
@@ -59,19 +63,19 @@ Arguments are positional: | ||
#### Environment #### | ||
#### Environment | ||
Expects the document.location browser object | ||
#### Settings #### | ||
#### Settings | ||
none | ||
#### Returns #### | ||
#### Returns | ||
boolean: true on success, false on failure | ||
#### Throws #### | ||
#### Throws | ||
none | ||
#### Details #### | ||
#### Details | ||
@@ -240,62 +244,26 @@ The first positional argument, `anchor_map`, may be a simple map: | ||
## Avoid complex 'SPA framework' libraries ## | ||
jQuery used with this and a few other well-chosen tools forms | ||
a fantastic basis for a lean, easy to use SPA architecture | ||
as detailed in [Single page web applications, JavaScript end-to-end][1]. | ||
Here are the recommended tools: | ||
| Capability | Tool | Notes | | ||
| ------------ | ------------------- | ----------------------------------| | ||
| Websockets | [Socket.io][6] | Prefer websockets over AJAX. | | ||
| AJAX | jQuery native | Use jQuery AJAX methods. | | ||
| Promises | jQuery native | Use jQuery promise methods. | | ||
| Model Events | [Global Events][2] | jQuery plugin eliminates having | | ||
| | | to manage multiple event types. | | ||
| Touch | [Unified events][3] | Unify desktop and touch events. | | ||
| Routing | [uriAnchor][4] | jQuery plugin for robust routing. | | ||
| | | Includes support for dependent | | ||
| | | and independent query arguments. | | ||
| Data Model | [taffyDB][5] | A powerful and flexible SQL-like | | ||
| | | client data management tool. | | ||
| SVG | [D3][7] | Great for easy graphs and charts | | ||
| | [SVG][8] | Low-level jQuery plugin | | ||
| Templates | [Dust][9] | Uses a powerful template DSL that | | ||
| | | minimizes chances to intemingle | | ||
| | | business and display logic. | | ||
This suite of tools has all the capabilities of a bleeding-edge | ||
SPA "framework" library within the reliable and mature jQuery ecosystem. | ||
It can provide an application that is significantly more flexible and | ||
testable since display logic can easily be decoupled from business logic. | ||
Finally, it leverages jQuery's maturity, performance, and excellent | ||
tools instead of competing with them. | ||
## Release Notes ## | ||
### Copyright (c)### | ||
## Release Notes | ||
### Copyright (c) | ||
2013 Michael S. Mikowski (mike[dot]mikowski[at]gmail[dotcom]) | ||
### License ### | ||
### License | ||
Dual licensed under the MIT or GPL Version 2 | ||
http://jquery.org/license | ||
### Versions 1.1.0-3 ### | ||
### Versions 1.1.0-3 | ||
These are the first releases registered with jQuery plugins. | ||
### Versions 1.2.0-2, 1.3.0-1 ### | ||
### Versions 1.2.0-2, 1.3.0-1 | ||
Updated documentation, fixed minor bug. | ||
### Version 1.3.2 ### | ||
### Version 1.3.2 | ||
Added example to show use of hashchange listener. | ||
### Version 1.3.3 ### | ||
### Version 1.3.3 | ||
Added changeAnchorPart example code | ||
## TODO ## | ||
## TODO | ||
Reconsider the structure of dependent and indepent variables | ||
- Maybe reconsider the structure of dependent and indepent variables | ||
## Contribute! ## | ||
## Contribute! | ||
If you want to help out, like all jQuery plugins this is hosted at | ||
@@ -305,13 +273,5 @@ GitHub. Any improvements or suggestions are welcome! | ||
## END ## | ||
[1]:http://manning.com/mikowski | ||
[2]:https://github.com/mmikowski/jquery.event.gevent | ||
[3]:https://github.com/mmikowski/jquery.event.ue | ||
[4]:https://github.com/mmikowski/urianchor | ||
[5]:https://github.com/typicaljoe/taffydb | ||
[6]:http://socket.io | ||
[7]:https://github.com/mbostock/d3 | ||
[8]:http://keith-wood.name/svg.html | ||
[9]:http://linkedin.github.io/dustjs | ||
[10]:https://github.com/mmikowski/spa | ||
## END | ||
[0]:http://mmikowski.github.io/no-frameworks | ||
[1]:http://www.amazon.com/dp/1617290750 | ||
[2]:http://manning.com/mikowski |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
47509
271