show/hide bar icon

Author: RafaelGB

src/Settings.ts

@@ -15,6 +15,7 @@ import editing_engine_settings_section from "settings/EditingEngineSection";
 import rows_settings_section from "settings/RowsSection";
 import csv_settings_section from "settings/CSVSection";
 import automation_settings_section from "settings/AutomationSection";
+import helpers_settings_section from "settings/HelpersSection";
 
 export type SettingRetriever = <K extends keyof DatabaseSettings>(
   key: K,
@@ -99,6 +100,8 @@ export class SettingsManager {
       media_settings_section(settingHandlerResponse);
       /** CSV section */
       csv_settings_section.run(settingHandlerResponse);
+      /** Helpers/Commands section */
+      helpers_settings_section.run(settingHandlerResponse);
       /** Developer section */
       developer_settings_section.run(settingHandlerResponse);
     }
@@ -129,7 +132,7 @@ export class SettingsModal extends Modal {
     config: SettingsManagerConfig,
     settings: DatabaseSettings
   ) {
-    super(view.app);
+    super(app);
 
     this.view = view;
     this.settingsManager = new SettingsManager(view.plugin, config, settings);
@@ -155,7 +158,7 @@ export class DBFolderSettingTab extends PluginSettingTab {
   plugin: DBFolderPlugin;
   settingsManager: SettingsManager;
   constructor(plugin: DBFolderPlugin, config: SettingsManagerConfig) {
-    super(plugin.app, plugin);
+    super(app, plugin);
     this.plugin = plugin;
     this.settingsManager = new SettingsManager(plugin, config, plugin.settings);
   }

src/cdm/SettingsModel.ts

@@ -23,6 +23,7 @@ export type AtomicFilter = {
  */
 export interface GlobalSettings {
     enable_debug_mode: boolean;
+    enable_ribbon_icon: boolean;
     logger_level_info: string;
     media_settings: MediaSettings;
     enable_show_state: boolean;

src/helpers/Constants.ts

@@ -339,6 +339,7 @@ export const DEFAULT_SETTINGS: DatabaseSettings = {
     enable_debug_mode: false,
     enable_show_state: false,
     enable_row_shadow: true,
+    enable_ribbon_icon: true,
     logger_level_info: 'error',
     csv_file_header_key: 'File',
     media_settings: {

src/main.ts

@@ -65,6 +65,9 @@ export default class DBFolderPlugin extends Plugin {
 	stateManagers: Map<TFile, StateManager> = new Map();
 
 	windowRegistry: Map<Window, WindowRegistry> = new Map();
+
+	ribbonIcon: HTMLElement;
+
 	async onload(): Promise<void> {
 		await this.load_settings();
 		addIcon(DB_ICONS.NAME, DB_ICONS.ICON);
@@ -402,7 +405,13 @@ export default class DBFolderPlugin extends Plugin {
 			callback: () => new DatabaseHelperCreationModal(this.settings.local_settings).open(),
 		});
 
-		this.addRibbonIcon(DB_ICONS.NAME, t("ribbon_icon_title"), async (e) => {
+		if (this.settings.global_settings.enable_ribbon_icon) {
+			this.showRibbonIcon();
+		}
+	}
+
+	showRibbonIcon() {
+		this.ribbonIcon = this.addRibbonIcon(DB_ICONS.NAME, t("ribbon_icon_title"), async (e) => {
 			new DatabaseHelperCreationModal(this.settings.local_settings).open()
 		});
 	}

src/settings/HelpersSection.ts

@@ -0,0 +1,23 @@
+import { add_setting_header } from 'settings/SettingsComponents';
+import { SettingHandlerResponse } from 'settings/handlers/AbstractSettingHandler';
+import { AbstractChain } from 'patterns/AbstractFactoryChain';
+import { AbstractHandler } from 'patterns/AbstractHandler';
+import { RibbonIconToggleHandler } from 'settings/handlers/helpersCommands/RibbonIconToggleHandler';
+
+class HelpersSection extends AbstractChain<SettingHandlerResponse> {
+    protected customHandle(settingHandlerResponse: SettingHandlerResponse): SettingHandlerResponse {
+        const automation_section = settingHandlerResponse.containerEl.createDiv("configuration-section-container-automations");
+        // title of the section
+        add_setting_header(automation_section, "Helpers/Commands Section", 'h3');
+        settingHandlerResponse.containerEl = automation_section;
+        return settingHandlerResponse;
+    }
+    protected getHandlers(): AbstractHandler<SettingHandlerResponse>[] {
+        return [
+            new RibbonIconToggleHandler()
+        ];
+    }
+}
+
+const helpers_settings_section = new HelpersSection();
+export default helpers_settings_section;

src/settings/handlers/helpersCommands/RibbonIconToggleHandler.ts

@@ -0,0 +1,39 @@
+import { add_toggle } from "settings/SettingsComponents";
+import { AbstractSettingsHandler, SettingHandlerResponse } from "settings/handlers/AbstractSettingHandler";
+export class RibbonIconToggleHandler extends AbstractSettingsHandler {
+    settingTitle: string = 'Show/Hide Ribbon Icon';
+    handle(settingHandlerResponse: SettingHandlerResponse): SettingHandlerResponse {
+        const { settingsManager, containerEl, local } = settingHandlerResponse;
+        // pass if modal opened from local settings
+        if (!local) {
+            const ribbon_toggle_promise = async (value: boolean): Promise<void> => {
+                // set debug mode
+                const updated_global_settings = settingsManager.plugin.settings.global_settings;
+                updated_global_settings.enable_ribbon_icon = value;
+
+                if (updated_global_settings.enable_ribbon_icon) {
+                    settingsManager.plugin.showRibbonIcon();
+                } else {
+                    settingsManager.plugin.ribbonIcon.remove();
+                }
+
+
+                // update settings
+                await settingsManager.plugin.updateSettings({
+                    global_settings: updated_global_settings
+                });
+            }
+
+
+            add_toggle(
+                containerEl,
+                this.settingTitle,
+                "This will show/hide the ribbon icon from bar",
+                settingsManager.plugin.settings.global_settings.enable_ribbon_icon,
+                ribbon_toggle_promise
+            );
+        }
+
+        return this.goNext(settingHandlerResponse);
+    }
+}