Hypr dock
Interactive Dock Panel for Hyprland
! The first build may take a very long time due to gtk3 bindings ! The project is written primarily in Go, distributed under the GNU General Public License v3.0 license, first published in 2024. Key topics include: compositor, desktop-environment, dock, dock-menu, dock-panel.
hypr-dock
Interactive dock panel for Hyprland
Translations: Русский
Installation
Dependencies
go(make)gtk3gtk-layer-shell
Installation
! The first build may take a very long time due to gtk3 bindings !
bashgit clone https://github.com/lotos-linux/hypr-dock.git cd hypr-dock make get make build make install
Uninstallation
bashmake uninstall
Local run (dev mode)
bashmake exec
Running
Launch parameters:
text-config string config file (default "~/.config/hypr-dock") -dev enable developer mode -log-level string log level (default "info") -theme string theme dir
All parameters are optional.
Default configuration and themes are installed in /etc/hypr-dock
On first run, they are copied to ~/.config/hypr-dock
Add to hyprland.conf:
textexec-once = hypr-dock bind = Super, D, exec, hypr-dock
And configure blur if needed
textlayerrule = blur true,match:namespace hypr-dock layerrule = ignore_alpha 0,match:namespace hypr-dock layerrule = blur true,match:namespace dock-popup layerrule = ignore_alpha 0,match:namespace dock-popup
The dock only supports one running instance, so running it again will close the previous one.
Configuration
!Important!
If you already had hypr-dock installed or you are updating, please note that starting from version 1.2.0, an ini-like configuration format is now used. If you have old configs remaining in your user folder, be sure to delete or move them. Then simply adapt your settings to the new format.
Available parameters in hypr-dock.conf
ini[General] CurrentTheme = lotos # Icon size (px) (default 23) IconSize = 23 # Window overlay layer height (background, bottom, top, overlay) (default top) Layer = top # Exclusive Zone (true, false) (default true) Exclusive = true # SmartView (true, false) (default false) SmartView = false # Window position on screen (top, bottom, left, right) (default bottom) Position = bottom # Delay before hiding the dock (ms) (default 400) AutoHideDelay = 400 # Only for SmartView # Use system gap (true, false) (default true) SystemGapUsed = true # Indent from the edge of the screen (px) (default 8) Margin = 8 # Distance of the context menu from the window (px) (default 5) ContextPos = 5 [General.preview] # Window thumbnail mode selection (none, live, static) (default none) Mode = none # "none" - disabled (text menus) # "static" - last window frame # "live" - window streaming # !WARNING! # BY SETTING "Mode" TO "live" OR "static", YOU AGREE TO THE CAPTURE # OF WINDOW CONTENTS. # THE "HYPR-DOCK" PROGRAM DOES NOT COLLECT, STORE, OR TRANSMIT ANY DATA. # WINDOW CAPTURE OCCURS ONLY FOR THE DURATION OF THE THUMBNAIL DISPLAY! # # Source code: https://github.com/lotos-linux/hypr-dock # Live preview fps (0 - ∞) (default 30) FPS = 30 # Live preview bufferSize (1 - 20) (default 5) BufferSize = 5 # Popup show/hide/move delays (ms) ShowDelay = 500 # (default 500) HideDelay = 350 # (default 350) MoveDelay = 100 # (default 100)
If a parameter is not specified, the default value will be used
Understanding non-obvious parameters
SmartView
Similar to auto-hide: if true, the dock stays beneath all windows, but moves the cursor to the screen edge - the dock rises above them
Exclusive
Activates special layer behavior where tiling windows do not overlap the dock
SystemGapUsed
- When
SystemGapUsed = true, the dock sets its margin from the screen edge using values from thehyprlandconfiguration, specificallygeneral:gaps_outvalues, and dynamically updates when thehyprlandconfiguration changes - When
SystemGapUsed = false, the margin from the screen edge is set by theMarginparameter
General.preview
ShowDelay,HideDelay,MoveDelay- preview popup action delays in millisecondsFPS,BufferSize- only used whenMode = live
Preview appearance settings are configured through theme files
Pinned applications are stored in ~/.local/share/hypr-dock/pinned
To pin/unpin, open the application's context menu in the dock and click pin/unpin
Example
textfirefox code-oss kitty org.telegram.desktop nemo org.kde.ark sublime_text qt6ct one.ablaze.floorp
You can edit it manually. But why? ¯_(ツ)_/¯
Themes
Themes are located in ~/.config/hypr-dock/themes/
A theme consists of
theme.confstyle.css- A folder with
svgfiles for indicating the number of running applications (see themes_EN.md)
Theme config
ini[Theme] # Distance between elements (px) (default 9) Spacing = 5 [Theme.preview] # Size (px) (default 120) Size = 120 # Image/Stream border-radius (px) (default 0) BorderRadius = 0 # Popup padding (px) (default 10) Padding = 10
Customize style.css as you wish. Detailed styling documentation will be provided later.
Contributors
Showing top 4 contributors by commit count.
