/Backbone-addon

Backbone has a great MV* convention, however, the views, models, and collections need to be managed in some way for easy access in application. This add-on provides ways to access those components in one place via app global variable.

Primary LanguageJavaScript

Backbone-addon

Backbone has a great MV* convention, however, the views, models, and collections need to be managed in some way for easy access in application. This add-on provides ways to access those components in one place via app global variable.

Getting Started

Download the source code to your client side JavaScript folder.

Application setup

  • Navigate to your application folder.
  • Create application folder in your client code folder. This folder looks like the sampleApp folder, which contains collections, models, routers, and views
  • Create index.js to tell the add-on what to load into the app on start up
var startup = app.startup = function() {
  console.log('Initilizing application...');

 app.application({
    name: 'Sample app',
    views: [
      
    ],
    collections: [
     
    ],
    routers: [
      'Main'
    ],
    launch: function() {
     
      console.log('Launch function run.');
    }
  });
};
  • Create your models, collections, routers, and views accordingly in the application folder

Usage

  • Make sure your html page reference your javascript code.
  • Trigger application startup function in your HTML page.
    $(function() {
      if (typeof startup == 'function')
        startup();
    });
  • Finally, anywhere in your app, you can access your routers, collection, models, and views via global variable app.
	//get component by name
	app.getCollection('name');
	app.getView('name');
	app.getRouter('name');
	app.getModel('name');
	
	//get all components by type
	app.getCollections();
	app.getViews();
	app.getRouters();
	app.getModels();