Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 318 lines (235 sloc) 20.322 kb
4cc19a3 @balupton readme updates
authored
1 Welcome to History.js (v1.7.1-dev - September 27 2011)
8d5cacf @balupton Initial Commit
authored
2 ==================
3
4
09127ba @balupton Cleaned documentation, a few other things. Not ready yet as some tests a...
authored
5 This project is the successor of [jQuery History](http://balupton.com/projects/jquery-history), it aims to:
8d5cacf @balupton Initial Commit
authored
6
bd6ea2f @balupton Fixed some more issues. Mostly HTML4 States initially in HTML5 browsers.
authored
7 - Follow the [HTML5 History API](https://developer.mozilla.org/en/DOM/Manipulating_the_browser_history) as much as possible
bc79c00 @balupton Fixed demo/test. Updated readme. Added note to .htaccess. Demo is now pl...
authored
8 - Provide a cross-compatible experience for all HTML5 Browsers (they all implement the HTML5 History API a little bit differently causing different behaviours and sometimes bugs - History.js fixes this ensuring the experience is as expected / the same / great throughout the HTML5 browsers)
78681ff @balupton updated commit feed link
authored
9 - Provide a backwards-compatible experience for all HTML4 Browsers using a hash-fallback (including continued support for the HTML5 History API's `data`, `title`, `pushState` and `replaceState`) with the option to [remove HTML4 support if it is not right for your application](https://github.com/balupton/history.js/wiki/Intelligent-State-Handling)
bc79c00 @balupton Fixed demo/test. Updated readme. Added note to .htaccess. Demo is now pl...
authored
10 - Provide a forwards-compatible experience for HTML4 States to HTML5 States (so if a hash-fallbacked url is accessed by a HTML5 browser it is naturally transformed into its non-hashed url equivalent)
833fd3a @balupton Fixed a recursion issue with FF3.6. Removed Firebug Lite.
authored
11 - Provide support for as many javascript frameworks as possible via adapters; especially [jQuery](http://jquery.com/), [MooTools](http://mootools.net/), [Prototype](http://www.prototypejs.org/) and [Zepto](http://zeptojs.com/)
c76ef2c @balupton Added graceful upgradation of HTML4 States to HTML5 Browsers... but it s...
authored
12
13 Licensed under the [New BSD License](http://creativecommons.org/licenses/BSD/)
14 Copyright 2011 [Benjamin Arthur Lupton](http://balupton.com)
88c3212 @balupton Lots more working.
authored
15
ba466c3 @balupton Now working with prototype.
authored
16
d2028b3 @balupton Added Code Smaple in Documentation.
authored
17 ## Usage
18
bc79c00 @balupton Fixed demo/test. Updated readme. Added note to .htaccess. Demo is now pl...
authored
19 ### Working with History.js:
d2028b3 @balupton Added Code Smaple in Documentation.
authored
20
4cc19a3 @balupton readme updates
authored
21 ``` javascript
22 (function(window,undefined){
23
24 // Prepare
25 var History = window.History; // Note: We are using a capital H instead of a lower h
26 if ( !History.enabled ) {
27 // History.js is disabled for this browser.
28 // This is because we can optionally choose to support HTML4 browsers or not.
29 return false;
30 }
31
32 // Bind to StateChange Event
33 History.Adapter.bind(window,'statechange',function(){ // Note: We are using statechange instead of popstate
34 var State = History.getState(); // Note: We are using History.getState() instead of event.state
35 History.log(State.data, State.title, State.url);
36 });
37
38 // Change our States
39 History.pushState({state:1}, "State 1", "?state=1"); // logs {state:1}, "State 1", "?state=1"
40 History.pushState({state:2}, "State 2", "?state=2"); // logs {state:2}, "State 2", "?state=2"
41 History.replaceState({state:3}, "State 3", "?state=3"); // logs {state:3}, "State 3", "?state=3"
42 History.pushState(null, null, "?state=4"); // logs {}, '', "?state=4"
43 History.back(); // logs {state:3}, "State 3", "?state=3"
44 History.back(); // logs {state:1}, "State 1", "?state=1"
45 History.back(); // logs {}, "Home Page", "?"
46 History.go(2); // logs {state:3}, "State 3", "?state=3"
47
48 })(window);
49 ```
c76ef2c @balupton Added graceful upgradation of HTML4 States to HTML5 Browsers... but it s...
authored
50
833fd3a @balupton Fixed a recursion issue with FF3.6. Removed Firebug Lite.
authored
51 To ajaxify your entire website with the HTML5 History API, History.js and jQuery [this snippet of code](https://gist.github.com/854622) is all you need. It's that easy.
52
bc79c00 @balupton Fixed demo/test. Updated readme. Added note to .htaccess. Demo is now pl...
authored
53 ### How would the above operations look in a HTML5 Browser?
09127ba @balupton Cleaned documentation, a few other things. Not ready yet as some tests a...
authored
54
b0edf7a @balupton Fixed readme formatting a bit. Attempt to add a subscribe form.
authored
55 1. www.mysite.com
41928aa @balupton Readme updates. Had some incorrect installation info.
authored
56 1. www.mysite.com/?state=1
57 1. www.mysite.com/?state=2
58 1. www.mysite.com/?state=3
59 1. www.mysite.com/?state=4
60 1. www.mysite.com/?state=3
61 1. www.mysite.com/?state=1
b0edf7a @balupton Fixed readme formatting a bit. Attempt to add a subscribe form.
authored
62 1. www.mysite.com
41928aa @balupton Readme updates. Had some incorrect installation info.
authored
63 1. www.mysite.com/?state=3
b0edf7a @balupton Fixed readme formatting a bit. Attempt to add a subscribe form.
authored
64
78681ff @balupton updated commit feed link
authored
65 > Note: These urls also work in HTML4 browsers and Search Engines. So no need for the hashbang (`#!`) fragment-identifier that google ["recommends"](https://github.com/balupton/history.js/wiki/Intelligent-State-Handling).
09127ba @balupton Cleaned documentation, a few other things. Not ready yet as some tests a...
authored
66
bc79c00 @balupton Fixed demo/test. Updated readme. Added note to .htaccess. Demo is now pl...
authored
67 ### How would they look in a HTML4 Browser?
09127ba @balupton Cleaned documentation, a few other things. Not ready yet as some tests a...
authored
68
b0edf7a @balupton Fixed readme formatting a bit. Attempt to add a subscribe form.
authored
69 1. www.mysite.com
41928aa @balupton Readme updates. Had some incorrect installation info.
authored
70 1. www.mysite.com/#?state=1&_suid=1
71 1. www.mysite.com/#?state=2&_suid=2
72 1. www.mysite.com/#?state=3&_suid=3
73 1. www.mysite.com/#?state=4
74 1. www.mysite.com/#?state=3&_suid=3
75 1. www.mysite.com/#?state=1&_suid=1
b0edf7a @balupton Fixed readme formatting a bit. Attempt to add a subscribe form.
authored
76 1. www.mysite.com
41928aa @balupton Readme updates. Had some incorrect installation info.
authored
77 1. www.mysite.com/#?state=3&_suid=3
b0edf7a @balupton Fixed readme formatting a bit. Attempt to add a subscribe form.
authored
78
28dacb6 @balupton Minor updates to readme. Mostly typos. Also added a 'Giving Support' sec...
authored
79 > Note 1: These urls also work in HTML5 browsers - we use `replaceState` to transform these HTML4 states into their HTML5 equivalents so the user won't even notice :-)
dc4cc15 @balupton v1.4.0 Release
authored
80 >
9cdcd93 @balupton Recompiled and fixed final bug
authored
81 > Note 2: These urls will be automatically url-encoded in IE6 to prevent certain browser-specific bugs.
bc79c00 @balupton Fixed demo/test. Updated readme. Added note to .htaccess. Demo is now pl...
authored
82 >
78681ff @balupton updated commit feed link
authored
83 > Note 3: Support for HTML4 browsers (this hash fallback) is optional [- why supporting HTML4 browsers could be either good or bad based on my app's use cases](https://github.com/balupton/history.js/wiki/Intelligent-State-Handling)
09127ba @balupton Cleaned documentation, a few other things. Not ready yet as some tests a...
authored
84
ca86372 @balupton Changed _state to _suid. Updated readme.
authored
85 ### What's the deal with the SUIDs used in the HTML4 States?
09127ba @balupton Cleaned documentation, a few other things. Not ready yet as some tests a...
authored
86
ca86372 @balupton Changed _state to _suid. Updated readme.
authored
87 - SUIDs (State Unique Identifiers) are used when we utilise a `title` and/or `data` in our state. Adding a SUID allows us to associate particular states with data and titles while keeping the urls as simple as possible (don't worry it's all tested, working and a lot smarter than I'm making it out to be).
88 - If you aren't utilising `title` or `data` then we don't even include a SUID (as there is no need for it) - as seen by State 4 above :-)
09127ba @balupton Cleaned documentation, a few other things. Not ready yet as some tests a...
authored
89 - We also shrink the urls to make sure that the smallest url will be used. For instance we will adjust `http://www.mysite.com/#http://www.mysite.com/projects/History.js` to become `http://www.mysite.com/#/projects/History.js` automatically. (again tested, working, and smarter).
90 - It works with domains, subdomains, subdirectories, whatever - doesn't matter where you put it. It's smart.
41928aa @balupton Readme updates. Had some incorrect installation info.
authored
91 - Safari 5 will also have a SUID appended to the URL, it is entirely transparent but just a visible side-effect. It is required to fix a bug with Safari 5.
09127ba @balupton Cleaned documentation, a few other things. Not ready yet as some tests a...
authored
92
bc79c00 @balupton Fixed demo/test. Updated readme. Added note to .htaccess. Demo is now pl...
authored
93 ### Is there a working demo?
09127ba @balupton Cleaned documentation, a few other things. Not ready yet as some tests a...
authored
94
519ed6e @balupton Updated readme a bit more.
authored
95 - Sure is, give it a download and navigate to the demo directory in your browser :-)
41928aa @balupton Readme updates. Had some incorrect installation info.
authored
96 - If you are after something a bit more adventurous than a end-user demo, open up the tests directory in your browser and editor - it'll rock your world and show all the vast use cases that History.js supports.
09127ba @balupton Cleaned documentation, a few other things. Not ready yet as some tests a...
authored
97
98
99 ## Download & Installation
f2ac286 @balupton First version complete.
authored
100
78681ff @balupton updated commit feed link
authored
101 1. Download History.js and upload it to your webserver. Download links: [tar.gz](https://github.com/balupton/history.js/tarball/master) or [zip](https://github.com/balupton/history.js/zipball/master)
f2ac286 @balupton First version complete.
authored
102
3818f02 @balupton Made good progress. Building completed. Just needs testing now.
authored
103 1. Include History.js
f2ac286 @balupton First version complete.
authored
104
3818f02 @balupton Made good progress. Building completed. Just needs testing now.
authored
105 - For [jQuery](http://jquery.com/) v1.3+
f2ac286 @balupton First version complete.
authored
106
3818f02 @balupton Made good progress. Building completed. Just needs testing now.
authored
107 ``` html
108 <script src="http://www.yourwebsite.com/history.js/scripts/bundled/html4+html5/jquery.history.js"></script>
109 ```
703124e @balupton v1.7 beta. Need to test properly.
authored
110
3818f02 @balupton Made good progress. Building completed. Just needs testing now.
authored
111 - For [Mootools](http://mootools.net/) v1.3+
703124e @balupton v1.7 beta. Need to test properly.
authored
112
3818f02 @balupton Made good progress. Building completed. Just needs testing now.
authored
113 ``` html
114 <script src="http://www.yourwebsite.com/history.js/scripts/bundled/html4+html5/mootools.history.js"></script>
115 ```
f2ac286 @balupton First version complete.
authored
116
3818f02 @balupton Made good progress. Building completed. Just needs testing now.
authored
117 - For [Right.js](http://rightjs.org/) v2.2+
f2ac286 @balupton First version complete.
authored
118
3818f02 @balupton Made good progress. Building completed. Just needs testing now.
authored
119 ``` html
120 <script src="http://www.yourwebsite.com/history.js/scripts/bundled/html4+html5/right.history.js"></script>
121 ```
122
123 - For [Zepto](http://zeptojs.com/) v0.5+
f2ac286 @balupton First version complete.
authored
124
3818f02 @balupton Made good progress. Building completed. Just needs testing now.
authored
125 ``` html
126 <script src="http://www.yourwebsite.com/history.js/scripts/bundled/html4+html5/zepto.history.js"></script>
127 ```
f2ac286 @balupton First version complete.
authored
128
3818f02 @balupton Made good progress. Building completed. Just needs testing now.
authored
129 - For everything else
f2ac286 @balupton First version complete.
authored
130
3818f02 @balupton Made good progress. Building completed. Just needs testing now.
authored
131 ``` html
132 <script src="http://www.yourwebsite.com/history.js/scripts/bundled/html4+html5/native.history.js"></script>
133 ```
f2ac286 @balupton First version complete.
authored
134
de822d6 @balupton typo
authored
135 > Note: If you want to only support HTML5 Browsers and not HTML4 Browsers (so no hash fallback support) then just change the `/html4+html5/` part in the urls to just `/html5/`. [Why supporting HTML4 browsers could be either good or bad based on my app's use cases](https://github.com/balupton/history.js/wiki/Intelligent-State-Handling)
f2ac286 @balupton First version complete.
authored
136
137
04697ac @balupton v1.4.1 - Added HTML5 Supported for Safari 5 and Safari iOS 4.2.1
authored
138 ## Subscribe to Updates
139
140 - For Commit RSS/Atom Updates:
78681ff @balupton updated commit feed link
authored
141 - You can subscribe via the [GitHub Commit Atom Feed](http://feeds.feedburner.com/historyjs)
44f2857 @balupton Readme updates mostly on compatibility.
authored
142 - For GitHub News Feed Updates:
78681ff @balupton updated commit feed link
authored
143 - You can click the "watch" button up the top right of History.js's [GitHub Project Page](https://github.com/balupton/history.js)
04697ac @balupton v1.4.1 - Added HTML5 Supported for Safari 5 and Safari iOS 4.2.1
authored
144
145
02dcc4c @balupton Added support section to readme.
authored
146 ## Getting Support
147
cf70daf @balupton fixed grammer
authored
148 **History.js is an actively supported, maintained and developed project.** You can grab support via its **[GitHub Issue Tracker](https://github.com/balupton/history.js/issues)** and contact its core developer [Benjamin Lupton](http://balupton.com) via [twitter](http://twitter.com/balupton), skype (balupton) and email (b@lupton.cc). Benjamin is also available for [bookings](http://speakerrate.com/speakers/11963-benjamin-lupton) (trainings, seminars, talks), [consulting](http://careers.stackoverflow.com/balupton) (development, advisory), sponsorship (angels, investors, donations, advertisement), interviews, chats, hackathons, socials and mentoring.
02dcc4c @balupton Added support section to readme.
authored
149
150
28dacb6 @balupton Minor updates to readme. Mostly typos. Also added a 'Giving Support' sec...
authored
151 ## Giving Support
152
dc3629d @balupton Cleaned giving support section.
authored
153 If you'd love to give some support back and make a difference; here are a few great ways you can give back!
28dacb6 @balupton Minor updates to readme. Mostly typos. Also added a 'Giving Support' sec...
authored
154
910f8ff @balupton Typos
authored
155 - Give it your honest rating on its [jQuery Plugin's Page](http://plugins.jquery.com/project/history-js) and its [Ohloh Page](https://www.ohloh.net/p/history-js)
78681ff @balupton updated commit feed link
authored
156 - If you have any feedback or suggestions let me know via its [Issue Tracker](https://github.com/balupton/history.js/issues) - so that I can ensure you get the best experience!
28dacb6 @balupton Minor updates to readme. Mostly typos. Also added a 'Giving Support' sec...
authored
157 - Spread the word via tweets, blogs, tumblr, whatever - the more people talking about it the better!
fc56a70 @balupton removed demo subscribe form
authored
158 - [Make a donation](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=balupton%40gmail%2ecom&lc=AU&item_name=Donation%20to%20Benjamin%20Lupton&currency_code=AUD&bn=PP%2dDonationsBF%3adonate%2egif%3aNonHosted) - every cent truly does help!
29fd043 @balupton added showcase link
authored
159 - Add your website or app which is using History.js to the [Showcase](https://github.com/balupton/history.js/wiki/Showcase)
78681ff @balupton updated commit feed link
authored
160 - Watch it via clicking the "watch" button up the top of its [Project Page](https://github.com/balupton/history.js)
28dacb6 @balupton Minor updates to readme. Mostly typos. Also added a 'Giving Support' sec...
authored
161
dc3629d @balupton Cleaned giving support section.
authored
162 Thanks! every bit of help really does make a difference. Again thank you.
28dacb6 @balupton Minor updates to readme. Mostly typos. Also added a 'Giving Support' sec...
authored
163
164
f4e3f60 @balupton Cleaned files. Improved documentation.
authored
165 ## Browsers: Tested and Working In
ba466c3 @balupton Now working with prototype.
authored
166
f4e3f60 @balupton Cleaned files. Improved documentation.
authored
167 ### HTML5 Browsers
168
3818f02 @balupton Made good progress. Building completed. Just needs testing now.
authored
169 - Firefox 4+
170 - Chrome 8+
171 - Opera 11.5
172 - Safari 5.0+
173 - Safari iOS 4.3+
f4e3f60 @balupton Cleaned files. Improved documentation.
authored
174
175 ### HTML4 Browsers
88c3212 @balupton Lots more working.
authored
176
3818f02 @balupton Made good progress. Building completed. Just needs testing now.
authored
177 - IE 6, 7, 8, 9
88c3212 @balupton Lots more working.
authored
178 - Firefox 3
3818f02 @balupton Made good progress. Building completed. Just needs testing now.
authored
179 - Opera 10, 11.0
330416f @balupton Added some more demos. Fixed safari bug replaceState bug. Now need to fi...
authored
180 - Safari 4
3818f02 @balupton Made good progress. Building completed. Just needs testing now.
authored
181 - Safari iOS 4.2, 4.1, 4.0, 3.2
f2ac286 @balupton First version complete.
authored
182
183
09127ba @balupton Cleaned documentation, a few other things. Not ready yet as some tests a...
authored
184 ## Exposed API
185
186 ### Functions
187
a9ccf1d @balupton Typos.
authored
188 - `History.pushState(data,title,url)` <br/> Pushes a new state to the browser; `data` can be null or an object, `title` can be null or a string, `url` must be a string
189 - `History.replaceState(data,title,url)` <br/> Replaces the existing state with a new state to the browser; `data` can be null or an object, `title` can be null or a string, `url` must be a string
190 - `History.getState()` <br/> Gets the current state of the browser, returns an object with `data`, `title` and `url`
191 - `History.getHash()` <br/> Gets the current hash of the browser
f4e3f60 @balupton Cleaned files. Improved documentation.
authored
192 - `History.Adapter.bind(element,event,callback)` <br/> A framework independent event binder, you may either use this or your framework's native event binder.
193 - `History.Adapter.trigger(element,event)` <br/> A framework independent event trigger, you may either use this or your framework's native event trigger.
194 - `History.Adapter.onDomLoad(callback)` <br/> A framework independent onDomLoad binder, you may either use this or your framework's native onDomLoad binder.
09127ba @balupton Cleaned documentation, a few other things. Not ready yet as some tests a...
authored
195 - `History.back()` <br/> Go back once through the history (same as hitting the browser's back button)
196 - `History.forward()` <br/> Go forward once through the history (same as hitting the browser's forward button)
197 - `History.go(X)` <br/> If X is negative go back through history X times, if X is positive go forwards through history X times
198 - `History.log(...)` <br/> Logs messages to the console, the log element, and fallbacks to alert if neither of those two exist
199 - `History.debug(...)` <br/> Same as `History.log` but only runs if `History.debug.enable === true`
200
201 ### Events
202
14d196b @balupton Attempted to add a YUI adapter, failing miserably.
authored
203 - `window.onstatechange` <br/> Fired when the state of the page changes (does not include hash changes)
09127ba @balupton Cleaned documentation, a few other things. Not ready yet as some tests a...
authored
204 - `window.onanchorchange` <br/> Fired when the anchor of the page changes (does not include state hashes)
205
206
7529b35 @balupton Fixed Google Chrome issue. Now have to retest in HTML4 Browsers.
authored
207 ## Notes on Compatibility
208
fdfefac @balupton v1.6 preparation. Removed initial statechange fire. Added some url utili...
authored
209 - History.js **solves** the following browser bugs:
330416f @balupton Added some more demos. Fixed safari bug replaceState bug. Now need to fi...
authored
210 - HTML5 Browsers
14d196b @balupton Attempted to add a YUI adapter, failing miserably.
authored
211 - Chrome 8 sometimes does not contain the correct state data when traversing back to the initial state
ca86372 @balupton Changed _state to _suid. Updated readme.
authored
212 - Safari 5, Safari iOS 4 and Firefox 3 and 4 do not fire the `onhashchange` event when the page is loaded with a hash
330416f @balupton Added some more demos. Fixed safari bug replaceState bug. Now need to fi...
authored
213 - Safari 5 and Safari iOS 4 do not fire the `onpopstate` event when the hash has changed unlike the other browsers
214 - Safari 5 and Safari iOS 4 fail to return to the correct state once a hash is replaced by a `replaceState` call / [bug report](https://bugs.webkit.org/show_bug.cgi?id=56249)
215 - Safari 5 and Safari iOS 4 sometimes fail to apply the state change under busy conditions / [bug report](https://bugs.webkit.org/show_bug.cgi?id=42940)
216 - Google Chrome 8,9,10 and Firefox 4 prior to the RC will always fire `onpopstate` once the page has loaded / [change recommendation](http://hacks.mozilla.org/2011/03/history-api-changes-in-firefox-4/)
217 - Safari iOS 4.0, 4.1, 4.2 have a working HTML5 History API - although the actual back buttons of the browsers do not work, therefore we treat them as HTML4 browsers
9276538 @balupton Cleaned code up. Still a few bits left to document. Fixed state data bug...
authored
218 - None of the HTML5 browsers actually utilise the `title` argument to the `pushState` and `replaceState` calls
330416f @balupton Added some more demos. Fixed safari bug replaceState bug. Now need to fi...
authored
219 - HTML4 Browsers
9276538 @balupton Cleaned code up. Still a few bits left to document. Fixed state data bug...
authored
220 - Old browsers like MSIE 6,7 and Firefox 2 do not have a `onhashchange` event
221 - MSIE 6 and 7 sometimes do not apply a hash even it was told to (requiring a second call to the apply function)
330416f @balupton Added some more demos. Fixed safari bug replaceState bug. Now need to fi...
authored
222 - Non-Opera HTML4 browsers sometimes do not apply the hash when the hash is not `urlencoded`
703124e @balupton v1.7 beta. Need to test properly.
authored
223 - All Browsers
224 - State data and titles do not persist once the site is left and then returned (includes page refreshes)
225 - State titles are never applied to the `document.title`
535d2ad @balupton Updated readme
authored
226 - ReplaceState functionality is emulated in HTML4 browsers by discarding the replaced state, so when the discarded state is accessed it is skipped using the appropriate `History.back()` / `History.forward()` call
833fd3a @balupton Fixed a recursion issue with FF3.6. Removed Firebug Lite.
authored
227 - Data persistance and synchronisation works like so: Every second or so, the SUIDs and URLs of the states will synchronise between the store and the local session. When a new session opens a familiar state (via the SUID or the URL) and it is not found locally then it will attempt to load the last known stored state with that information.
c2c15fa @balupton Fixed url encoding issue.
authored
228 - URLs will be unescaped to the maximum, so for instance the URL `?key=a%20b%252c` will become `?key=a b c`. This is to ensure consistency between browser url encodings.
833fd3a @balupton Fixed a recursion issue with FF3.6. Removed Firebug Lite.
authored
229 - Changing the hash of the page causes `onpopstate` to fire (this is expected/standard functionality). To ensure correct compatibility between HTML5 and HTML4 browsers the following events have been created:
14d196b @balupton Attempted to add a YUI adapter, failing miserably.
authored
230 - `window.onstatechange`: this is the same as the `onpopstate` event except it does not fire for traditional anchors
231 - `window.onanchorchange`: this is the same as the `onhashchange` event except it does not fire for states
8b30581 @balupton Minor fix. Updated readme to talk about Opera 11 issue under load.
authored
232 - Known Issues
833fd3a @balupton Fixed a recursion issue with FF3.6. Removed Firebug Lite.
authored
233 - Opera 11 fails to create history entries when under stressful loads (events fire perfectly, just the history events fail) - there is nothing we can do about this
234 - Mercury iOS fails to apply url changes (hashes and HTML5 History API states) - there is nothing we can do about this
7529b35 @balupton Fixed Google Chrome issue. Now have to retest in HTML4 Browsers.
authored
235
f2ac286 @balupton First version complete.
authored
236
c76ef2c @balupton Added graceful upgradation of HTML4 States to HTML5 Browsers... but it s...
authored
237 ## Changelog
238
4cc19a3 @balupton readme updates
authored
239 - v1.7.1-dev - September 27 2011
240 - Added native adapter to support any/no framework
241 - Some bugfixes that should be documented
242 - Provided bundled files
243 - Added sessionStorage support in core instead of optional Amplify.js Store support
9e95d0f @balupton v1.7.1-dev. pulled the adapters from v1.8, updated buildr, fixed jslint ...
authored
244
10f4cff @balupton Rebuilt. Documented. Date added to v1.7 release.
authored
245 - v1.7.0 - April 01 2011
553c355 @balupton Disabled support for IE6,7,8 when using the Prototype Adapter.
authored
246 - Added `History.enabled` property (refer to usage section). This reflects whether or not History.js is enabled for our particular browser. For instance, if we have not included support for a HTML4 browser and we are accessing through a HTML4 browser then `History.enabled` will be `false`.
247 - Added (optional but recommended) Data Persistance and Synchronisation Support thanks to [AppendTo's](http://appendto.com/) [Amplify.js](http://amplifyjs.com/) (refer to installation and compatibility sections for details)
78681ff @balupton updated commit feed link
authored
248 - Made HTML5 SUIDs more transparent - [Reported](https://github.com/balupton/history.js/issues#issue/34) by [azago](https://github.com/azago) and [Mark Jaquith](http://markjaquith.com/)
249 - Fixed Session Storage Issue - Reported by a whole bunch of different people; [one](https://github.com/balupton/history.js/issues#issue/36), [two](https://github.com/balupton/history.js/issues#issue/37), [three](http://getsatisfaction.com/balupton/topics/history_js_1_6_losing_state_after_manual_page_reload)
c2c15fa @balupton Fixed url encoding issue.
authored
250 - Fixed URL Encoding Issue - [Reported](https://github.com/balupton/history.js/issues/#issue/33) by [Rob Madole](http://robmadole.com/)
553c355 @balupton Disabled support for IE6,7,8 when using the Prototype Adapter.
authored
251 - Disabled support for IE6,7,8 when using the Prototype Adapter (there is nothing we can do about this, it is due to a bug in the prototype library) - [Reported](https://github.com/balupton/history.js/issues#issue/39) by [Sindre Wimberger](http://sindre.at/)
fc628e6 @balupton URLs in the State Hashes for HTML4 Browsers are now even shorter
authored
252 - URLs in the State Hashes for HTML4 Browsers are now even shorter - [Discussion](https://github.com/balupton/history.js/issues#issue/28)
fd06b4e @balupton v1.7 released :)
authored
253 - Fixed a issue with the MooTools Adapter and JSON with IE7 and IE8
703124e @balupton v1.7 beta. Need to test properly.
authored
254
9cdcd93 @balupton Recompiled and fixed final bug
authored
255 - v1.6.0 - March 22 2011
f522e04 @deleteme Fixed the spelling of my last name.
deleteme authored
256 - Added Zepto adapter thanks to [Matt Garrett](http://twitter.com/#!/matthewgarrett)
fdfefac @balupton v1.6 preparation. Removed initial statechange fire. Added some url utili...
authored
257 - The readme now references the supported versions of the libraries we use
14d196b @balupton Attempted to add a YUI adapter, failing miserably.
authored
258 - Updated vendors to the most recent versions. jQuery 1.5.1 and Mootools 1.3.1
9276538 @balupton Cleaned code up. Still a few bits left to document. Fixed state data bug...
authored
259 - Reverted versions of Safari iOS prior to version 4.3 to be HTML4 browsers, Safari iOS 4.3 is a HTML5 browser
bd6ea2f @balupton Fixed some more issues. Mostly HTML4 States initially in HTML5 browsers.
authored
260 - Refined code in History.js and its adapters
14d196b @balupton Attempted to add a YUI adapter, failing miserably.
authored
261 - Fixed issue with extra state being inserted on Safari 5 requiring an extra click on the back button to go home - [Reported](https://github.com/balupton/history.js/issues#issue/17) by [Rob Madole](http://robmadole.com/)
f522e04 @deleteme Fixed the spelling of my last name.
deleteme authored
262 - Fixed issue with Safari 5 and Safari iOS 4 sometimes failing to apply the state change under busy conditions - Solution conceived with [Matt Garrett](http://twitter.com/matthewgarrett)
bd6ea2f @balupton Fixed some more issues. Mostly HTML4 States initially in HTML5 browsers.
authored
263 - Fixed issue with HTML4 browsers requiring a query-string in the urls of states - [Reported](https://github.com/balupton/history.js/issues#issue/26) by [azago](https://github.com/azago)
264 - Fixed issue with HTML4 browsers requiring title in the states in order to use state data - [Reported](https://github.com/balupton/history.js/issues#issue/25) by [Jonathan McLaughlin](http://system-werks.com/)
265 - Fixed issue with HTML4 browsers failing is a state is pushed/replaced twice in a row - [Reported](https://github.com/balupton/history.js/issues#issue/17) by [Joey Baker](http://byjoeybaker.com/)
266 - **B/C BREAK:** The `statechange` event now only fires if the state has changed; it no longer fires on page initialisation. This is following the [Firefox 4 History API Changes](http://hacks.mozilla.org/2011/03/history-api-changes-in-firefox-4/) which we agree with - this breaks standard, but makes more sense.
fdfefac @balupton v1.6 preparation. Removed initial statechange fire. Added some url utili...
authored
267
535d2ad @balupton Updated readme
authored
268 - v1.5.0 - February 12 2011
6f85fef @balupton Updated readme to reflect latest changes.
authored
269 - Moved to UglifyJS instead of Google Closure
270 - Split HTML4 functionality from HTML5 functionality
271 - Installation details have changed (the filenames are different)
272
04697ac @balupton v1.4.1 - Added HTML5 Supported for Safari 5 and Safari iOS 4.2.1
authored
273 - v1.4.1 - February 10 2011
274 - Added HTML History API Support for Safari 5 and Safari iOS 4.2.1
275 - Cleaned code a bit (mostly with unit tests)
276
dc4cc15 @balupton v1.4.0 Release
authored
277 - v1.4.0 - February 10 2011
f4e3f60 @balupton Cleaned files. Improved documentation.
authored
278 - Unit Testing now uses [QUnit](http://docs.jquery.com/Qunit)
279 - Corrected Safari 5 Support
280 - Now uses queues instead of timeouts
281 - This means the API works exactly as expected, no more need to wrap calls in timeouts
519ed6e @balupton Updated readme a bit more.
authored
282 - Included a Subscribe Form in the Demo for Version Updates via Email
dc4cc15 @balupton v1.4.0 Release
authored
283 - Small updates to Documentation
f4e3f60 @balupton Cleaned files. Improved documentation.
authored
284
b3614b9 @balupton Improved documentation.
authored
285 - v1.3.1 - February 04 2011
286 - Improved Documentation
09127ba @balupton Cleaned documentation, a few other things. Not ready yet as some tests a...
authored
287
d1d85e7 @balupton Fixed date in changelog for v1.3.0 release
authored
288 - v1.3.0 - January 31 2011
c76ef2c @balupton Added graceful upgradation of HTML4 States to HTML5 Browsers... but it s...
authored
289 - Support for cleaner HTML4 States
290
23d7a97 @balupton Clean HTML4 States completed. Tests now have to run longer... 8 seconds ...
authored
291 - v1.2.1 - January 30 2011
78681ff @balupton updated commit feed link
authored
292 - Fixed History.log always being called - [reported by dlee](https://github.com/balupton/history.js/issues/#issue/2)
b564e7c @balupton v1.2.1 - Re-Added History.go, updated the documentation, changed History...
authored
293 - Re-Added `History.go(index)` support
294
23d7a97 @balupton Clean HTML4 States completed. Tests now have to run longer... 8 seconds ...
authored
295 - v1.2.0 - January 25 2011
c76ef2c @balupton Added graceful upgradation of HTML4 States to HTML5 Browsers... but it s...
authored
296 - Support for HTML4 States in HTML5 Browsers (added test)
297 - Updates of Documentation
298
23d7a97 @balupton Clean HTML4 States completed. Tests now have to run longer... 8 seconds ...
authored
299 - v1.1.0 - January 24 2011
c76ef2c @balupton Added graceful upgradation of HTML4 States to HTML5 Browsers... but it s...
authored
300 - Developed a series of automated test cases
301 - Fixed issue with traditional anchors
302 - Fixed issue with differing replaceState functionality in HTML4 Browsers
303 - Fixed issue with Google Chrome artefacts being carried over to the initial state
304 - Provided `onstatechange` and `onanchorchange` events
305
23d7a97 @balupton Clean HTML4 States completed. Tests now have to run longer... 8 seconds ...
authored
306 - v1.0.0 - January 22 2011
c76ef2c @balupton Added graceful upgradation of HTML4 States to HTML5 Browsers... but it s...
authored
307 - Supported `History.pushState` and `History.replaceState` degradation
308 - Supported jQuery, MooTools and Prototype Frameworks
309
310
311 ## Todo for Upcoming Releases
312
535d2ad @balupton Updated readme
authored
313 - Allow for url to be optional in `pushState` and `replaceState` calls
583a3f7 @balupton Performed split. Added uglify.
authored
314 - Add an Ajax extension to succeed the [jQuery Ajaxy](http://balupton.com/projects/jquery-ajaxy) project
315 - Add a compilation test to ensure `.debug = false` and no `History.log` or `console.xxx` calls exist.
535d2ad @balupton Updated readme
authored
316
78681ff @balupton updated commit feed link
authored
317 It's likely these features and/or others have been included in the latest [dev branch](https://github.com/balupton/history.js/tree/dev). If you are wanting to fork and help out, then be sure to work on the dev branch and not master.
Something went wrong with that request. Please try again.