API Docs for: 0.13.12
Show:

Router.History Class

Defined in: src\firebrick.js:2282
Module: Firebrick

Methods

_registerLinkEvent

() private

Defined in src\firebrick.js:2324

used by init

_registerPopEvent

() private

Defined in src\firebrick.js:2365

location

(
  • url
  • args
)

Defined in src\firebrick.js:2343

similar to window.location

Parameters:

  • url Object
  • args Any Array
    • optional - use to pass arguments to callRoute

set

(
  • routes
)

Defined in src\firebrick.js:2295

set route definitions

Parameters:

  • routes Object | Function
    • if function then the function is called regardless of route

Returns:

routes function

Example:

    Firebrick.router.set({
        "users/abc": {
            require:["file1", "file2"],
            callback: function(){}
        },
        "contact": function(){}
        defaults: function(){}        //defaults pattern - fallback
    })
    Firebrick.router.set(function(){}) //call function regardless of route

Properties

_initialised

Boolean

Defined in src\firebrick.js:2288

used to see whether document events for the history API have already been set

Default: false