dragonwocky/obsidian-tray
1
0
Fork 0
mirror of https://github.com/dragonwocky/obsidian-tray.git synced 2025-11-17 14:38:08 +11:00
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: dragonwocky:main
Branches Tags
dragonwocky:main
dragonwocky:0.3.5
dragonwocky:0.3.4
dragonwocky:0.3.3
dragonwocky:0.3.2
dragonwocky:0.3.1
dragonwocky:0.3.0
dragonwocky:0.2.1
dragonwocky:0.2.0
dragonwocky:0.1.2
dragonwocky:0.1.1
..
compare: dragonwocky:0.3.4
Branches Tags
dragonwocky:main
dragonwocky:0.3.5
dragonwocky:0.3.4
dragonwocky:0.3.3
dragonwocky:0.3.2
dragonwocky:0.3.1
dragonwocky:0.3.0
dragonwocky:0.2.1
dragonwocky:0.2.0
dragonwocky:0.1.2
dragonwocky:0.1.1

No commits in common. "main" and "0.3.4" have entirely different histories.
main ... 0.3.4

3 changed files with 19 additions and 28 deletions
Show Stats Expand all files Collapse all files

8
README.md
View File

@ -9,7 +9,7 @@ toggle window visibility and create quick notes from anywhere in your operating
### 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 |
@ -17,7 +17,7 @@ toggle window visibility and create quick notes from anywhere in your operating
| 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/tutorial/keyboard-shortcuts#accelerators) | <kbd>CmdOrCtrl+Shift+Tab</kbd> |
| 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").
@ -26,10 +26,10 @@ 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/tutorial/keyboard-shortcuts#accelerators) | <kbd>CmdOrCtrl+Shift+Q</kbd> |
| 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

15
main.js
View File

@ -1,5 +1,5 @@
/**
* obsidian-tray v0.3.5
* obsidian-tray v0.3.4
* (c) 2023 dragonwocky <thedragonring.bod@gmail.com> (https://dragonwocky.me/)
* (https://github.com/dragonwocky/obsidian-tray/) under the MIT license
*/
@ -24,7 +24,7 @@ const LOG_PREFIX = "obsidian-tray",
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/tutorial/keyboard-shortcuts#accelerators" target="_blank" rel="noopener">
<a href="https://www.electronjs.org/docs/latest/api/accelerator" target="_blank" rel="noopener">
Electron accelerator</a>
`,
MOMENT_FORMAT = `
@ -76,10 +76,7 @@ const vaultWindows = new Set(),
showWindows = () => {
log(LOG_SHOWING_WINDOWS);
getWindows().forEach((win) => {
if (maximizedWindows.has(win)) {
win.maximize();
win.focus();
} else win.show();
maximizedWindows.has(win) ? win.maximize() : win.show();
});
},
hideWindows = () => {
@ -478,12 +475,6 @@ class TrayPlugin extends obsidian.Plugin {
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());

2
manifest.json
View File

@ -4,7 +4,7 @@
"author": "dragonwocky",
"authorUrl": "https://dragonwocky.me/",
"description": "Run Obsidian from the system tray for customisable window management & global quick notes",
"version": "0.3.5",
"version": "0.3.4",
"isDesktopOnly": true,
"minAppVersion": "1.0.0"
}