https://github.com/tmeasday/meteor-html5-history-api

https://github.com/tmeasday/meteor-html5-history-api

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/tmeasday/meteor-html5-history-api
• Owner: tmeasday
• Created: 2013-01-25T02:24:23.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2014-05-11T23:19:24.000Z (over 10 years ago)
• Last Synced: 2024-10-04T18:50:10.837Z (3 months ago)
• Language: JavaScript
• Size: 151 KB
• Stars: 7
• Watchers: 2
• Forks: 6
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Meteor HTML5 History API

If your Meteor app/site uses routes (e.g: [IronRouter][]) and

needs to run in an older browser (pre-HTML5) 

you will need a [Polyfill][] for [HTML5 History][].

This package loads a file called **history.js** into your app 

giving older browsers the [HTML5 History API][] 

## Install

```

mrt add HTML5-History-API

```

(That's it. Back to building your awesome Meteor App!)

- - - 

## About This Package

This package loads [HTML5 History API][] which uses

[history.js][]. 

Most of the time you will not interact directly with the History API by writing

`History.pushState` in your app ([IronRouter][] does that for you),

but if you ever want to learn more about (re-)writing history see below.

## Background on HTML5 History API

Modern ("Single Page") Web Apps change the url in the browser

and display fresh content without refreshing the page.

In order to *remember* which pages have been visited 

(and thus be able to use the browser's back/forward button) the 

[HTML5 History][] was added.

Demos: http://html5demos.com/history

### Internet Explorer! :cry:

Sadly, 20% of internet users are still stuck on Internet Explorer pre v.10

(and older versions of both IOS and Android's *stock* browsers do not support

HTML5 History) so in order to give these visitors the single-page-app 

experience you need to include this package.

![Can I Use - History](http://i.imgur.com/5RNZBG9.png)

See: http://caniuse.com/#search=history

### Further Reading

- MDN article: https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Manipulating_the_browser_history

- How IronRouter uses History: https://github.com/EventedMind/iron-router/blob/dev/lib/client/location.js

[IronRouter]: https://github.com/EventedMind/iron-router

[Polyfill]: http://remysharp.com/2010/10/08/what-is-a-polyfill

[HTML5 History]: http://html5doctor.com/history-api/

[HTML5 History API]: https://github.com/devote/HTML5-History-API

[history.js]: https://github.com/browserstate/history.js