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

chore: set defaults to disabled, make window-management modifications opt-in

Browse Source
This commit is contained in:
dragonwocky 2023-04-09 22:25:09 +10:00
parent 74784eb6df
commit d34a8edf42
Signed by: dragonwocky
GPG Key ID: 7998D08F7D7BD7A8
2 changed files with 9 additions and 9 deletions

16
README.md
View File

@ -6,14 +6,14 @@ can be minimised to and a global hotkey to toggle visibility of the app's window
## Configuration ## Configuration
| Option | Description | Default | | Option | Description | Default |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| Launch on startup | Open Obsidian automatically whenever you log into your computer. | Enabled | | 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. | 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. | 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 (Otherwise the window would disappear as soon as the plugin is installed and 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 |
| 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.) | | 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 | | 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 | | Toggle window focus hotkey | Format: [Electron accelerator](https://www.electronjs.org/docs/latest/api/accelerator) | CmdOrCtrl+Shift+Tab |
## Installation ## Installation

2
main.js
View File

@ -169,7 +169,7 @@ const OPTIONS = [
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 all Linux-based OSes.
`, `,
type: "toggle", type: "toggle",
default: true, default: false,
onChange: setHideTaskbarIcon, onChange: setHideTaskbarIcon,
}, },
{ {