Browse files

Initial Version. Supports IE8, FF3.6, Chrome, and Safari

  • Loading branch information...
0 parents commit 3d4120b8fcc9838763b7c40f1d739451066118d7 @fortes committed Jul 22, 2010
Showing with 917 additions and 0 deletions.
  1. +1 −0 .gitignore
  2. +3 −0 .gitmodules
  3. +59 −0
  4. +35 −0 Rakefile
  5. +202 −0 bin/closure-compiler/COPYING
  6. +261 −0 bin/closure-compiler/README
  7. BIN bin/closure-compiler/compiler.jar
  8. +8 −0 src/externs.js
  9. +197 −0 src/history.js
  10. +150 −0 test/index.html
  11. +1 −0 test/qunit
@@ -0,0 +1 @@
@@ -0,0 +1,3 @@
+[submodule "test/qunit"]
+ path = test/qunit
+ url = git://
@@ -0,0 +1,59 @@
+# history.js
+history.js provides an implementation of the [HTML5 history API]( `history.pushState` and `history.replaceState` functions, as well as the `window.onpopstate` event.
+Browsers that already support his event (Chrome & Safari, Firefox 4+) use native implementations, which are able to change the page URL without refreshing the page. Older browsers use `location.hash` in order to mimic the official behavior.
+## Limitations
+* Does not support multiple handlers for the `onpopstate` event
+## Installation
+Include the script file in your HTML file:
+ <!-- Include JSON if you want to support older browsers -->
+ <script type="text/javascript" src="json2.js"></script>
+ <script type="text/javascript" src="history-min.js"></script>
+## Usage
+Same as the official HTML5 API:
+ // Switch to the item
+ window.history.pushState({ id: 35 }, 'Viewing item #35', '/item/35'});
+ window.onpopstate = function (e) {
+ var id =;
+ load_item(id);
+ };
+Any use allowed in the standard but not supported by this API is considered a bug.
+## Supported & Tested Browsers
+* Chrome 5+ & Safari 5+ (Native)
+* Firefox 4+ (Native)
+* Firefox 3.5+
+* Chrome 4+
+* Safari 4+
+* IE8+
+## Unsupported / Need to test
+* Opera ?
+* IE6-7
+* Safari 3+ (No persitence)
+* Chrome 3+ (No persitence)
+* Firefox 2+ (No persitence)
+## TODO
+* Support IE6&7
+ * Use `iframe` for history
+ * Use `userData` behavior for persistence
+* Support FF2+
+ * Use `globalStorage` for persistence
+* Chrome < 4
+ * Use Gears?
+* Fallback for browsers that are unsupported
@@ -0,0 +1,35 @@
+require 'rake'
+require 'rake/packagetask'
+require 'rake/clean'
+HOME_DIR = File.expand_path(File.dirname(__FILE__))
+BUILD_DIR = File.join(HOME_DIR, 'build')
+SRC_DIR = File.join(HOME_DIR, 'src')
+LIB_DIR = File.join(HOME_DIR, 'lib')
+BIN_DIR = File.join(HOME_DIR, 'bin')
+CLOSURE_LIBRARY_DIR = File.join(HOME_DIR, '..', 'closure-library-read-only/closure')
+task :default => :compile
+desc 'Compile using closure compiler'
+task :compile do
+ verbose(false) { mkdir_p(BUILD_DIR) }
+ closure_compiler = File.join(BIN_DIR, 'closure-compiler', 'compiler.jar')
+ files = [
+ "--js #{File.join(SRC_DIR, 'history.js')}"
+ ]
+ compiler_flags = [
+ "--compilation_level=ADVANCED_OPTIMIZATIONS",
+ "--warning_level=VERBOSE",
+ "--summary_detail_level=3",
+ "--js_output_file=#{File.join(BUILD_DIR, 'history-min.js')}",
+ "--define='DEBUG=false'",
+ "--externs=#{File.join(SRC_DIR, 'externs.js')}"
+ ]
+ sh "java -jar #{closure_compiler} #{files.join(' ')} #{compiler_flags.join(' ')}"
@@ -0,0 +1,202 @@
+ Apache License
+ Version 2.0, January 2004
+ 1. Definitions.
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ implied, including, without limitation, any warranties or conditions
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+ APPENDIX: How to apply the Apache License to your work.
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+ Copyright [yyyy] [name of copyright owner]
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ See the License for the specific language governing permissions and
+ limitations under the License.
Oops, something went wrong.

0 comments on commit 3d4120b

Please sign in to comment.