From 237e4d43229847bb69aadcfa6e6aca517128913b Mon Sep 17 00:00:00 2001 From: TrueKuehli Date: Mon, 1 Oct 2018 14:15:05 +0200 Subject: Documented the code better and made some minor fixes --- WebInterface/NodeJSServer/src/modules/ui/backdrop.js | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) (limited to 'WebInterface/NodeJSServer/src/modules/ui/backdrop.js') diff --git a/WebInterface/NodeJSServer/src/modules/ui/backdrop.js b/WebInterface/NodeJSServer/src/modules/ui/backdrop.js index 243bbb3..1a24bd2 100644 --- a/WebInterface/NodeJSServer/src/modules/ui/backdrop.js +++ b/WebInterface/NodeJSServer/src/modules/ui/backdrop.js @@ -1,18 +1,32 @@ // Showing / Hiding the backdrop menu +/** + * Class for adding functionality to backdrop elements + */ export default class Backdrop { + /** + * Registers all important elements in the backdrop + * @param {string} backdropMenu ID of Backdrop Menu + * @param {string} frontLayer ID of Front Layer + * @param {string} menuButton ID of Show / Hide Menu Button + */ constructor(backdropMenu, frontLayer, menuButton) { this.backdrop = document.getElementById(backdropMenu); this.frontLayer = document.getElementById(frontLayer); this.menuButton = document.getElementById(menuButton); } - + /** + * Registers all neccessary events + */ register() { this.registerButtonEvent(); this.registerFrontLayerEvent(); } + /** + * Registers showing / hiding through menu button + */ registerButtonEvent() { this.menuButton.addEventListener('click', () => { // Hide / Unhide Backdrop Menu @@ -31,6 +45,9 @@ export default class Backdrop { }); } + /** + * Registers hiding, when clicking on the front layer + */ registerFrontLayerEvent() { // Hide menu when interacting with front layer this.frontLayer.addEventListener('click', () => { -- cgit v1.2.3-54-g00ecf