mirror of
https://github.com/vale981/Vulcan
synced 2025-03-10 12:36:39 -04:00
79 lines
No EOL
2.2 KiB
JavaScript
79 lines
No EOL
2.2 KiB
JavaScript
/**
|
|
* Template modules let you insert templates in specific zones in the app's layout.
|
|
* @namespace Telescope.modules
|
|
*/
|
|
|
|
Telescope.modules = {};
|
|
|
|
/**
|
|
* Add a module to a template zone
|
|
* @param {string} zone - The name of the zone
|
|
* @param {Object|Object[]} module - The module object (or an array of modules)
|
|
* @param {string} module.template - The template to include
|
|
* @param {number} module.order - The order of the template in the zone
|
|
*
|
|
* @example
|
|
* Telescope.modules.add("hero", {
|
|
* template: "newsletterBanner",
|
|
* order: 10,
|
|
* only: ["posts_default"]
|
|
* });
|
|
*/
|
|
Telescope.modules.add = function (zone, module) {
|
|
|
|
// if module zone array doesn't exist yet, initialize it
|
|
if (typeof Telescope.modules[zone] === "undefined") {
|
|
Telescope.modules[zone] = [];
|
|
}
|
|
|
|
if (Array.isArray(module)) {
|
|
|
|
var modules = module; // we're dealing with an Array, so let's add an "s"
|
|
modules.forEach( function (module) {
|
|
Telescope.modules[zone].push(module);
|
|
});
|
|
|
|
} else {
|
|
|
|
Telescope.modules[zone].push(module);
|
|
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Remove a module from a zone
|
|
* @param {string} zone - The name of the zone
|
|
* @param {string} template - The name of the template to remove
|
|
*/
|
|
Telescope.modules.remove = function (zone, template) {
|
|
Telescope.modules[zone] = _.reject(Telescope.modules[zone], function (module) {
|
|
return module.template === template;
|
|
});
|
|
};
|
|
|
|
/**
|
|
* Removes all modules from a zone
|
|
* @param {string} zone - The name of the zone
|
|
*/
|
|
Telescope.modules.removeAll = function (zone) {
|
|
Telescope.modules[zone] = [];
|
|
};
|
|
|
|
/**
|
|
* Retrieve an array containing all modules for a zone
|
|
* @param {string} zone - The name of the zone
|
|
* @returns {Object[]} Returns a sorted array of the zone's modules
|
|
*/
|
|
Telescope.modules.get = function (zone) {
|
|
return _.sortBy(Telescope.modules[zone], "order");
|
|
};
|
|
|
|
/**
|
|
* Add a route to the list of routes a module should be displayed on
|
|
* @param {string} zone - The name of the zone
|
|
* @param {string} template - The name of the module
|
|
* @param {string} route - The name of the route on which to display the module
|
|
*/
|
|
Telescope.modules.addRoute = function (zone, template, route) {
|
|
_.findWhere(Telescope.modules[zone], {template: template}).only.push(route);
|
|
}; |