From b8834b1286eea2c97d249b58f6469a4f18e95a4d Mon Sep 17 00:00:00 2001 From: dragonwocky Date: Tue, 11 Apr 2023 16:21:26 +1000 Subject: [PATCH] feat: make tray icon tooltip configurable --- README.md | 19 ++++++++++--------- main.js | 41 +++++++++++++++++++++++++++++------------ 2 files changed, 39 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index c20d422..053abc2 100644 --- a/README.md +++ b/README.md @@ -8,15 +8,16 @@ toggle app window visibility and can create quick notes from anywhere in your op ### 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 | -| Tray icon image | Set the image used by the tray/menubar icon. Recommended size: 16x16 _Changing this option requires a restart to take effect._ | ![](obsidian.png) | -| 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) | CmdOrCtrl+Shift+Tab | The `Relaunch Obsidian` action can be triggered from the tray/menubar context menu, or with the in-app command palette (search for "Tray: Relaunch Obsidian"). Hotkeys can be assigned to the command via diff --git a/main.js b/main.js index fcc7c60..26dc67e 100644 --- a/main.js +++ b/main.js @@ -125,6 +125,9 @@ const addQuickNote = () => { plugin.app.fileManager.createAndOpenMarkdownFile(name); showWindows(); }, + replaceVaultName = (str) => { + return str.replace(/{{vault}}/g, plugin.app.vault.getName()); + }, destroyTray = () => { tray?.destroy(); tray = undefined; @@ -161,7 +164,7 @@ const addQuickNote = () => { ]); tray = new Tray(obsidianIcon); tray.setContextMenu(contextMenu); - tray.setToolTip(plugin.app.vault.getName() ?? "Obsidian"); + tray.setToolTip(replaceVaultName(plugin.settings.trayIconTooltip)); tray.on("click", () => toggleWindows(false)); }; @@ -222,7 +225,7 @@ const OPTIONS = [ 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, @@ -249,6 +252,18 @@ const OPTIONS = [ default: OBSIDIAN_BASE64_ICON, onChange: createTrayIcon, }, + { + key: "trayIconTooltip", + desc: ` + Set a title to identify the tray/menubar icon by. The + {{vault}} placeholder will be replaced by the vault name. +
Preview: + `, + type: "text", + default: "{{vault}} | Obsidian", + postprocessor: replaceVaultName, + onChange: createTrayIcon, + }, { key: "toggleWindowFocusHotkey", desc: ACCELERATOR_FORMAT, @@ -314,18 +329,14 @@ class SettingsTab extends obsidian.PluginSettingTab { await opt.onChange?.(); }; + const value = plugin.settings[opt.key] ?? opt.default ?? ""; if (opt.type === "toggle") { setting.addToggle((toggle) => { - toggle - .setValue(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) { - const src = plugin.settings[opt.key] ?? opt.default; - previewImg.src = src; - } + if (previewImg) previewImg.src = value; const fileUpload = setting.descEl.createEl("input"); fileUpload.style.visibility = "hidden"; fileUpload.type = "file"; @@ -348,15 +359,21 @@ class SettingsTab extends obsidian.PluginSettingTab { moment .setPlaceholder(opt.placeholder) .setDefaultFormat(opt.default ?? "") - .setValue(plugin.settings[opt.key] ?? opt.default ?? "") + .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(plugin.settings[opt.key] ?? opt.default ?? "") - .onChange(onChange); + .setValue(value) + .onChange((value) => [onChange(value), updatePreview(value)]); }); } }