Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PepsRyuu/dock-window-preview
Mac OSX app that displays window previews when hovering over app icon on the Dock.
https://github.com/PepsRyuu/dock-window-preview
macos
Last synced: 14 days ago
JSON representation
Mac OSX app that displays window previews when hovering over app icon on the Dock.
- Host: GitHub
- URL: https://github.com/PepsRyuu/dock-window-preview
- Owner: PepsRyuu
- License: gpl-3.0
- Created: 2021-12-25T18:21:03.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-02-07T18:59:12.000Z (9 months ago)
- Last Synced: 2024-08-01T16:45:45.192Z (3 months ago)
- Topics: macos
- Language: JavaScript
- Homepage:
- Size: 875 KB
- Stars: 73
- Watchers: 6
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dock Window Preview
[](./LICENSE)
[](https://twitter.com/PepsRyuu)
Adds window preview functionality on hover for Mac Dock, an open-source alternative.
*Note: M1 is not supported as I don't have an M1 Mac to test with. Contributors welcome to help resolve this!*
## Motivation
A long-time Windows user here, and I recently had to start using a Macbook, which has been a frustrating experience.
Thankfully, most of my needs as a Windows user are satisfied thanks to AltTab, Rectangle and Karabiner, but I noticed there didn't appear to be any viable option for window previewing on the dock.
The only options seemed to be old paid closed source applications (eg. HyperDock), with no guarantee they were going to work properly at all and didn't seem well supported.
So after a lot of research, I decided to give it a try myself and to give it away for free.
## Getting Started (Quick)
* Run this command in the terminal: ```/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/PepsRyuu/dock-window-preview/master/install.sh)"```
* Run the application, grant the permissions.
* Hover over the dock to see window previews.
## Getting Started
* Ensure you have NodeJS installed.
* If Node is not installed, run ```brew install nvm``` then run ```nvm install 20``` and ```nvm use 20```.
* Clone the repository using ```git clone https://github.com/PepsRyuu/dock-window-preview.git```
* Change into the directory using ```cd dock-window-preview```
* Run ```npm install```, and then ```npm run build```.
* App will be compiled to ```out``` directory.
* Run the app, grant the requested permissions.
## For developers
* For permissions, grant the same permissions to ```Terminal```.
* Use ```npm start``` to run, this will use ```yode``` instead of ```node```.
* For context, I mostly write front-end applications, so I prefer to work with JavaScript where possible.
* My knowledge of Objective-C is incredibly basic, so the code could be better.
* This approach of mostly JavaScript will make it easier for others to contribute.
## Configuration
* Config file is located in ```$HOME/.dock-window-preview/config.json```.
* ```aliases``` allows mapping apps on the dock to their actual name. If a thumbnail isn't showing, see what it's called in the dock, and use Activity Monitor to find it's real name.
* ```theme``` provides customisation to the visual appearance of the preview using hexadecimal colours in the format ```#AARRGGBB```.
* ```layout``` specifies the positioning of the preview.
* ```dock``` can be one of the following: `bottom`, `left`, `right`
* ```preview``` can be one of the following: `fill` (stretch previews to fill container), `fit` (maintain aspect ratio for previews and center).
## Troubleshooting
* If you rebuild the app, force quit the app using the Activity Monitor, and wipe out the permissions entirely, then run the app again.
* There may be an incompatibility between `node-gyp` and `python3`. Ensure that the respective versions are compatible for installation to compile successfully.
## Acknowledgements
* Built on [Yue](https://github.com/yue/yue), bundled using [yackage](https://github.com/yue/yackage).
## Known Limitations
* Only shows windows in the current space / desktop.
* Compatibility will vary from app to app.
## Task List
* Figure out how to show windows from other spaces and how to focus on them.
* Keyboard Controls.
* Once there's a great user experience, investigate how to contribute to brew.
* Support auto-hiding dock and dock in alternate locations.
* Ensure preview does not appear outside of the monitor's area
* If clicking on a dock icon, hide the preview
* Test further different apps for unusual windows like invisible windows.
* Gather window data asynchronously, and don't show outdated previews if the mouse has moved off that dock icon.