https://github.com/lotos-linux/hypr-dock
Interactive dock-panel for Hyprland
https://github.com/lotos-linux/hypr-dock
compositor desktop-environment dock dock-menu dock-panel golang gtk-layer-shell gtk3 gui hackable hyprctl hyprland launcher linux panel productivity ricing tiling-wm wayland
Last synced: 2 months ago
JSON representation
Interactive dock-panel for Hyprland
- Host: GitHub
- URL: https://github.com/lotos-linux/hypr-dock
- Owner: lotos-linux
- License: gpl-3.0
- Created: 2024-05-21T13:20:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-04T16:59:28.000Z (2 months ago)
- Last Synced: 2025-04-04T17:32:38.549Z (2 months ago)
- Topics: compositor, desktop-environment, dock, dock-menu, dock-panel, golang, gtk-layer-shell, gtk3, gui, hackable, hyprctl, hyprland, launcher, linux, panel, productivity, ricing, tiling-wm, wayland
- Language: Go
- Homepage:
- Size: 12.6 MB
- Stars: 6
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hyprland - hypr-dock - panel for Hyprland) (Tools / Status Bar/Shell)
README
# hypr-dock
### Interactive Dock Panel for Hyprland
https://github.com/user-attachments/assets/50d26918-ac74-4b3b-b384-9dd98c62a799
## Installation
### Dependencies
- go (make)
- gtk3
- gtk-layer-shell
### Installation
```bash
git clone https://github.com/lotos-linux/hypr-dock.git
cd hypr-dock
make get
make build
make install
```
## Launching
### Launch Parameters:
```text
-config string
config file (default "~/.config/hypr-dock/config.jsonc")
-theme string
theme (default "lotos")
-help
```
#### All parameters are optional.
The default configuration and themes are installed in `~/.config/hypr-dock`
### Add the following to hyprland.conf for autostart:
```text
exec-once = hypr-dock
bind = Super, D, exec, hypr-dock
```
#### The dock supports only one running instance, so launching it again will close the previous instance.
## Configuration
### The following parameters are available in config.jsonc:
```jsonc
{
"CurrentTheme": "lotos",
// Icon size (px) (default 23)
"IconSize": 23,
// Window overlay layer height (auto, background, bottom, top, overlay) (default "auto")
"Layer": "auto",
// Window position on screen (top, bottom, left, right) (default "bottom")
"Position": "bottom",
// Use system gap (true, false) (default "true")
"SystemGapUsed": "true",
// Indent from the edge of the screen (px) (default 8)
"Margin": 8
}
```
#### If a parameter is not specified, the default value will be used.
## Explanation of Non-Obvious Parameters
### Layer
- With `"Layer": "auto"` the dock layer is below all windows, but if you move the mouse cursor to the edge of the screen, the dock rises above them.
### SystemGapUsed
- With `"SystemGapUsed": "true"` the dock will set its margin from the edge of the screen based on the hyprland configuration, specifically the `general:gaps_out` value. The dock will dynamically adapt to changes in the hyprland configuration.
- With `"SystemGapUsed": "false"` the margin from the edge of the screen will be set by the `Margin` parameter.
### There is also a pinned.json file for pinned applications
#### Example:
```json
{
"Pinned": [
"firefox",
"org.telegram.desktop",
"code-oss",
"kitty"
]
}
```
You can edit it manually. But why? ¯\_(ツ)_/¯
## Themes
#### Themes are located in the `~/.config/hypr-dock/themes/` folder
### A theme consists of:
- `[theme_name].jsonc`, for example `lotos.jsonc`
- `style.css`
- A folder with `svg` files for indicating the number of running applications
### The theme configuration has only two parameters:
```jsonc
{
// Blur window ("on", "off") (default "on")
"Blur": "on",
// Distance between elements (px) (default 8)
"Spacing": 9
}
```
#### Feel free to customize the style.css file as you like.
## Libraries Used
- [github.com/akshaybharambe14/go-jsonc](https://github.com/akshaybharambe14/go-jsonc) v1.0.0
- [github.com/allan-simon/go-singleinstance](https://github.com/allan-simon/go-singleinstance) v0.0.0-20210120080615-d0997106ab37
- [github.com/dlasky/gotk3-layershell](https://github.com/dlasky/gotk3-layershell) v0.0.0-20240515133811-5c5115f0d774
- [github.com/goccy/go-json](https://github.com/goccy/go-json) v0.10.3
- [github.com/gotk3/gotk3](https://github.com/gotk3/gotk3) v0.6.3