mirror of
https://github.com/Jermolene/TiddlyWiki5.git
synced 2025-12-15 15:10:30 -08:00
a36356a07d
* feat: added info tiddlers for viewport dimensions * feat: multi window support for dimensions info tiddlers * refactor: introduce standalone eventbus and refactor for ES2017 * docs: extended docs for InfoMechanism to cover new additions
59 lines
2 KiB
JavaScript
59 lines
2 KiB
JavaScript
/*\
|
|
title: $:/core/modules/startup/info.js
|
|
type: application/javascript
|
|
module-type: startup
|
|
|
|
Initialise $:/info tiddlers via $:/temp/info-plugin pseudo-plugin
|
|
|
|
\*/
|
|
|
|
"use strict";
|
|
|
|
// Export name and synchronous status
|
|
exports.name = "info";
|
|
exports.before = ["startup"];
|
|
exports.after = ["load-modules"];
|
|
exports.synchronous = true;
|
|
|
|
var TITLE_INFO_PLUGIN = "$:/temp/info-plugin";
|
|
|
|
exports.startup = function() {
|
|
// Function to bake the info plugin with new tiddlers
|
|
// additions: array of tiddler field objects
|
|
// removals: array of titles to remove
|
|
var updateInfoPlugin = function(additions = [], removals = []) {
|
|
// Get the existing tiddlers
|
|
var json = $tw.wiki.getTiddlerData(TITLE_INFO_PLUGIN,{tiddlers: {}});
|
|
$tw.utils.each(removals,function(title) {
|
|
if(json.tiddlers[title]) {
|
|
delete json.tiddlers[title];
|
|
}
|
|
});
|
|
$tw.utils.each(additions,function(fields) {
|
|
if(fields && fields.title) {
|
|
json.tiddlers[fields.title] = fields;
|
|
}
|
|
});
|
|
// Bake the info tiddlers into a plugin. We use the non-standard plugin-type "info" because ordinary plugins are only registered asynchronously after being loaded dynamically
|
|
var fields = {
|
|
title: TITLE_INFO_PLUGIN,
|
|
type: "application/json",
|
|
"plugin-type": "info",
|
|
text: JSON.stringify(json,null,$tw.config.preferences.jsonSpaces)
|
|
};
|
|
$tw.wiki.addTiddler(new $tw.Tiddler(fields));
|
|
|
|
};
|
|
// Collect up the info tiddlers
|
|
var tiddlerFieldsArray = [];
|
|
// Give each info module a chance to provide as many info tiddlers as they want as an array, and give them a callback for dynamically updating them
|
|
$tw.modules.forEachModuleOfType("info",function(title,moduleExports) {
|
|
if(moduleExports && moduleExports.getInfoTiddlerFields) {
|
|
Array.prototype.push.apply(tiddlerFieldsArray,moduleExports.getInfoTiddlerFields(updateInfoPlugin));
|
|
}
|
|
});
|
|
updateInfoPlugin(tiddlerFieldsArray);
|
|
$tw.wiki.readPluginInfo([TITLE_INFO_PLUGIN]);
|
|
$tw.wiki.registerPluginTiddlers("info",[TITLE_INFO_PLUGIN]);
|
|
$tw.wiki.unpackPluginTiddlers();
|
|
};
|