Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Backbone plugin for navigation direction tracking
JavaScript
branch: master

README.md

Overview

Build Status

WARNING: This project is not being actively supported as it proved problematic when real clients started hitting it. It's also known to be broken under Backbone 1.1.2.

History-tracker is a backbone plugin that enhances the history management options available in the core backbone library.

History Navigation APIs

This also adds support for

  • Backbone.history.back(trigger)
  • Backbone.history.forward(trigger)
  • Backbone.history.go(count, trigger)

Which mirror their associated window.history APIs but provide the ability to trigger or not trigger the route that the change lands on.

trigger may be a truthy value to cause the background route to execute or alternatively may be a callback of the form trigger(fragment, route) that should return truthy to trigger a particular route after the navigation has occurred.

Note that these calls do not prevent one from leaving the SPA context if the user has other pages before or after the current page in their history.

Backbone.history.stepOut

Dealing with iframes within a backbone app is problematic as they push on to your history stack and under most browsers this is not easily removed from the history by removing the iframe. Backbone.history.stepOut(options) provides a utility to work around this shortcoming by stepping backward until the iframe's history entries are removed in addition to the current backbone route entry.

Accepts an options hash with the following fields:

  • view: View element hosting the iframe. Any iframes hosted in this view will be removed. It is highly recommended that this is passed as it will reduce the chance of side effects from the iframe navigation and under some browsers it will make the operation significantly faster.
  • callback(fragment, existingTriggered): Callback that is called when the operation is complete
  • trigger: Same options as the trigger parameter above. Additionally may be a string parameter which will ensure the final route is the result of the operation.
  • stepLimit : Maximum number of steps to take. This is designed to prevent runaway operations. Defaults to 10
  • routeLimit: When used in conjunction with a string trigger parameter defines the maximum number of steps to try to find the trigger parameter before forcing the new trigger route. Defaults to 1 and is independent of the stepLimit parameter.

History Location Tracking

When enabled, this feature will associate an incrementing index with every route the user visits. This is beneficial, for example, if you are interested in having a different transition from routes depending on whether the user has clicked the back button or transitioned to a new route.

With "push state" support

Every time a new route is visited, the URL state will have the unique index associated

No "push state" support

Every time a new route is visited, the route will be re-written to be prefixed with #{index}#. The Backbone.History.getFragment will return the fragment will return the fragment value without the additional state.

Usage

To turn on the route indexing, use the trackDirection property.

Backbone.history.start({trackDirection: true});

Hacks and Workarounds

Webkit location.replace

https://bugs.webkit.org/show_bug.cgi?id=63777

Webkit has known issues with location.replace so when available we opt to use replaceState under Webkit.

Android Replace Navigation

https://bugs.webkit.org/show_bug.cgi?id=85881

Under Android the replace operation does not properly replace content, leading to corruption of the history. Net effect is that a series of operations such as:

  1. Trigger #foo
  2. Replace #bar
  3. Trigger #baz

Will corrupt the history producing an actual history of:

  1. #foo
  2. #baz

This is fixed by making replace navigations two step on the devices known to exhibit this behavior.

Caveats

This will break sites that attempt to do a replace navigation on the first page. For sites that absolutely must do this, the noReplaceHack flag may be utilized at the expense of broken replace behavior in these environments.

Chrome for iOS form resubmission issue

https://code.google.com/p/chromium/issues/detail?id=241888 https://code.google.com/p/chromium/issues/detail?id=244434

In Google Chrome for iOS the behavior of window.history.back() and window.history.go(-1) are not equivalent. In case when page containing iframe submits a form to an iframe (via method POST) the page URI is getting added to window.history, and the following call of window.history.go(-1) causes the attempt to resubmit the form, and, consequently shows the "Confirm form resubmission" dialog, when window.history.back() behaves as expected.

Expected to be fixed in Chrome for iOS in v.28.

Running Unit Tests

  1. In backbone-historytracker directory run node ./test/bin/server.js "" 1234
  2. In the browser navigate to http://localhost:1234/test/index.html
Something went wrong with that request. Please try again.