Notes/src/public/app/widgets/component.js

84 lines
2.3 KiB
JavaScript
Raw Normal View History

2020-02-01 11:15:58 +01:00
import utils from '../services/utils.js';
/**
* Abstract class for all components in the Trilium's frontend.
*
* Contains also event implementation with following properties:
* - event / command distribution is synchronous which among others mean that events are well ordered - event
* which was sent out first will also be processed first by the component
* - execution of the event / command is asynchronous - each component executes the event on its own without regard for
* other components.
* - although the execution is async, we are collecting all the promises and therefore it is possible to wait until the
* event / command is executed in all components - by simply awaiting the `triggerEvent()`.
*/
2020-01-15 21:36:01 +01:00
export default class Component {
2020-02-27 00:58:10 +01:00
constructor() {
2020-04-27 22:13:32 +02:00
this.componentId = `comp-` + utils.randomString(8);
2020-01-15 21:36:01 +01:00
/** @type Component[] */
this.children = [];
2020-01-18 18:01:16 +01:00
this.initialized = Promise.resolve();
2020-01-15 21:36:01 +01:00
}
2020-02-27 00:58:10 +01:00
setParent(parent) {
/** @type Component */
this.parent = parent;
2020-02-27 10:03:14 +01:00
return this;
}
2020-03-16 22:14:18 +01:00
child(...components) {
2020-03-16 21:16:09 +01:00
for (const component of components) {
2020-03-16 22:14:18 +01:00
component.setParent(this);
this.children.push(component);
2020-03-16 21:16:09 +01:00
}
return this;
}
/** @return {Promise} */
handleEvent(name, data) {
return Promise.all([
this.initialized.then(() => this.callMethod(this[name + 'Event'], data)),
this.handleEventInChildren(name, data)
]);
2020-01-15 21:36:01 +01:00
}
/** @return {Promise} */
triggerEvent(name, data) {
return this.parent.triggerEvent(name, data);
2020-01-15 21:36:01 +01:00
}
2020-01-24 20:15:53 +01:00
/** @return {Promise} */
handleEventInChildren(name, data) {
const promises = [];
2020-01-24 20:15:53 +01:00
for (const child of this.children) {
2020-02-16 19:21:17 +01:00
promises.push(child.handleEvent(name, data));
}
2020-01-24 20:15:53 +01:00
return Promise.all(promises);
2020-01-24 20:15:53 +01:00
}
2020-02-15 09:43:47 +01:00
/** @return {Promise} */
triggerCommand(name, data = {}) {
const fun = this[name + 'Command'];
if (fun) {
return this.callMethod(fun, data);
}
else {
return this.parent.triggerCommand(name, data);
}
}
2020-02-15 10:41:21 +01:00
async callMethod(fun, data) {
if (typeof fun !== 'function') {
return false;
}
await fun.call(this, data);
2020-02-15 09:43:47 +01:00
return true;
2020-02-15 09:43:47 +01:00
}
}