dragonwocky/obsidian-tray
1
0
Fork 0
mirror of https://github.com/dragonwocky/obsidian-tray.git synced 2025-04-04 03:59:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: hide from taskbar option #11

Browse Source
This commit is contained in:
dragonwocky 2023-04-09 22:19:28 +10:00
parent b366512321
commit 74784eb6df
Signed by: dragonwocky
GPG Key ID: 7998D08F7D7BD7A8
2 changed files with 43 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -7,9 +7,11 @@ can be minimised to and a global hotkey to toggle visibility of the app's window
## Configuration
| Option | Description | Default |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| Launch on startup | Open Obsidian automatically whenever you log into your computer. | Enabled |
| 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. If both this and "Launch on startup" are enabled, windows will be hidden automatically whenever the app is initialised. | Disabled (Otherwise the window would disappear as soon as the plugin is installed and enabled.) |
| 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. | Enabled |
| 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 (Otherwise the window would disappear as soon as the plugin is installed and enabled.) |
| Hide taskbar icon | Hides the window's icon from from the dock/taskbar. This may not work on all Linux-based OSes. | Disabled (Otherwise the window would disappear as soon as the plugin is installed and enabled.) |
| 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 | Format: [Electron accelerator](https://www.electronjs.org/docs/latest/api/accelerator) | CmdOrCtrl+Shift+Tab |

47
main.js
View File

@ -5,8 +5,15 @@
let tray;
const obsidian = require("obsidian"),
{ app, BrowserWindow, globalShortcut, Tray, Menu, nativeImage } =
require("electron").remote;
{
app,
BrowserWindow,
getCurrentWindow,
globalShortcut,
Tray,
Menu,
nativeImage,
} = require("electron").remote;
const showWindows = () => {
console.log("obsidian-tray: showing windows");
@ -54,10 +61,15 @@ const onWindowClose = (event) => {
closeBtn.removeEventListener("click", onWindowClose, true);
};
const setLaunchOnStartup = (plugin) => {
const setHideTaskbarIcon = (plugin) => {
const win = getCurrentWindow();
win.setSkipTaskbar(plugin.settings.hideTaskbarIcon);
},
setLaunchOnStartup = (plugin) => {
const { launchOnStartup, runInBackground, hideOnLaunch } = plugin.settings;
app.setLoginItemSettings({
openAtLogin: plugin.settings.launchOnStartup,
openAsHidden: plugin.settings.runInBackground,
openAtLogin: launchOnStartup,
openAsHidden: runInBackground && hideOnLaunch,
});
},
relaunchObsidian = () => {
@ -124,7 +136,7 @@ const OPTIONS = [
desc: "Open Obsidian automatically whenever you log into your computer.",
type: "toggle",
default: false,
onChange: (plugin) => setLaunchOnStartup(plugin),
onChange: setLaunchOnStartup,
},
{
key: "hideOnLaunch",
@ -139,7 +151,7 @@ const OPTIONS = [
{
key: "runInBackground",
desc: `
Hide the app and continue to run it in the background instead of quitting
Hides the app and continues to run it in the background instead of quitting
it when pressing the window close button or toggle focus hotkey.
`,
type: "toggle",
@ -150,10 +162,20 @@ const OPTIONS = [
if (!runInBackground) 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.
`,
type: "toggle",
default: true,
onChange: setHideTaskbarIcon,
},
{
key: "createTrayIcon",
desc: `
Add an icon to your system tray/menubar to bring hidden Obsidian windows
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>
@ -171,8 +193,8 @@ const OPTIONS = [
`,
type: "text",
default: "CmdOrCtrl+Shift+Tab",
onBeforeChange: (plugin) => unregisterHotkey(plugin),
onChange: (plugin) => registerHotkey(plugin),
onBeforeChange: unregisterHotkey,
onChange: registerHotkey,
},
];
@ -199,10 +221,10 @@ class SettingsTab extends obsidian.PluginSettingTab {
const name = keyToLabel(opt.key),
desc = htmlToFragment(opt.desc),
onChange = async (value) => {
await opt.onBeforeChange?.(this.plugin, value);
await opt.onBeforeChange?.(this.plugin);
this.plugin.settings[opt.key] = value;
await this.plugin.saveSettings();
await opt.onChange?.(this.plugin, value);
await opt.onChange?.(this.plugin);
};
const setting = new obsidian.Setting(this.containerEl)
@ -235,6 +257,7 @@ class TrayPlugin extends obsidian.Plugin {
const { settings } = this;
registerHotkey(this);
setHideTaskbarIcon(this);
setLaunchOnStartup(this);
if (settings.createTrayIcon) createTrayIcon(this);
if (settings.runInBackground) interceptWindowClose();