API Docs for: 0.13.12
Show:

Firebrick Class

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

A lightweight JavaScript MVC Framework powered with jQuery, Knockout JS and Require JS

Methods

addListener

()

Defined in src\firebrick.js:211

shortcut for Firebrick.events.addListener

application

(
  • options
)

Defined in src\firebrick.js:60

ready function to kick start the application

Parameters:

  • options Object
    • ready Object

      {Function} - called on document ready

    • app Object
      • name Object
        name of the app
      • path Object
        path of the app
    • autoRender Object

      {Boolean} whether to call first view automatically "{app.name}.view.Index",

    • viewData Object

      {Object} viewData to be passed to the autoRender view,

    • splash Object

      {String} - html or string to be rendered before the document is loaded - removed on document.ready

    • require Object

      {String, Array of Strings} file(s) are required

    • cache Object

      {Boolean} [cache=true] whether require should cache files or not,

    • dev Object

      {Boolean} [dev=false] true to print requirejs exceptions to console

    • lang Object

      language file name or store,

create

()

Defined in src\firebrick.js:148

shortcut for Firebrick.classes:create

createController

()

Defined in src\firebrick.js:162

shortcut for Firebrick.controllers.createController

createStore

()

Defined in src\firebrick.js:246

shortcut for Firebrick.data.store.createStore

createView

()

Defined in src\firebrick.js:183

shortcut for Firebrick.views.createView

define

()

Defined in src\firebrick.js:155

shortcut for Firebrick.classes:define

defineView

()

Defined in src\firebrick.js:190

shortcut for Firebrick.views.defineView

delay

()

Defined in src\firebrick.js:204

shortcut for Firebrick.utils.delay

fireEvent

()

Defined in src\firebrick.js:225

shortcut for Firebrick.events.fireEvent

get

()

Defined in src\firebrick.js:134

shortcut for Firebrick.classes:get

getBody

()

Defined in src\firebrick.js:197

shortcut for Firebrick.views.getBody

getById

()

Defined in src\firebrick.js:141

shortcut for Firebrick.classes:getById

loadRaw

()

Defined in src\firebrick.js:176

shortcut for Firebrick.views.loadRaw

off

()

Defined in src\firebrick.js:239

shortcut for Firebrick.events.off

on

()

Defined in src\firebrick.js:232

shortcut for Firebrick.events.on

removeListener

()

Defined in src\firebrick.js:218

shortcut for Firebrick.events.removeListener

require

()

Defined in src\firebrick.js:169

shortcut for Firebrick.utils.require

shortcut

(
  • scope
  • func
  • args
)
Many private

Defined in src\firebrick.js:122

Parameters:

  • scope Object
  • func String
  • args Args..

Returns:

Many:

stackTrace

(
  • force
)

Defined in src\firebrick.js:113

show stackTrace at any given point by creating an error. This will only work if the application is in "dev" mode.

Parameters:

  • force Boolean

    [default=false] set to true to force the stacktrace in prod mode too

Returns:

stack trace

text

()

Defined in src\firebrick.js:253

shortcut for Firebrick.languages.getByKey

Properties

_ns

Array private

Defined in src\firebrick.js:52

Default: [app.name]

app.name

Object private

Defined in src\firebrick.js:41

used to store configurations set Firebrick.ready()

scrollContainerSelector

String

Defined in src\firebrick.js:271

Default: "body, html"

scrollTopOffset

Integer | Function

Defined in src\firebrick.js:261

this is used in conjunction with "scrollTo" url parameter. This is needed if you have a fixed header for example and the browser scroll the anchor to position 0 which is behind the header - effectively cutting off content

Default: 0

version

String

Defined in src\firebrick.js:35