DN-26: Moved configuration from Config to WelcomeWidgetFactory.ts

conterra · Apr 24, 2024 · 41adf19 · 41adf19
1 parent c3fd1ee
commit 41adf19
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 64 deletions.
diff --git a/src/main/js/apps/sample/app.json b/src/main/js/apps/sample/app.json
@@ -40,7 +40,7 @@
                 "buttonText": "${welcome.buttonText}",
                 "buttonDependsOnCheckbox": false,
                 "showCheckbox": true,
-                "checkboxChecked": true,
+                "checkboxChecked": false,
                 "checkboxText": "${welcome.checkboxText}",
                 "showImage": true,
                 "imageHeight": "300px",

diff --git a/src/main/js/bundles/dn_welcome/Config.ts b/src/main/js/bundles/dn_welcome/Config.ts
diff --git a/src/main/js/bundles/dn_welcome/WelcomeWidgetFactory.ts b/src/main/js/bundles/dn_welcome/WelcomeWidgetFactory.ts
@@ -17,20 +17,17 @@
 import WelcomeWidget from "./WelcomeWidget.ts.vue";
 import Vue from "apprt-vue/Vue";
 import VueDijit from "apprt-vue/VueDijit";
-import Config from "./Config";
 
 export default class WelcomeWidgetFactory {
-    #config: Config;
     #windowToggleTool: any;
     #doNotShowStorageKey = "dn_welcome.doNotShow";
     #widget: any;
 
-    constructor(config?: Config) {
-        this.#config = config || new Config();
+    constructor(props: Partial<Config>) {
+        this.#widget = this.#createWelcomeWidget(props);
     }
 
     activate(): void {
-        this.#initComponent();
         this.#applySavedDoNotShowWindowState();
     }
 
@@ -40,9 +37,8 @@ export default class WelcomeWidgetFactory {
         }
     }
 
-    #initComponent(): void {
-        const config = this.#config;
-        const vm = this.#widget = new Vue(WelcomeWidget);
+    #createWelcomeWidget(config: Partial<Config>): any {
+        const vm: any = new Vue(WelcomeWidget);
         vm.heading = config.heading;
         vm.infoText = config.infoText;
         vm.infoTextUrl = config.infoTextUrl;
@@ -62,22 +58,35 @@ export default class WelcomeWidgetFactory {
             } else {
                 localStorage.removeItem(this.#doNotShowStorageKey);
             }
-            this.#windowToggleTool.set("active", false);
+            this.#windowToggleTool?.set("active", false);
         });
+
+        return vm;
     }
 
     #applySavedDoNotShowWindowState(): void {
         const doNotShowAgain = localStorage.getItem(this.#doNotShowStorageKey);
         if (doNotShowAgain !== "1") {
-            this.#windowToggleTool.set("active", true);
+            this.#windowToggleTool?.set("active", true);
         }
     }
 
-    set config(config: Config) {
-        this.#config = config;
-    }
-
     set windowToggleTool(tool: any) {
         this.#windowToggleTool = tool;
     }
 }
+
+interface Config {
+    heading: string;
+    infoText: string;
+    infoTextUrl: string;
+    showButton: boolean;
+    buttonText: string;
+    buttonDependsOnCheckbox: boolean;
+    showCheckbox: boolean;
+    checkboxText: string;
+    checkboxChecked: boolean;
+    showImage: boolean;
+    imageUrl: string;
+    imageHeight: string;
+}
diff --git a/src/main/js/bundles/dn_welcome/manifest.json b/src/main/js/bundles/dn_welcome/manifest.json
@@ -57,9 +57,11 @@
     "components": [
         {
             "name": "Config",
-            "provides": "dn_welcome.Config",
+            "provides": "dijit.Widget",
+            "instanceFactory": true,
             "propertiesConstructor": true,
             "properties": {
+                "widgetRole": "welcomeWidget",
                 "heading": "",
                 "infoText": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.",
                 "infoTextUrl": "",
@@ -72,20 +74,8 @@
                 "showImage": true,
                 "imageHeight": "300px",
                 "imageUrl": ""
-            }
-        },
-        {
-            "name": "WelcomeWidgetFactory",
-            "provides": "dijit.Widget",
-            "instanceFactory": true,
-            "properties": {
-                "widgetRole": "welcomeWidget"
             },
             "references": [
-                {
-                    "name": "config",
-                    "providing": "dn_welcome.Config"
-                },
                 {
                     "name": "windowToggleTool",
                     "providing": "ct.tools.Tool",

diff --git a/src/main/js/bundles/dn_welcome/module.ts b/src/main/js/bundles/dn_welcome/module.ts
@@ -14,5 +14,4 @@
 /// limitations under the License.
 ///
 
-export {default as WelcomeWidgetFactory} from "./WelcomeWidgetFactory";
-export {default as Config} from "./Config";
+export {default as Config} from "./WelcomeWidgetFactory";