merge #51: expose windowing to other plugins

Expose Windowing APIs to Other Plugins

README.md

@@ -1,33 +1,39 @@
 <img alt="" src="tray.png" align="right"  height="128px">
 
 **Tray** is an [Obsidian](https://obsidian.md/) plugin that can be used to launch the app
-on system startup and run it in the background, adding global hotkeys and a tray menu that
-toggle app window visibility and can create quick notes from anywhere in your operating system.
+on system startup and run it in the background, adding global hotkeys and a tray menu to
+toggle window visibility and create quick notes from anywhere in your operating system.
 
 ## Configuration
 
 ### Window management
 
-| Option                     | Description                                                                                                                                                                                                                        | Default             |
-| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
-| Launch on startup          | Open Obsidian automatically whenever you log into your computer.                                                                                                                                                                   | Disabled            |
-| Hide on launch             | Minimises Obsidian automatically whenever the app is launched. If the "Run in background" option is enabled, windows will be hidden to the system tray/menubar instead of minimised to the taskbar/dock.                           | Disabled            |
-| Run in background          | Hide the app and continue to run it in the background instead of quitting it when pressing the window close button or toggle focus hotkey.                                                                                         | Disabled            |
-| Hide taskbar icon          | Hides the window's icon from from the dock/taskbar. This may not work on all Linux-based OSes.                                                                                                                                     | Disabled            |
-| Create tray icon           | Add an icon to your system tray/menubar to bring hidden Obsidian windows back into focus on click or force a full quit/relaunch of the app through the right-click menu. _Changing this option requires a restart to take effect._ | Enabled             |
-| Toggle window focus hotkey | This hotkey is registered globally and will be detected even if Obsidian does not have keyboard focus. Format: [Electron accelerator](https://www.electronjs.org/docs/latest/api/accelerator)                                      | CmdOrCtrl+Shift+Tab |
+| Option                     | Description                                                                                                                                                                                              | Default                        |
+| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
+| Launch on startup          | Open Obsidian automatically whenever you log into your computer.                                                                                                                                         | Disabled                       |
+| Hide on launch             | Minimises Obsidian automatically whenever the app is launched. If the "Run in background" option is enabled, windows will be hidden to the system tray/menubar instead of minimised to the taskbar/dock. | Disabled                       |
+| Run in background          | Hide the app and continue to run it in the background instead of quitting it when pressing the window close button or toggle focus hotkey.                                                               | Disabled                       |
+| Hide taskbar icon          | Hides the window's icon from from the dock/taskbar. This may not work on Linux-based OSes.                                                                                                               | Disabled                       |
+| Create tray icon           | Add an icon to your system tray/menubar to bring hidden Obsidian windows back into focus on click or force a full quit/relaunch of the app through the right-click menu.                                 | Enabled                        |
+| Tray icon image            | Set the image used by the tray/menubar icon. Recommended size: 16x16                                                                                                                                     | ![](obsidian.png)              |
+| Tray icon tooltip          | Set a title to identify the tray/menubar icon by. The `{{vault}}` placeholder will be replaced by the vault name.                                                                                        | `{{vault}} \| Obsidian`        |
+| Toggle window focus hotkey | This hotkey is registered globally and will be detected even if Obsidian does not have keyboard focus. Format: [Electron accelerator](https://www.electronjs.org/docs/latest/api/accelerator)            | <kbd>CmdOrCtrl+Shift+Tab</kbd> |
+
+The `Relaunch Obsidian` and `Close Vault` actions can be triggered from the tray/menubar context menu,
+or with the in-app command palette (search for "Tray: Relaunch Obsidian" or "Tray: Close Vault").
+Hotkeys can be assigned to the commands via Obsidian's built-in hotkey manager.
 
 ### Quick notes
 
-| Option                 | Description                                                                                                                                                                                   | Default           |
-| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
-| Quick note location    | New quick notes will be placed in this folder.                                                                                                                                                |                   |
-| Quick note date format | New quick notes will use a filename of this pattern. Format: [Moment.js format string](https://momentjs.com/docs/#/displaying/format/)                                                        | YYYY-MM-DD        |
-| Quick note hotkey      | This hotkey is registered globally and will be detected even if Obsidian does not have keyboard focus. Format: [Electron accelerator](https://www.electronjs.org/docs/latest/api/accelerator) | CmdOrCtrl+Shift+Q |
+| Option                 | Description                                                                                                                                                                                   | Default                      |
+| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
+| Quick note location    | New quick notes will be placed in this folder.                                                                                                                                                |                              |
+| Quick note date format | New quick notes will use a filename of this pattern. Format: [Moment.js format string](https://momentjs.com/docs/#/displaying/format/)                                                        | `YYYY-MM-DD`                 |
+| Quick note hotkey      | This hotkey is registered globally and will be detected even if Obsidian does not have keyboard focus. Format: [Electron accelerator](https://www.electronjs.org/docs/latest/api/accelerator) | <kbd>CmdOrCtrl+Shift+Q</kbd> |
 
 ## Installation
 
-### Obsidian Marketplace (Coming Soon)
+### Obsidian Marketplace
 
 1. In Obsidian, navigate to **Settings** → **Community plugins**.
 2. Press the **Browse** button beside the **Community plugins** option.
@@ -55,3 +61,7 @@ This plugin is provided as-is and is designed for personal use. It has not
 been tested on every platform and may not work as expected with all future updates.
 If you notice something is not working as intended, please open a bug report or
 pull request so it can be fixed.
+
+The Obsidian logo is distributed with this plugin as the default image for the system
+tray/menubar icon, intended to be used within Obsidian. This logo remains the property
+of the Obsidian project and is not under the same license as the plugin's source code.

main.js

@@ -1,160 +1,249 @@
-/* obsidian-tray v0.2.0
-   by @dragonwocky */
+/**
+ * obsidian-tray v0.3.5
+ * (c) 2023 dragonwocky <thedragonring.bod@gmail.com> (https://dragonwocky.me/)
+ * (https://github.com/dragonwocky/obsidian-tray/) under the MIT license
+ */
 
 "use strict";
 
-const DEFAULT_DATE_FORMAT = "YYYY-MM-DD";
+const LOG_PREFIX = "obsidian-tray",
+  LOG_LOADING = "loading",
+  LOG_CLEANUP = "cleaning up",
+  LOG_SHOWING_WINDOWS = "showing windows",
+  LOG_HIDING_WINDOWS = "hiding windows",
+  LOG_WINDOW_CLOSE = "intercepting window close",
+  LOG_TRAY_ICON = "creating tray icon",
+  LOG_REGISTER_HOTKEY = "registering hotkey",
+  LOG_UNREGISTER_HOTKEY = "unregistering hotkey",
+  ACTION_QUICK_NOTE = "Quick Note",
+  ACTION_SHOW = "Show Vault",
+  ACTION_HIDE = "Hide Vault",
+  ACTION_RELAUNCH = "Relaunch Obsidian",
+  ACTION_CLOSE = "Close Vault",
+  DEFAULT_DATE_FORMAT = "YYYY-MM-DD",
+  ACCELERATOR_FORMAT = `
+    This hotkey is registered globally and will be detected even if Obsidian does
+    not have keyboard focus. Format:
+    <a href="https://www.electronjs.org/docs/latest/api/accelerator" target="_blank" rel="noopener">
+    Electron accelerator</a>
+  `,
+  MOMENT_FORMAT = `
+    Format:
+    <a href="https://momentjs.com/docs/#/displaying/format/" target="_blank" rel="noopener">
+    Moment.js format string</a>
+  `,
+  // 16x16 base64 obsidian icon: generated from obsidian.asar/icon.png
+  OBSIDIAN_BASE64_ICON = `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAHZSURBVDhPlZKxTxRBFMa/XZcF7nIG7mjxjoRCwomJxgsFdhaASqzQxFDzB1AQKgstLGxIiBQGJBpiCCGx8h+wgYaGgAWNd0dyHofeEYVwt/PmOTMZV9aDIL/s5pvZvPfN9yaL/+HR3eXcypta0m4juFbP5GHuXc9IbunDFc9db/G81/ZzhDMN7g8td47mll4R5BfHwZN4LOaA+fHa259PbUmIYzWkt3e2NZNo3/V9v1vvU6kkstk+tLW3ItUVr/m+c3N8MlkwxYqmBFcbwUQQCNOcyVzDwEAWjuPi5DhAMV/tKOYPX5hCyz8Gz1zX5SmWjBvZfmTSaRBJkGAIoxJHv+pVW2yIGNxOJ8bUVNcFEWLxuG1ia6JercTbttwQTeDwPS0kCMXiXtgk/jQrFUw7ptYSMWApF40yo/ytjHq98fdk3ayVE+cn2CxMb6ruz9qAJKFUKoWza1VJSi/n0+ffgYHdWW2gHuxXymg0gjCB0sjpmiaDnkL3RzDyzLqBUKns2ztQqUR0fk2TwSrGSf1eczqF5vsPZRCQSSAFLk6gqctgQRkc6TWRQLV2YMYQki9OoNkqzFQ9r+WOGuW5CrJbOzyAlPKr6MSGLbkcDwbf35oY/jRkt6cAfgNwowruAMz9AgAAAABJRU5ErkJggg==`,
+  log = (message) => console.log(`${LOG_PREFIX}: ${message}`);
 
-let tray;
+let tray, plugin;
 const obsidian = require("obsidian"),
-  {
-    app,
-    BrowserWindow,
-    getCurrentWindow,
-    globalShortcut,
-    Tray,
-    Menu,
-    nativeImage,
-  } = require("electron").remote;
+  { app, Tray, Menu } = require("electron").remote,
+  { nativeImage, BrowserWindow } = require("electron").remote,
+  { getCurrentWindow, globalShortcut } = require("electron").remote;
 
-const showWindows = () => {
-    console.log("obsidian-tray: showing windows");
-    const windows = BrowserWindow.getAllWindows(),
-      currentWindow = windows.find((win) => win.isFocused()) || windows[0];
-    windows.forEach((win) => win.show());
-    currentWindow.focus();
+const vaultWindows = new Set(),
+  maximizedWindows = new Set(),
+  getWindows = () => [...vaultWindows],
+  observeWindows = () => {
+    const onWindowCreation = (win) => {
+      vaultWindows.add(win);
+      win.setSkipTaskbar(plugin.settings.hideTaskbarIcon);
+      win.on("close", () => {
+        if (win !== getCurrentWindow()) vaultWindows.delete(win);
+      });
+      // preserve maximised windows after minimisation
+      if (win.isMaximized()) maximizedWindows.add(win);
+      win.on("maximize", () => maximizedWindows.add(win));
+      win.on("unmaximize", () => maximizedWindows.delete(win));
+    };
+    onWindowCreation(getCurrentWindow());
+    getCurrentWindow().webContents.on("did-create-window", onWindowCreation);
+    if (process.platform === "darwin") {
+      // on macos, the "hide taskbar icon" option is implemented
+      // via app.dock.hide(): thus, the app as a whole will be
+      // hidden from the dock, including windows from other vaults.
+      // when a vault is closed via the "close vault" button,
+      // the cleanup process will call app.dock.show() to restore
+      // access to any other open vaults w/out the tray enabled
+      // => thus, this listener is required to re-hide the dock
+      // if switching to another vault with the option enabled
+      getCurrentWindow().on("focus", () => {
+        if (plugin.settings.hideTaskbarIcon) hideTaskbarIcons();
+      });
+    }
   },
-  hideWindows = (runInBackground) => {
-    console.log("obsidian-tray: hiding windows");
-    const windows = BrowserWindow.getAllWindows();
-    windows.forEach((win) => [
+  showWindows = () => {
+    log(LOG_SHOWING_WINDOWS);
+    getWindows().forEach((win) => {
+      if (maximizedWindows.has(win)) {
+        win.maximize();
+        win.focus();
+      } else win.show();
+    });
+  },
+  hideWindows = () => {
+    log(LOG_HIDING_WINDOWS);
+    getWindows().forEach((win) => [
       win.isFocused() && win.blur(),
-      runInBackground ? win.hide() : win.minimize(),
+      plugin.settings.runInBackground ? win.hide() : win.minimize(),
     ]);
   },
-  toggleWindows = (runInBackground, checkForFocus = true) => {
-    const windows = BrowserWindow.getAllWindows(),
-      openWindows = windows.some((win) => {
-        return (!checkForFocus || win.isFocused()) && win.isVisible();
-      });
-    if (openWindows) {
-      hideWindows(runInBackground);
-    } else showWindows();
+  toggleWindows = (checkForFocus = true) => {
+    const openWindows = getWindows().some((win) => {
+      return (!checkForFocus || win.isFocused()) && win.isVisible();
+    });
+    if (openWindows) hideWindows();
+    else showWindows();
   };
 
-// let _onbeforeunload;
-const onWindowClose = (event) => {
+const onWindowClose = (event) => event.preventDefault(),
+  onWindowUnload = (event) => {
+    log(LOG_WINDOW_CLOSE);
+    getCurrentWindow().hide();
     event.stopImmediatePropagation();
-    // event.preventDefault();
-    console.log("obsidian-tray: intercepting window close");
-    const windows = BrowserWindow.getAllWindows(),
-      currentWindow = windows.find((win) => win.isFocused());
-    currentWindow.hide();
+    // setting return value manually is more reliable than
+    // via `return false` according to electron
+    event.returnValue = false;
   },
   interceptWindowClose = () => {
-    // _onbeforeunload = window.onbeforeunload;
-    // window.onbeforeunload = onWindowClose;
-    const closeBtn = document.querySelector(".mod-close");
-    closeBtn.addEventListener("click", onWindowClose, true);
+    // intercept in renderer
+    window.addEventListener("beforeunload", onWindowUnload, true);
+    // intercept in main: is asynchronously executed when registered
+    // from renderer, so won't prevent close by itself, but counteracts
+    // the 3-second delayed window force close in obsidian.asar/main.js
+    getCurrentWindow().on("close", onWindowClose);
   },
-  cleanupWindowClose = () => {
-    // window.onbeforeunload = _onbeforeunload;
-    const closeBtn = document.querySelector(".mod-close");
-    closeBtn.removeEventListener("click", onWindowClose, true);
+  allowWindowClose = () => {
+    getCurrentWindow().removeListener("close", onWindowClose);
+    window.removeEventListener("beforeunload", onWindowUnload, true);
   };
 
-const addQuickNote = (plugin) => {
-    const { quickNoteLocation, quickNoteDateFormat } = plugin.settings,
-      format = quickNoteDateFormat || DEFAULT_DATE_FORMAT,
-      date = obsidian.moment().format(format),
-      name = obsidian
-        .normalizePath(`${quickNoteLocation ?? ""}/${date}`)
-        .replace(/\*|"|\\|<|>|:|\||\?/g, "-");
-    plugin.app.fileManager.createAndOpenMarkdownFile(name);
-    showWindows();
+const hideTaskbarIcons = () => {
+    getWindows().forEach((win) => win.setSkipTaskbar(true));
+    if (process.platform === "darwin") app.dock.hide();
   },
-  setHideTaskbarIcon = (plugin) => {
-    const win = getCurrentWindow();
-    win.setSkipTaskbar(plugin.settings.hideTaskbarIcon);
+  showTaskbarIcons = () => {
+    getWindows().forEach((win) => win.setSkipTaskbar(false));
+    if (process.platform === "darwin") app.dock.show();
   },
-  setLaunchOnStartup = (plugin) => {
+  setLaunchOnStartup = () => {
     const { launchOnStartup, runInBackground, hideOnLaunch } = plugin.settings;
     app.setLoginItemSettings({
       openAtLogin: launchOnStartup,
       openAsHidden: runInBackground && hideOnLaunch,
     });
-  },
-  relaunchObsidian = () => {
-    app.relaunch();
-    app.exit(0);
   };
 
-const createTrayIcon = (plugin) => {
-  console.log("obsidian-tray: creating tray icon");
-  const obsidianIcon = nativeImage.createFromDataURL(
-      // 16x16 base64 obsidian icon: generated from obsidian.asar/icon.png
-      `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAHZSURBVDhPlZKxTxRBFMa/XZcF7nIG7mjxjoRCwomJxgsFdhaASqzQxFDzB1AQKgstLGxIiBQGJBpiCCGx8h+wgYaGgAWNd0dyHofeEYVwt/PmOTMZV9aDIL/s5pvZvPfN9yaL/+HR3eXcypta0m4juFbP5GHuXc9IbunDFc9db/G81/ZzhDMN7g8td47mll4R5BfHwZN4LOaA+fHa259PbUmIYzWkt3e2NZNo3/V9v1vvU6kkstk+tLW3ItUVr/m+c3N8MlkwxYqmBFcbwUQQCNOcyVzDwEAWjuPi5DhAMV/tKOYPX5hCyz8Gz1zX5SmWjBvZfmTSaRBJkGAIoxJHv+pVW2yIGNxOJ8bUVNcFEWLxuG1ia6JercTbttwQTeDwPS0kCMXiXtgk/jQrFUw7ptYSMWApF40yo/ytjHq98fdk3ayVE+cn2CxMb6ruz9qAJKFUKoWza1VJSi/n0+ffgYHdWW2gHuxXymg0gjCB0sjpmiaDnkL3RzDyzLqBUKns2ztQqUR0fk2TwSrGSf1eczqF5vsPZRCQSSAFLk6gqctgQRkc6TWRQLV2YMYQki9OoNkqzFQ9r+WOGuW5CrJbOzyAlPKr6MSGLbkcDwbf35oY/jRkt6cAfgNwowruAMz9AgAAAABJRU5ErkJggg==`
-    ),
-    contextMenu = Menu.buildFromTemplate([
-      {
-        type: "normal",
-        label: "Add Quick Note",
-        accelerator: plugin.settings.quickNoteHotkey,
-        click: () => addQuickNote(plugin),
-      },
-      {
-        type: "normal",
-        label: "Open Obsidian",
-        accelerator: plugin.settings.toggleWindowFocusHotkey,
-        click: showWindows,
-      },
-      {
-        type: "normal",
-        label: "Hide Obsidian",
-        accelerator: plugin.settings.toggleWindowFocusHotkey,
-        click: hideWindows,
-      },
-      { type: "separator" },
-      {
-        label: "Relaunch Obsidian",
-        click: relaunchObsidian,
-      },
-      {
-        label: "Quit Obsidian",
-        role: "quit",
-      },
-    ]);
-  tray = new Tray(obsidianIcon);
-  tray.setContextMenu(contextMenu);
-  tray.setToolTip("Obsidian");
-  tray.on("click", () => toggleWindows(plugin.settings.runInBackground, false));
-};
+const cleanup = () => {
+    log(LOG_CLEANUP);
+    unregisterHotkeys();
+    showTaskbarIcons();
+    allowWindowClose();
+    destroyTray();
+  },
+  relaunchApp = () => {
+    app.relaunch();
+    app.exit(0);
+  },
+  closeVault = () => {
+    log(LOG_CLEANUP);
+    cleanup();
+    const vaultWindows = getWindows(),
+      obsidianWindows = BrowserWindow.getAllWindows();
+    if (obsidianWindows.length === vaultWindows.length) {
+      // quit app directly if only remaining windows are in the
+      // current vault - necessary for successful quit on macos
+      app.quit();
+    } else vaultWindows.forEach((win) => win.destroy());
+  };
 
-const registerHotkeys = (plugin) => {
-    console.log("obsidian-tray: registering hotkey");
+const addQuickNote = () => {
+    const { quickNoteLocation, quickNoteDateFormat } = plugin.settings,
+      pattern = quickNoteDateFormat || DEFAULT_DATE_FORMAT,
+      date = obsidian.moment().format(pattern),
+      name = obsidian
+        .normalizePath(`${quickNoteLocation ?? ""}/${date}`)
+        .replace(/\*|"|\\|<|>|:|\||\?/g, "-"),
+      // manually create and open file instead of depending
+      // on createAndOpenMarkdownFile to force file creation
+      // relative to the root instead of the active file
+      // (in case user has default location for new notes
+      // set to "same folder as current file")
+      leaf = plugin.app.workspace.getLeaf(),
+      root = plugin.app.fileManager.getNewFileParent(""),
+      openMode = { active: true, state: { mode: "source" } };
+    plugin.app.fileManager
+      .createNewMarkdownFile(root, name)
+      .then((file) => leaf.openFile(file, openMode));
+    showWindows();
+  },
+  replaceVaultName = (str) => {
+    return str.replace(/{{vault}}/g, plugin.app.vault.getName());
+  },
+  destroyTray = () => {
+    tray?.destroy();
+    tray = undefined;
+  },
+  createTrayIcon = () => {
+    destroyTray();
+    if (!plugin.settings.createTrayIcon) return;
+    log(LOG_TRAY_ICON);
+    const obsidianIcon = nativeImage.createFromDataURL(
+        plugin.settings.trayIconImage ?? OBSIDIAN_BASE64_ICON
+      ),
+      contextMenu = Menu.buildFromTemplate([
+        {
+          type: "normal",
+          label: ACTION_QUICK_NOTE,
+          accelerator: plugin.settings.quickNoteHotkey,
+          click: addQuickNote,
+        },
+        {
+          type: "normal",
+          label: ACTION_SHOW,
+          accelerator: plugin.settings.toggleWindowFocusHotkey,
+          click: showWindows,
+        },
+        {
+          type: "normal",
+          label: ACTION_HIDE,
+          accelerator: plugin.settings.toggleWindowFocusHotkey,
+          click: hideWindows,
+        },
+        { type: "separator" },
+        { label: ACTION_RELAUNCH, click: relaunchApp },
+        { label: ACTION_CLOSE, click: closeVault },
+      ]);
+    tray = new Tray(obsidianIcon);
+    tray.setContextMenu(contextMenu);
+    tray.setToolTip(replaceVaultName(plugin.settings.trayIconTooltip));
+    tray.on("click", () => {
+      if (process.platform === "darwin") {
+        // macos does not register separate left/right click actions
+        // for menu items, icon should open menu w/out causing toggle
+        tray.popUpContextMenu();
+      } else toggleWindows(false);
+    });
+  };
+
+const registerHotkeys = () => {
+    log(LOG_REGISTER_HOTKEY);
     try {
-      const toggleAccelerator = plugin.settings.toggleWindowFocusHotkey,
-        quicknoteAccelerator = plugin.settings.quickNoteHotkey;
-      if (toggleAccelerator) {
-        globalShortcut.register(toggleAccelerator, () => {
-          const runInBackground = plugin.settings.runInBackground;
-          toggleWindows(runInBackground);
-        });
+      const { toggleWindowFocusHotkey, quickNoteHotkey } = plugin.settings;
+      if (toggleWindowFocusHotkey) {
+        globalShortcut.register(toggleWindowFocusHotkey, toggleWindows);
       }
-      if (quicknoteAccelerator) {
-        globalShortcut.register(quicknoteAccelerator, () => {
-          addQuickNote(plugin);
-        });
+      if (quickNoteHotkey) {
+        globalShortcut.register(quickNoteHotkey, addQuickNote);
       }
     } catch {}
   },
-  unregisterHotkeys = (plugin) => {
-    console.log("obsidian-tray: unregistering hotkey");
+  unregisterHotkeys = () => {
+    log(LOG_UNREGISTER_HOTKEY);
     try {
-      const toggle = plugin.settings.toggleWindowFocusHotkey,
-        quicknote = plugin.settings.quickNoteHotkey;
-      globalShortcut.unregister(toggle);
-      globalShortcut.unregister(quicknote);
+      globalShortcut.unregister(plugin.settings.toggleWindowFocusHotkey);
+      globalShortcut.unregister(plugin.settings.quickNoteHotkey);
     } catch {}
   };
 
@@ -185,21 +274,24 @@ const OPTIONS = [
     `,
     type: "toggle",
     default: false,
-    onChange: (plugin) => {
-      setLaunchOnStartup(plugin);
-      const runInBackground = plugin.settings.runInBackground;
-      if (!runInBackground) showWindows();
+    onChange() {
+      setLaunchOnStartup();
+      if (plugin.settings.runInBackground) interceptWindowClose();
+      else [allowWindowClose(), showWindows()];
     },
   },
   {
     key: "hideTaskbarIcon",
     desc: `
       Hides the window's icon from from the dock/taskbar. Enabling the tray icon first
-      is recommended if using this option. This may not work on all Linux-based OSes.
+      is recommended if using this option. This may not work on Linux-based OSes.
     `,
     type: "toggle",
     default: false,
-    onChange: setHideTaskbarIcon,
+    onChange() {
+      if (plugin.settings.hideTaskbarIcon) hideTaskbarIcons();
+      else showTaskbarIcons();
+    },
   },
   {
     key: "createTrayIcon",
@@ -207,15 +299,40 @@ const OPTIONS = [
       Adds an icon to your system tray/menubar to bring hidden Obsidian windows
       back into focus on click or force a full quit/relaunch of the app through
       the right-click menu.
-      <br><span class="mod-warning">Changing this option requires a restart to take effect.</span>
     `,
     type: "toggle",
     default: true,
+    onChange: createTrayIcon,
+  },
+  {
+    key: "trayIconImage",
+    desc: `
+      Set the image used by the tray/menubar icon. Recommended size: 16x16
+      <br>Preview: <img data-preview style="height: 16px; vertical-align: bottom;">
+    `,
+    type: "image",
+    default: OBSIDIAN_BASE64_ICON,
+    onChange: createTrayIcon,
+  },
+  {
+    key: "trayIconTooltip",
+    desc: `
+      Set a title to identify the tray/menubar icon by. The
+      <code>{{vault}}</code> placeholder will be replaced by the vault name.
+      <br>Preview: <b class="u-pop" data-preview></b>
+    `,
+    type: "text",
+    default: "{{vault}} | Obsidian",
+    postprocessor: replaceVaultName,
+    onChange: createTrayIcon,
   },
   {
     key: "toggleWindowFocusHotkey",
+    desc: ACCELERATOR_FORMAT,
     type: "hotkey",
     default: "CmdOrCtrl+Shift+Tab",
+    onBeforeChange: unregisterHotkeys,
+    onChange: registerHotkeys,
   },
   "Quick notes",
   {
@@ -226,14 +343,20 @@ const OPTIONS = [
   },
   {
     key: "quickNoteDateFormat",
-    desc: "New quick notes will use a filename of this pattern.",
+    desc: `
+      New quick notes will use a filename of this pattern. ${MOMENT_FORMAT}
+      <br>Preview: <b class="u-pop" data-preview></b>
+    `,
     type: "moment",
     default: DEFAULT_DATE_FORMAT,
   },
   {
     key: "quickNoteHotkey",
+    desc: ACCELERATOR_FORMAT,
     type: "hotkey",
     default: "CmdOrCtrl+Shift+Q",
+    onBeforeChange: unregisterHotkeys,
+    onChange: registerHotkeys,
   },
 ];
 
@@ -249,23 +372,7 @@ const keyToLabel = (key) =>
       .createRange()
       .createContextualFragment((html ?? "").replace(/\s+/g, " "));
 
-const acceleratorFormat = `
-    This hotkey is registered globally and will be detected even if Obsidian does
-    not have keyboard focus. Format:
-    <a href="https://www.electronjs.org/docs/latest/api/accelerator" target="_blank" rel="noopener">
-    Electron accelerator</a>
-  `,
-  momentFormat = `
-    Format:
-    <a href="https://momentjs.com/docs/#/displaying/format/" target="_blank" rel="noopener">
-    Moment.js format string</a>
-    <br>Preview:
-  `;
 class SettingsTab extends obsidian.PluginSettingTab {
-  constructor(app, plugin) {
-    super(app, plugin);
-    this.plugin = plugin;
-  }
   display() {
     this.containerEl.empty();
     for (const opt of OPTIONS) {
@@ -274,51 +381,61 @@ class SettingsTab extends obsidian.PluginSettingTab {
         setting.setName(opt);
         setting.setHeading();
       } else {
-        if (opt.default) {
-          opt.placeholder ??= `Example: ${opt.default}`;
-        }
-        if (opt.type === "hotkey") {
-          opt.desc ??= "";
-          opt.desc += acceleratorFormat;
-          opt.onBeforeChange = unregisterHotkeys;
-          opt.onChange = registerHotkeys;
-        }
-        if (opt.type === "moment") {
-          opt.desc = `${opt.desc ? `${opt.desc}<br>` : ""}${momentFormat}`;
-        }
-
+        if (opt.default) opt.placeholder ??= `Example: ${opt.default}`;
         setting.setName(keyToLabel(opt.key));
         setting.setDesc(htmlToFragment(opt.desc));
         const onChange = async (value) => {
-          await opt.onBeforeChange?.(this.plugin);
-          this.plugin.settings[opt.key] = value;
-          await this.plugin.saveSettings();
-          await opt.onChange?.(this.plugin);
+          await opt.onBeforeChange?.();
+          plugin.settings[opt.key] = value;
+          await plugin.saveSettings();
+          await opt.onChange?.();
         };
 
+        const value = plugin.settings[opt.key] ?? opt.default ?? "";
         if (opt.type === "toggle") {
           setting.addToggle((toggle) => {
-            toggle
-              .setValue(this.plugin.settings[opt.key] ?? opt.default)
-              .onChange(onChange);
+            toggle.setValue(value).onChange(onChange);
+          });
+        } else if (opt.type === "image") {
+          const previewImg = setting.descEl.querySelector("img[data-preview");
+          if (previewImg) previewImg.src = value;
+          const fileUpload = setting.descEl.createEl("input");
+          fileUpload.style.visibility = "hidden";
+          fileUpload.type = "file";
+          fileUpload.onchange = (event) => {
+            const file = event.target.files[0],
+              reader = new FileReader();
+            reader.onloadend = () => {
+              onChange(reader.result);
+              if (previewImg) previewImg.src = reader.result;
+            };
+            reader.readAsDataURL(file);
+          };
+          setting.addButton((button) => {
+            button.setIcon("image").onClick(() => fileUpload.click());
           });
         } else if (opt.type === "moment") {
           setting.addMomentFormat((moment) => {
-            const sampleEl = setting.descEl.createEl("b");
-            sampleEl.className = "u-pop";
+            const previewEl = setting.descEl.querySelector("[data-preview]");
+            if (previewEl) moment.setSampleEl(previewEl);
             moment
               .setPlaceholder(opt.placeholder)
               .setDefaultFormat(opt.default ?? "")
-              .setValue(this.plugin.settings[opt.key] ?? opt.default ?? "")
-              .setSampleEl(sampleEl)
+              .setValue(value)
               .onChange(onChange);
           });
         } else {
+          const previewEl = setting.descEl.querySelector("[data-preview]"),
+            updatePreview = (value) => {
+              if (!previewEl) return;
+              previewEl.innerText = opt?.postprocessor(value) ?? value;
+            };
+          updatePreview(value);
           setting.addText((text) => {
             text
               .setPlaceholder(opt.placeholder)
-              .setValue(this.plugin.settings[opt.key] ?? opt.default ?? "")
-              .onChange(onChange);
+              .setValue(value)
+              .onChange((value) => [onChange(value), updatePreview(value)]);
           });
         }
       }
@@ -328,32 +445,45 @@ class SettingsTab extends obsidian.PluginSettingTab {
 
 class TrayPlugin extends obsidian.Plugin {
   async onload() {
-    console.log("obsidian-tray: loading");
+    log(LOG_LOADING);
     await this.loadSettings();
     this.addSettingTab(new SettingsTab(this.app, this));
     const { settings } = this;
 
-    registerHotkeys(this);
-    setHideTaskbarIcon(this);
-    setLaunchOnStartup(this);
-    if (settings.createTrayIcon) createTrayIcon(this);
+    plugin = this;
+    createTrayIcon();
+    registerHotkeys();
+    setLaunchOnStartup();
+    observeWindows();
     if (settings.runInBackground) interceptWindowClose();
+    if (settings.hideTaskbarIcon) hideTaskbarIcons();
     if (settings.hideOnLaunch) {
-      let _hidden;
-      this.registerEvent(
-        this.app.workspace.onLayoutReady(() => {
-          if (_hidden) return;
-          _hidden = true;
-          hideWindows(settings.runInBackground);
-        })
-      );
+      this.registerEvent(this.app.workspace.onLayoutReady(hideWindows));
     }
+
+    // add as command: can be called from command palette
+    // and can have non-global hotkey assigned via in-app menu
+    this.addCommand({
+      id: "relaunch-app",
+      name: ACTION_RELAUNCH,
+      callback: relaunchApp,
+    });
+    this.addCommand({
+      id: "close-vault",
+      name: ACTION_CLOSE,
+      callback: closeVault,
+    });
   }
   onunload() {
-    unregisterHotkeys(this);
-    cleanupWindowClose();
+    cleanup();
   }
 
+  getCurrentWindow = getCurrentWindow
+  getWindows = getWindows;
+  showWindows = showWindows;
+  hideWindows = hideWindows;
+  toggleWindows = toggleWindows;
+
   async loadSettings() {
     const DEFAULT_SETTINGS = OPTIONS.map((opt) => ({ [opt.key]: opt.default }));
     this.settings = Object.assign(...DEFAULT_SETTINGS, await this.loadData());

manifest.json

@@ -1,10 +1,10 @@
 {
-  "id": "obsidian-tray",
+  "id": "tray",
   "name": "Tray",
   "author": "dragonwocky",
   "authorUrl": "https://dragonwocky.me/",
-  "description": "Launch Obsidian on startup and run it in the background from the system tray.",
-  "version": "0.2.0",
+  "description": "Run Obsidian from the system tray for customisable window management & global quick notes",
+  "version": "0.3.5",
   "isDesktopOnly": true,
   "minAppVersion": "1.0.0"
 }