Source js/bauplan.app.js

  1. define([
  2.         "lodash",
  3.         "jquery",
  4.         "bauplan",
  5.         "larynx",
  6.         "socket.io",
  7.         "app.setup"
  8.     ], function (_, jQuery, Bauplan, Larynx, SocketIO, AppSettings) {
  9. /**
  10.  * @module bauplan%app
  11.  * @description ## Application instance
  12.  *
  13.  *     var App = require("bauplan.app");
  14.  *
  15.  * or as part of the Bauplan bundle
  16.  *
  17.  *     var Bauplan = require("bauplan");
  18.  *     var App = Bauplan.App;
  19.  *
  20.  * To set or get the app locale
  21.  * 
  22.  *     App.locale("fr");
  23.  *     var loc = App.locale(); // "fr"
  24.  *
  25.  * To (re-)render the entire app
  26.  *
  27.  *     App.render();
  28.  *
  29.  * This module performs the grunt work once all configuration and dependencies have been loaded
  30.  *
  31.  * - loads app settings from app.setup (if any)
  32.  * - sets app’s root view
  33.  *   - name
  34.  *   - id
  35.  *   - template
  36.  * - sets app locale/lang
  37.  *
  38.  * - renders app
  39.  *
  40.  * - calls callback (if any)
  41.  *
  42.  * @see  module:app%setup
  43.  * 
  44.  * @return {instance} App
  45.  */
  47.     /**
  48.      * @member {Object} settings
  49.      * @property {string} [name=main.layout] Main layout name
  50.      * @property {string} [id=main-layout] Main layout id
  51.      * @property {string} [template={{name}}.view] Main layout template
  52.      * @property {string} [element=#app] DOM target element
  53.      * @property {string} [locale=en] Default locale
  54.      * @property {function} [initialized] Post-initialization function
  55.      */
  56.     var settings = {
  57.         name: "main.layout",
  58.         id: "main-layout",
  59.         element: "#app",
  60.         locale: "en"
  61.     };
  62.     settings = _.extend(settings, AppSettings);
  63.     settings.template = settings.template || settings.name + ".view";
  65.     var App = {
  66.         /**
  67.          * @method render
  68.          * @description Renders the entire application from the root view
  69.          * @instance
  70.          * @memberOf module:bauplan%app
  71.          */
  72.         render: function() {
  73.             var mainLayout = new Bauplan.View(settings);
  74.             var $el = jQuery(settings.element);
  75.             $el.html("");
  76.             mainLayout.appendTo($el);
  77.         },
  78.         /**
  79.          * @description Set/get app locale
  80.          * @param {string} [loc] Value of locale
  81.          * @return {string} Value of locale
  82.          * @instance
  83.          * @memberOf module:bauplan%app
  84.          */
  85.         locale: function (loc) {
  86.             if (loc) {
  87.                 locale = loc;
  88.                 Larynx.locale(loc);
  89.             }
  90.             return Larynx.locale();
  91.         }
  92.     };
  93.     App.locale(settings.locale);
  95.     /*if (!jQuery.cookie("entry")) {
  96.         jQuery.cookie("entry", JSON.stringify({
  97.             referrer: document.referrer,
  98.             timestamp: (new Date()).toISOString()
  99.         }), { path: "/" });
  100.     }*/
  102.     App.render();
  103.     // not sure this shouldn't be in the router code, but what ho!
  104.     if (settings.initialized) {
  105.         settings.initialized();
  106.     }
  108.     Bauplan.App = App;
  109.     if (Bauplan.Config.callback) {
  110.         Bauplan.Config.callback();
  111.     }
  113.     return App;
  115. });